Section 3: library functions
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); Description Pass 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…
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); Description Pass 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. Default 0 Protocols RTSP Example TODO Availability Added in 7.20.0 Return Value…
CURLOPT_RTSP_REQUEST – specify RTSP request Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_REQUEST, long request); Description Tell 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…
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); Description Pass 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. Default 0…
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); Description Pass 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…
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); Description Pass 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…
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); Description Pass 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…
CURLOPT_REFERER – set the HTTP referer header Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REFERER, char *where); Description Pass 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…
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); Description Pass 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…
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); Description Pass 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…
CURLOPT_READDATA – custom pointer passed to the read callback Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READDATA, void *pointer); Description Data 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…
CURLOPT_RANGE – set byte range to request Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANGE, char *range); Description Pass 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…
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); Description Pass 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. Default NULL, not used Protocols All Example TODO Availability Always…
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); Description Pass 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…
CURLOPT_PUT – make a HTTP PUT request Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PUT, long put); Description A 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)! Default 0, disabled Protocols HTTP…
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); Description Pass 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…
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); Description Pass 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…
CURLOPT_PROXYUSERNAME – user name to use for proxy authentication Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERNAME, char *username); Description Pass a char * as parameter, which should be pointing to the zero terminated user name to use for the transfer. CURLOPT_PROXYUSERNAME(3) sets the user name to be used in protocol authentication with the proxy. To…
CURLOPT_PROXYTYPE – proxy protocol type Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYTYPE, long type); Description Pass a long with this option to set type of the proxy. Available options for this are CURLPROXY_HTTP, CURLPROXY_HTTP_1_0 CURLPROXY_SOCKS4, CURLPROXY_SOCKS5, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5_HOSTNAME. The HTTP type is default. If you set CURLOPT_PROXYTYPE(3) to CURLPROXY_HTTP_1_0, it will only affect how…
CURLOPT_PROXYPORT – port number the proxy listens on Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port); Description Pass a long with this option to set the proxy port to connect to unless it is specified in the proxy string CURLOPT_PROXY(3) or uses the default one. While this accepts a ‘long’, the port number is…