Section 3: library functions
CURLOPT_CONNECTTIMEOUT_MS – timeout for the connect phase Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT_MS, long timeout); DescriptionPass a long. It should contain the maximum time in milliseconds that you allow the connection phase to the server to take. This only limits the connection phase, it has no impact once it has connected. Set to zero to…
CURLOPT_CONNECTTIMEOUT – timeout for the connect phase Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT, long timeout); DescriptionPass a long. It should contain the maximum time in seconds that you allow the connection phase to the server to take. This only limits the connection phase, it has no impact once it has connected. Set to zero to…
CURLOPT_CLOSESOCKETFUNCTION – callback to socket close replacement function Synopsis#include <curl/curl.h> int closesocket_callback(void *clientp, curl_socket_t item); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETFUNCTION, closesocket_callback); DescriptionPass a pointer to your callback function, which should match the prototype shown above. This callback function gets called by libcurl instead of the close(3) or closesocket(3) call when sockets are closed (not for any…
CURLOPT_CLOSESOCKETDATA – pointer passed to the socket close callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA, void *pointer); DescriptionPass a pointer that will be untouched by libcurl and passed as the first argument in the closesocket callback set with CURLOPT_CLOSESOCKETFUNCTION(3). DefaultThe default value of this parameter is NULL. ProtocolsAll except file: ExampleTODO AvailabilityAdded in 7.21.7 Return…
CURLOPT_CHUNK_END_FUNCTION – callback after a transfer with FTP wildcardmatch Synopsis#include <curl/curl.h> long chunk_end_callback(void *ptr); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_END_FUNCTION, chunk_end_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. This function gets called by libcurl as soon as a part of the stream has been transferred (or skipped). Return CURL_CHUNK_END_FUNC_OK if everything…
CURLOPT_CHUNK_DATA – custom pointer to the FTP chunk callbacks Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_DATA, void *pointer); DescriptionPass a pointer that will be untouched by libcurl and passed as the ptr argument to the CURL_CHUNK_BGN_FUNTION(3) and CURL_CHUNK_END_FUNTION(3). DefaultNULL ProtocolsFTP ExampleTODO AvailabilityAdded in 7.21.0 Return ValueReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not….
CURLOPT_CHUNK_BGN_FUNCTION – callback before a transfer with FTP wildcardmatch Synopsis#include <curl/curl.h> long chunk_bgn_callback(const void *transfer_info, void *ptr, int remains); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_BGN_FUNCTION, chunk_bgn_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. This callback function gets called by libcurl before a part of the stream is going to be transferred…
CURLOPT_CERTINFO – request SSL certificate information Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CERTINFO, long certinfo); DescriptionPass a long set to 1 to enable libcurl’s certificate chain info gatherer. With this enabled, libcurl (if built with OpenSSL, NSS or GSKit) will extract lots of information and data about the certificates in the certificate chain used in the…
CURLOPT_CAPATH – specify directory holding CA certificates Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAPATH, char *capath); DescriptionPass a char * to a zero terminated string naming a directory holding multiple CA certificates to verify the peer with. If libcurl is built against OpenSSL, the certificate directory must be prepared using the openssl c_rehash utility. This makes…
CURLOPT_CAINFO – path to Certificate Authority (CA) bundle Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAINFO, char *path); DescriptionPass a char * to a zero terminated string naming a file holding one or more certificates to verify the peer with. If CURLOPT_SSL_VERIFYPEER(3) is zero and you avoid verifying the server’s certificate, CURLOPT_CAINFO(3) need not even indicate an…
CURLOPT_BUFFERSIZE – set preferred receive buffer size Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_BUFFERSIZE, long size); DescriptionPass a long specifying your preferred size (in bytes) for the receive buffer in libcurl. The main point of this would be that the write callback gets called more often and with smaller chunks. This is just treated as a…
CURLOPT_AUTOREFERER – automatically update the referer header Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_AUTOREFERER, long autorefer); DescriptionPass a parameter set to 1 to enable this. When enabled, libcurl will automatically set the Referer: header field in HTTP requests where it follows a Location: redirect. Default0, disabled ProtocolsHTTP ExampleTODO AvailabilityAlong with HTTP Return ValueReturns CURLE_OK if HTTP…
CURLOPT_APPEND – enable appending to the remote file Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_APPEND, long append); DescriptionA parameter set to 1 tells the library to append to the remote file instead of overwrite it. This is only useful when uploading to an FTP site. Default0 ProtocolsFTP ExampleTODO AvailabilityThis option was known as CURLOPT_FTPAPPEND up to…
CURLOPT_ADDRESS_SCOPE – set scope for local IPv6 addresses Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ADDRESS_SCOPE, long scope); DescriptionPass a long specifying the scope_id value to use when connecting to IPv6 link-local or site-local addresses. Default0 ProtocolsAll, when using IPv6 ExampleTODO AvailabilityAdded in 7.19.0 Return ValueReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. See…
CURLOPT_ACCEPT_ENCODING – enables automatic decompression of HTTP downloads Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPT_ENCODING, char *enc); DescriptionPass a char * argument specifying what encoding you’d like. Sets the contents of the Accept-Encoding: header sent in a HTTP request, and enables decoding of a response when a Content-Encoding: header is received. Three encodings are supported: identity,…
CURLOPT_ACCEPTTIMEOUT_MS – timeout waiting for FTP server to connect back Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPTTIMEOUT_MS, long ms); DescriptionPass a long telling libcurl the maximum number of milliseconds to wait for a server to connect back to libcurl when an active FTP connection is used. DefaultIf no timeout is set, the internal default of 60000…
CURLMOPT_TIMERFUNCTION – set callback to receive timeout values Synopsis#include <curl/curl.h> int timer_callback(CURLM *multi, /* multi handle */ long timeout_ms, /* see above */ void *userp); /* private callback pointer */ CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_TIMERFUNCTION, timer_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. This callback function will be called when…
CURLMOPT_TIMERDATA – custom pointer to pass to timer callback Synopsis#include <curl/curl.h> CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_TIMERDATA, void *pointer);DescriptionA data pointer to pass to the timer callback set with the CURLMOPT_TIMERFUNCTION(3) option. This pointer will not be touched by libcurl but will only be passed in to the timer callbacks’s userp argument. DefaultNULL ProtocolsAll ExampleTODO AvailabilityAdded in…
CURLMOPT_SOCKETFUNCTION – callback informed about what to wait for Synopsis#include <curl/curl.h> int socket_callback(CURL *easy, /* easy handle */ curl_socket_t s, /* socket */ int what, /* see above */ void *userp, /* private callback pointer */ void *socketp); /* private socket pointer */ CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_SOCKETFUNCTION, socket_callback);DescriptionPass a pointer to your callback function, which…
CURLMOPT_SOCKETDATA – custom pointer passed to the socket callback Synopsis#include <curl/curl.h> CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_SOCKETDATA, void *pointer);DescriptionA data pointer to pass to the socket callback set with the CURLMOPT_SOCKETFUNCTION(3) option. This pointer will not be touched by libcurl but will only be passed in to the socket callbacks’s userp argument. DefaultNULL ProtocolsAll ExampleTODO AvailabilityAdded in…