summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmil Engler <me@emilengler.com>2021-05-18 18:35:23 +0200
committerDaniel Stenberg <daniel@haxx.se>2021-05-19 00:39:06 +0200
commitd79f8492c5f2a6e7b6a2362813af16437b3fcc43 (patch)
tree8990244809657dbf81c125092ce7173b849ac417
parent158d26e4fc2ad0eb4d2115f647fbc7090429e708 (diff)
downloadcurl-d79f8492c5f2a6e7b6a2362813af16437b3fcc43.tar.gz
docs: improve INTERNALS.md regarding getsock cb
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
-rw-r--r--docs/INTERNALS.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/INTERNALS.md b/docs/INTERNALS.md
index 02ac0d0a7..a1a8e11c9 100644
--- a/docs/INTERNALS.md
+++ b/docs/INTERNALS.md
@@ -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.