Section 3: library functions
CURLOPT_SASL_IR – enable sending initial response in first packet Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_IR, long enable); DescriptionPass a long. If the value is 1, curl will send the initial response to the server in the first authentication packet in order to reduce the number of ping pong requests. Only applicable to the following supporting…
CURLOPT_RTSP_TRANSPORT – set RTSP Transport: header Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_TRANSPORT, char *transport);DescriptionPass a char * to tell libcurl what to pass for the Transport: header for this RTSP session. This is mainly a convenience method to avoid needing to set a custom Transport: header for every SETUP request. The application must set a…
CURLOPT_RTSP_STREAM_URI – set RTSP stream URI Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_STREAM_URI, char *URI); DescriptionSet the stream URI to operate on by passing a char * . For example, a single session may be controlling rtsp://foo/twister/audio and rtsp://foo/twister/video and the application can switch to the appropriate stream using this option. If unset, libcurl will default…
CURLOPT_RTSP_SESSION_ID – set RTSP session ID Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_SESSION_ID, char *id); DescriptionPass a char * as a parameter to set the value of the current RTSP Session ID for the handle. Useful for resuming an in-progress session. Once this value is set to any non-NULL value, libcurl will return CURLE_RTSP_SESSION_ERROR if ID…
CURLOPT_RTSP_SERVER_CSEQ – set the RTSP server CSEQ number Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_SERVER_CSEQ, long cseq); DescriptionPass a long to set the CSEQ number to expect for the next RTSP Server->Client request. NOTE: this feature (listening for Server requests) is unimplemented. Default0 ProtocolsRTSP ExampleTODO AvailabilityAdded in 7.20.0 Return ValueReturns CURLE_OK if the option is supported,…
CURLOPT_RTSP_REQUEST – specify RTSP request Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_REQUEST, long request); DescriptionTell libcurl what kind of RTSP request to make. Pass one of the following RTSP enum values as a long in the request argument. Unless noted otherwise, commands require the Session ID to be initialized. CURL_RTSPREQ_OPTIONS Used to retrieve the available methods…
CURLOPT_RTSP_CLIENT_CSEQ – set the RTSP client CSEQ number Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_CLIENT_CSEQ, long cseq); DescriptionPass a long to set the the CSEQ number to issue for the next RTSP request. Useful if the application is resuming a previously broken connection. The CSEQ will increment from this new number henceforth. Default0 ProtocolsRTSP ExampleTODO AvailabilityAdded…
CURLOPT_RESUME_FROM_LARGE – set a point to resume transfer from Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM_LARGE, curl_off_t from);DescriptionPass a curl_off_t as parameter. It contains the offset in number of bytes that you want the transfer to start from. Set this option to 0 to make the transfer start from the beginning (effectively disabling resume). For FTP,…
CURLOPT_RESUME_FROM – set a point to resume transfer from Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM, long from); DescriptionPass a long as parameter. It contains the offset in number of bytes that you want the transfer to start from. Set this option to 0 to make the transfer start from the beginning (effectively disabling resume). For…
CURLOPT_RESOLVE – provide custom host name to IP address resolves Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESOLVE, struct curl_slist *hosts);DescriptionPass a pointer to a linked list of strings with host name resolve information to use for requests with this handle. The linked list should be a fully valid list of struct curl_slist structs properly filled in….
CURLOPT_REFERER – set the HTTP referer header Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REFERER, char *where); DescriptionPass a pointer to a zero terminated string as parameter. It will be used to set the Referer: header in the http request sent to the remote server. This can be used to fool servers or scripts. You can also…
CURLOPT_REDIR_PROTOCOLS – set protocols allowed to redirect to Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REDIR_PROTOCOLS, long bitmask); DescriptionPass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask limits what protocols libcurl may use in a transfer that it follows to in a redirect when CURLOPT_FOLLOWLOCATION(3) is enabled. This allows you to limit…
CURLOPT_READFUNCTION – read callback for data uploads Synopsis#include <curl/curl.h> size_t read_callback(char *buffer, size_t size, size_t nitems, void *instream); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READFUNCTION, read_callback); DescriptionPass a pointer to your callback function, as the prototype shows above. This callback function gets called by libcurl as soon as it needs to read data in order to send it…
CURLOPT_READDATA – custom pointer passed to the read callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READDATA, void *pointer); DescriptionData pointer to pass to the file read function. If you use the CURLOPT_READFUNCTION(3) option, this is the pointer you’ll get as input in the 4th argument to the callback. If you don’t specify a read callback but…
CURLOPT_RANGE – set byte range to request Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANGE, char *range); DescriptionPass a char * as parameter, which should contain the specified range you want to retrieve. It should be in the format "X-Y", where either X or Y may be left out and X and Y are byte indexes. HTTP…
CURLOPT_RANDOM_FILE – specify a source for random data Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANDOM_FILE, char *path); DescriptionPass a char * to a zero terminated file name. The file will be used to read from to seed the random engine for SSL and more. DefaultNULL, not used ProtocolsAll ExampleTODO AvailabilityAlways Return ValueReturns CURLE_OK on success or…
CURLOPT_QUOTE – (S)FTP commands to run before transfer Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_QUOTE, struct curl_slist *cmds); DescriptionPass a pointer to a linked list of FTP or SFTP commands to pass to the server prior to your request. This will be done before any other commands are issued (even before the CWD command for FTP)….
CURLOPT_PUT – make a HTTP PUT request Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PUT, long put); DescriptionA parameter set to 1 tells the library to use HTTP PUT to transfer data. The data should be set with CURLOPT_READDATA(3) and CURLOPT_INFILESIZE(3). This option is deprecated since version 7.12.1. Use CURLOPT_UPLOAD(3)! Default0, disabled ProtocolsHTTP ExampleTODO AvailabilityDeprecated since 7.12.1….
CURLOPT_PROXY_TRANSFER_MODE – append FTP transfer mode to URL for proxy Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TRANSFER_MODE, long enabled); DescriptionPass a long. If the value is set to 1 (one), it tells libcurl to set the transfer mode (binary or ASCII) for FTP transfers done via a HTTP proxy, by appending ;type=a or ;type=i to the…
CURLOPT_PROXYUSERPWD – user name and password to use for proxy authentication Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERPWD, char *userpwd); DescriptionPass a char * as parameter, which should be [user name]:[password] to use for the connection to the HTTP proxy. Both the name and the password will be URL decoded before use, so to include for…