]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: improve INTERNALS.md regarding getsock cb
authorEmil Engler <me@emilengler.com>
Tue, 18 May 2021 16:35:23 +0000 (18:35 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Tue, 18 May 2021 22:39:06 +0000 (00:39 +0200)
This adds the I/O prefix to indicate that those "actions" are kind-of
related to those found in select(2) or poll(2) (reading/writing).

It also adds a note where the prototypes of those functions can be found
in the source code.

Closes #7092

docs/INTERNALS.md

index 02ac0d0a74d5209c2392a8576786220966f1bc32..a1a8e11c9317c230602e0089b2c933ebc7ed32f7 100644 (file)
@@ -976,6 +976,8 @@ for older and later versions as things don't change drastically that often.
   from a single array which is scanned through when a URL is given to libcurl
   to work with.
 
+  The concrete function pointer prototypes can be found in `lib/urldata.h`.
+
   `->scheme` is the URL scheme name, usually spelled out in uppercase. That's
   "HTTP" or "FTP" etc. SSL versions of the protocol need their own
   `Curl_handler` setup so HTTPS separate from HTTP.
@@ -1017,7 +1019,7 @@ for older and later versions as things don't change drastically that often.
   `->domore_getsock`
   `->perform_getsock`
   Functions that return socket information. Which socket(s) to wait for which
-  action(s) during the particular multi state.
+  I/O action(s) during the particular multi state.
 
   `->disconnect` is called immediately before the TCP connection is shutdown.