gnurl_easy_recv(3)

πŸ“¦ version 7.72.0, in nixos 26.05, nixpkgs unstable

okay bestie, welcome to gnurl_easy_recv(3) β€” this is the libgnurl Manual page, and we're about to make raw easy-connection data make sense πŸ’…βœ¨

🌸 NAME 🌸

curl_easy_recv β€” receives raw data on an "easy" connection. no cap, that's the whole gig πŸ’–

✨ SYNOPSIS ✨

here's the signature, bestie β€” copy it exactly:

#include <gnurl/easy.h>

CURLcode curl_easy_recv( CURL *curl, void *buffer, size_t buflen, size_t
       *n);

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so this function receives raw data from the established connection 🫢. You may use it together with curl_easy_send(3) to implement custom protocols using libcurl. This functionality can be particularly useful if you use proxies and/or SSL encryption: libcurl will take care of proxy negotiation and connection set-up. iconic behavior, honestly.

  • buffer β€” pointer to your buffer that will get the received data πŸŽ€
  • buflen β€” the maximum amount of data you can get in that buffer. that's the cap, periodt.
  • n β€” the variable n points to will receive the number of received bytes.

To establish the connection, set the CURLOPT_CONNECT_ONLY(3) option before calling curl_easy_perform(3) or curl_multi_perform(3). Not me warning you: curl_easy_recv(3) does not work on connections that were created without this option. lowkey important.

The call will return CURLE_AGAIN if there is no data to read β€” the socket is used in non-blocking mode internally. When CURLE_AGAIN comes back, use your operating system facilities like select(2) to wait for data. The socket may be obtained using curl_easy_getinfo(3) with CURLINFO_ACTIVESOCKET(3) πŸ‘‘

🚨 Wait on the socket only if curl_easy_recv(3) returns CURLE_AGAIN. The reason for this is libcurl or the SSL library may internally cache some data, therefore you should call curl_easy_recv(3) until all data is read which would include any cached data. iykyk.

Furthermore, if you wait on the socket and it tells you there is data to read, curl_easy_recv(3) may return CURLE_AGAIN if the only data that was read was for internal SSL processing, and no other data is available. tricky little vibe, but that's what's up.

🌈 AVAILABILITY 🌈

Added in 7.18.2. so yes, she's been around for a minute ✨

πŸ‘‘ RETURN VALUE πŸ‘‘

  • On success, returns CURLE_OK, stores the received data into buffer, and stores the number of bytes it actually read into *n. slay πŸ’–
  • On failure, returns the appropriate error code. no guessing.
  • The function may return CURLE_AGAIN. In this case, use your operating system facilities to wait until data can be read, and retry πŸ”.
  • Reading exactly 0 bytes indicates a closed connection. bye bestie πŸ‘‹
  • If there's no socket available to use from the previous transfer, this function returns CURLE_UNSUPPORTED_PROTOCOL.

πŸ“ EXAMPLE πŸ“

For a usage example, see sendrecv.c in the docs/examples directory πŸ‘€.

πŸ’œ SEE ALSO πŸ’œ


okay that's the page, bestie πŸ’‹ β€” it's from libcurl 7.18.2, dated 29 April 2008, and the page itself is gnurl_easy_recv(3). mwah 🫢

πŸ“¦ where this page comes from