vtls_int.h: clarify data_pending

Suggested-by: Joseph Birr-Pixton
Closes #18644

diff --git a/lib/vtls/vtls_int.h b/lib/vtls/vtls_int.h
index de0b735e22bf86022dabeee0ef677e9924b7a390..8bf6c6c64be9953a341c656e4404da2e603bdb98 100644 (file)
--- a/lib/vtls/vtls_int.h
+++ b/lib/vtls/vtls_int.h
@@ -153,6 +153,10 @@ struct Curl_ssl {
   size_t (*version)(char *buffer, size_t size);
   CURLcode (*shut_down)(struct Curl_cfilter *cf, struct Curl_easy *data,
                         bool send_shutdown, bool *done);
+
+  /* data_pending() shall return TRUE when it wants to get called again to
+     drain internal buffers and deliver data instead of waiting for the socket
+     to get readable */
   bool (*data_pending)(struct Curl_cfilter *cf,
                        const struct Curl_easy *data);