Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

curl_easy_recv(3) [centos man page]

curl_easy_recv(3)						  libcurl Manual						 curl_easy_recv(3)

NAME

       curl_easy_recv - receives raw data on an "easy" connection

SYNOPSIS

       #include <curl/easy.h>

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

DESCRIPTION

       This  function receives raw data from the established connection. You may use it together with curl_easy_send(3) to implement custom proto-
       cols 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.

       buffer  is  a  pointer to your buffer that will get the received data. buflen is the maximum amount of data you can get in that buffer. The
       variable n points to will receive the number of received bytes.

       To establish the connection, set CURLOPT_CONNECT_ONLY option before calling curl_easy_perform(3). Note that curl_easy_recv(3) does not work
       on connections that were created without this option.

       You  must ensure that the socket has data to read before calling curl_easy_recv(3), otherwise the call will return CURLE_AGAIN - the socket
       is used in non-blocking mode internally. Use curl_easy_getinfo(3) with CURLINFO_LASTSOCKET to obtain the socket; use your operating  system
       facilities like select(2) to check if it has any data you can read.

AVAILABILITY

       Added in 7.18.2.

RETURN VALUE

       On success, returns CURLE_OK, stores the received data into buffer, and the number of bytes it actually read into *n.

       On failure, returns the appropriate error code.

       If  there  is  no data to read, the function returns CURLE_AGAIN. Use your operating system facilities to wait until the data is ready, and
       retry.

       Reading exactly 0 bytes would indicate a closed connection.

       If there's no socket available to use from the previous transfer, this function returns CURLE_UNSUPPORTED_PROTOCOL.

EXAMPLE

       See sendrecv.c in docs/examples directory for usage example.

SEE ALSO

       curl_easy_setopt(3), curl_easy_perform(3), curl_easy_getinfo(3), curl_easy_send(3)

libcurl 7.18.2							   29 April 2008						 curl_easy_recv(3)

Check Out this Related Man Page

curl_easy_perform(3)						  libcurl Manual					      curl_easy_perform(3)

NAME

       curl_easy_perform - perform a blocking file transfer

SYNOPSIS

       #include <curl/curl.h>

       CURLcode curl_easy_perform(CURL *easy_handle);

DESCRIPTION

       Invoke  this function after curl_easy_init(3) and all the curl_easy_setopt(3) calls are made, and will perform the transfer as described in
       the options. It must be called with the same easy_handle as input as the curl_easy_init(3) call returned.

       curl_easy_perform(3) performs the entire request in a blocking manner and returns when done, or if it failed.  For  non-blocking  behavior,
       see curl_multi_perform(3).

       You  can do any amount of calls to curl_easy_perform(3) while using the same easy_handle. If you intend to transfer more than one file, you
       are even encouraged to do so. libcurl will then attempt to re-use the same connection for the following transfers, thus making  the  opera-
       tions  faster,  less  CPU  intense  and	using  less network resources. Just note that you will have to use curl_easy_setopt(3) between the
       invokes to set options for the following curl_easy_perform.

       You must never call this function simultaneously from two places using the same easy_handle. Let the function return first before  invoking
       it another time. If you want parallel transfers, you must use several curl easy_handles.

       While the easy_handle is added to a multi handle, it cannot be used by curl_easy_perform(3).

RETURN VALUE

       CURLE_OK  (0)  means  everything  was  ok,  non-zero  means an error occurred as <curl/curl.h> defines - see libcurl-errors(3). If the CUR-
       LOPT_ERRORBUFFER(3) was set with curl_easy_setopt(3) there will be a readable error message in the error buffer when non-zero is returned.

EXAMPLE

       CURL *curl = curl_easy_init();
       if(curl) {
	 CURLcode res;
	 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
	 res = curl_easy_perform(curl);
	 curl_easy_cleanup(curl);
       }

SEE ALSO

       curl_easy_init(3), curl_easy_setopt(3), curl_multi_add_handle(3), curl_multi_perform(3), libcurl-errors(3),

libcurl 7.54.0							   May 02, 2016 					      curl_easy_perform(3)
Man Page