This is an interface to the libcurl library.
Converted to D from curl headers by htod and
cleaned up by Jonas Drewsen (jdrewsen)
Copyright (C) 1998 - 2010, Daniel Stenberg, <daniel@haxx.se>, et al.
This software is licensed as described in the file COPYING, which
you should have received as part of this distribution. The terms
are also available at http://curl.haxx.se/docs/copyright.html.
You may opt to use, copy, modify, merge, publish, distribute and/or sell
copies of the Software, and permit persons to whom the Software is
furnished to do so, under the terms of the COPYING file.
This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
KIND, either express or implied.
string LIBCURL_COPYRIGHT;
This is the global package copyright
string LIBCURL_VERSION;
This is the version number of the libcurl package from which this header file origins:
int LIBCURL_VERSION_MAJOR;
int LIBCURL_VERSION_MINOR;
int LIBCURL_VERSION_PATCH;
The numeric version number is also available "in parts" by using these constants
int LIBCURL_VERSION_NUM;
This is the numeric version of the libcurl version number, meant for easier parsing and comparions by programs. The LIBCURL_VERSION_NUM define will always follow this syntax:
0xXXYYZZ
Where XX, YY and ZZ are the main version, release and patch numbers in
hexadecimal (using 8 bits each). All three numbers are always represented
using two digits. 1.2 would appear as "0x010200" while version 9.11.7
appears as "0x090b07".
This 6-digit (24 bits) hexadecimal number does not show pre-release number,
and it is always a greater number in a more recent release. It makes
comparisons with greater than and less than work.
string LIBCURL_TIMESTAMP;
This is the date and time when the full source package was created. The timestamp is not stored in git, as the timestamp is properly set in the tarballs by the maketgz script.
The format of the date should follow this template:
"Mon Feb 12 11:35:33 UTC 2007"
alias curl_off_t = long;
Data type definition of curl_off_t. jdrewsen - Always 64bit signed and that is what long is in D. Comment below is from curlbuild.h:
NOTE 2:
For any given platform/compiler curl_off_t must be typedef'ed to a
64-bit wide signed integral data type. The width of this data type
must remain constant and independent of any possible large file
support settings.
As an exception to the above, curl_off_t shall be typedef'ed to a
32-bit wide signed integral data type if there is no 64-bit type.
alias CURL = void;
alias curl_socket_t = std.socket.socket_t;
jdrewsen - Get socket alias from std.socket
const const(int) CURL_SOCKET_BAD;
jdrewsen - Would like to get socket error constant from std.socket by it is private atm.
struct curl_httppost;
curl_httppost* next;
next entry in the list
char* name;
pointer to allocated name
c_long namelength;
length of name length
char* contents;
pointer to allocated data contents
c_long contentslength;
length of contents field
char* buffer;
pointer to allocated buffer contents
c_long bufferlength;
length of buffer field
char* contenttype;
Content-Type
curl_slist* contentheader;
list of extra headers for this form
curl_httppost* more;
if one field name has more than one file, this link should link to following files
c_long flags;
as defined below
char* showfilename;
The file name to show. If not set, the actual file name will be used (if this is a file part)
void* userp;
custom pointer used for HTTPPOST_CALLBACK posts
int HTTPPOST_FILENAME;
specified content is a file name
int HTTPPOST_READFILE;
specified content is a file name
int HTTPPOST_PTRNAME;
name is only stored pointer do not free in formfree
int HTTPPOST_PTRCONTENTS;
contents is only stored pointer do not free in formfree
int HTTPPOST_BUFFER;
upload file from buffer
int HTTPPOST_PTRBUFFER;
upload file from pointer contents
int HTTPPOST_CALLBACK;
upload file contents by using the regular read callback to get the data and pass the given pointer as custom pointer
alias curl_progress_callback = int function(void* clientp, double dltotal, double dlnow, double ultotal, double ulnow);
int CURL_MAX_WRITE_SIZE;
Tests have proven that 20K is a very bad buffer size for uploads on Windows, while 16K for some odd reason performed a lot better. We do the ifndef check to allow this value to easier be changed at build time for those who feel adventurous. The practical minimum is about 400 bytes since libcurl uses a buffer of this size as a scratch area (unrelated to network send operations).
int CURL_MAX_HTTP_HEADER;
The only reason to have a max limit for this is to avoid the risk of a bad server feeding libcurl with a never-ending header that will cause reallocs infinitely
int CURL_WRITEFUNC_PAUSE;
This is a magic return code for the write callback that, when returned, will signal libcurl to pause receiving on the current transfer.
alias curl_write_callback = uint function(char* buffer, uint size, uint nitems, void* outstream);
enum CurlFileType: int;
enumeration of file types
is possible only on Sun Solaris now
alias curlfiletype = int;
enum CurlFInfoFlagKnown: int;
struct _N2;
Content of this structure depends on information which is known and is achievable (e.g. by FTP LIST parsing). Please see the url_easy_setopt(3) man page for callbacks returning this structure -- some fields are mandatory, some others are optional. The FLAG field has special meaning. If some of these fields is not NULL, it is a pointer to b_data.
struct curl_fileinfo;
Content of this structure depends on information which is known and is achievable (e.g. by FTP LIST parsing). Please see the url_easy_setopt(3) man page for callbacks returning this structure -- some fields are mandatory, some others are optional. The FLAG field has special meaning.
enum CurlChunkBgnFunc: int;
return codes for CURLOPT_CHUNK_BGN_FUNCTION
alias curl_chunk_bgn_callback = int function(void* transfer_info, void* ptr, int remains);
if splitting of data transfer is enabled, this callback is called before download of an individual chunk started. Note that parameter "remains" works only for FTP wildcard downloading (for now), otherwise is not used
enum CurlChunkEndFunc: int;
alias curl_chunk_end_callback = int function(void* ptr);
If splitting of data transfer is enabled this callback is called after download of an individual chunk finished. Note! After this callback was set then it have to be called FOR ALL chunks. Even if downloading of this chunk was skipped in CHUNK_BGN_FUNC. This is the reason why we don't need "transfer_info" parameter in this callback and we are not interested in "remains" parameter too.
enum CurlFnMAtchFunc: int;
alias curl_fnmatch_callback = int function(void* ptr, char* pattern, char* string);
callback type for wildcard downloading pattern matching. If the string matches the pattern, return CURL_FNMATCHFUNC_MATCH value, etc.
enum CurlSeekPos: int;
enum CurlSeek: int;
These are the return codes for the seek callbacks
alias curl_seek_callback = int function(void* instream, long offset, int origin);
enum CurlReadFunc: int;
alias curl_read_callback = uint function(char* buffer, uint size, uint nitems, void* instream);
enum CurlSockType: int;
alias curlsocktype = int;
alias curl_sockopt_callback = int function(void* clientp, socket_t curlfd, int purpose);
struct curl_sockaddr;
addrlen was a socklen_t type before 7.18.0 but it turned really ugly and painful on the systems that lack this type
alias curl_opensocket_callback = socket_t function(void* clientp, int purpose, curl_sockaddr* address);
enum CurlIoError: int;
I/O operation successful
command was unknown to callback
failed to restart the read
never use
alias curlioerr = int;
enum CurlIoCmd: int;
alias curliocmd = int;
alias curl_ioctl_callback = int function(void* handle, int cmd, void* clientp);
alias curl_malloc_callback = void* function(uint size);
alias curl_free_callback = void function(void* ptr);
alias curl_realloc_callback = void* function(void* ptr, uint size);
alias curl_strdup_callback = char* function(char* str);
alias curl_calloc_callback = void* function(uint nmemb, uint size);
The following typedef's are signatures of malloc, free, realloc, strdup and calloc respectively. Function pointers of these types can be passed to the curl_global_init_mem() function to set user defined memory management callback routines.
enum CurlCallbackInfo: int;
the kind of data that is passed to information_callback
alias curl_infotype = int;
alias curl_debug_callback = int function(void* handle, int type, char* data, uint size, void* userptr);
enum CurlError: int;
All possible error codes from all sorts of curl functions. Future versions may return other values, stay prepared.
Always add new return codes last. Never *EVER* remove any. The return codes must remain the same!
1
2
3
4 - NOT USED
5
6
7
8
9 a service was denied by the server due to lack of access - when login fails this is not returned.
10 - NOT USED
11
12 - NOT USED
13
14
15
16 - NOT USED
17
18
19
20 - NOT USED
21 - quote command failure
22
23
24 - NOT USED
25 - failed upload "command"
26 - couldn't open/read from file
27
- Note:
- CURLE_OUT_OF_MEMORY may sometimes indicate a conversion error instead of a memory allocation error if CURL_DOES_CONVERSIONS is defined 28 - the timeout time was reached
29 - NOT USED
30 - FTP PORT operation failed
31 - the REST command failed
32 - NOT USED
33 - RANGE "command" didn't work
34
35 - wrong when connecting with SSL
36 - couldn't resume download
37
38
39
40 - NOT USED
41
42
43
44 - NOT USED
45 - CURLOPT_INTERFACE failed
46 - NOT USED
47 - catch endless re-direct loops
48 - User specified an unknown option
49 - Malformed telnet option
50 - NOT USED
51 - peer's certificate or fingerprint wasn't verified fine
52 - when this is a specific error
53 - SSL crypto engine not found
54 - can not set SSL crypto engine as default
55 - failed sending network data
56 - failure in receiving network data
57 - NOT IN USE
58 - problem with the local certificate
59 - couldn't use specified cipher
60 - problem with the CA cert (path?)
61 - Unrecognized transfer encoding
62 - Invalid LDAP URL
63 - Maximum file size exceeded
64 - Requested FTP SSL level failed
65 - Sending the data requires a rewind that failed
66 - failed to initialise ENGINE
67 - user, password or similar was not accepted and we failed to login
68 - file not found on server
69 - permission problem on server
70 - out of disk space on server
71 - Illegal TFTP operation
72 - Unknown transfer ID
73 - File already exists
74 - No such user
75 - conversion failed
76 - caller must register conversion callbacks using curl_easy_setopt options CURLOPT_CONV_FROM_NETWORK_FUNCTION, CURLOPT_CONV_TO_NETWORK_FUNCTION, and CURLOPT_CONV_FROM_UTF8_FUNCTION
77 - could not load CACERT file, missing or wrong format
78 - remote file not found
79 - error from the SSH layer, somewhat generic so the error message will be of interest when this has happened
80 - Failed to shut down the SSL connection
81 - socket is not ready for send/recv, wait till it's ready and try again (Added in 7.18.2)
82 - could not load CRL file, missing or wrong format (Added in 7.19.0)
83 - Issuer check failed. (Added in 7.19.0)
84 - a PRET command failed
85 - mismatch of RTSP CSeq numbers
86 - mismatch of RTSP Session Identifiers
87 - unable to parse FTP file list
88 - chunk callback reported error
never use!
alias CURLcode = int;
alias curl_conv_callback = int function(char* buffer, uint length);
This prototype applies to all conversion callbacks
alias curl_ssl_ctx_callback = int function(void* curl, void* ssl_ctx, void* userptr);
actually an OpenSSL SSL_CTX
enum CurlProxy: int;
added in 7.10, new in 7.19.4 default is to use CONNECT HTTP/1.1
added in 7.19.4, force to use CONNECT HTTP/1.0
support added in 7.15.2, enum existed already in 7.10
added in 7.10
added in 7.18.0
Use the SOCKS5 protocol but pass along the host name rather than the IP address. added in 7.18.0
alias curl_proxytype = int;
enum CurlAuth: long;
enum CurlSshAuth: int;
int CURL_ERROR_SIZE;
enum CurlKHType: int;
points to a zero-terminated string encoded with base64 if len is zero, otherwise to the "raw" data
struct curl_khkey;
enum CurlKHStat: int;
this is the set of return values expected from the curl_sshkeycallback callback
enum CurlKHMatch: int;
this is the set of status codes pass in to the callback
alias curl_sshkeycallback = int function(void* easy, curl_khkey* knownkey, curl_khkey* foundkey, CurlKHMatch m, void* clientp);
enum CurlUseSSL: int;
parameter for the CURLOPT_USE_SSL option
alias curl_usessl = int;
enum CurlFtpSSL: int;
parameter for the CURLOPT_FTP_SSL_CCC option
do not send CCC
Let the server initiate the shutdown
Initiate the shutdown
not an option, never use
alias curl_ftpccc = int;
enum CurlFtpAuth: int;
parameter for the CURLOPT_FTPSSLAUTH option
alias curl_ftpauth = int;
enum CurlFtp: int;
parameter for the CURLOPT_FTP_CREATE_MISSING_DIRS option
do NOT create missing dirs!
(FTP/SFTP) if CWD fails, try MKD and then CWD again if MKD succeeded, for SFTP this does similar magic
(FTP only) if CWD fails, try MKD and then CWD again even if MKD failed!
not an option, never use
alias curl_ftpcreatedir = int;
enum CurlFtpMethod: int;
parameter for the CURLOPT_FTP_FILEMETHOD option
let libcurl pick
single CWD operation for each path part
no CWD at all
one CWD to full dir, then work on file
not an option, never use
alias curl_ftpmethod = int;
enum CurlProto: int;
CURLPROTO_ defines are for the CURLOPT_*PROTOCOLS options
int CURLOPTTYPE_LONG;
int CURLOPTTYPE_OBJECTPOINT;
int CURLOPTTYPE_FUNCTIONPOINT;
int CURLOPTTYPE_OFF_T;
long may be 32 or 64 bits, but we should never depend on anything else but 32
alias LONG = CURLOPTTYPE_LONG;
alias OBJECTPOINT = CURLOPTTYPE_OBJECTPOINT;
alias FUNCTIONPOINT = CURLOPTTYPE_FUNCTIONPOINT;
alias OFF_T = CURLOPTTYPE_OFF_T;
name is uppercase CURLOPT_
enum CurlOption: int;
This is the FILE * or void * the regular output should be written to.
The full URL to get/put
Port number to connect to, if other than default.
Name of proxy to use.
"name:password" to use when fetching.
"name:password" to use with proxy.
Range to get, specified as an ASCII string.
not used Specified file stream to upload from (use as input):
Buffer to receive error messages in, must be at least CURL_ERROR_SIZE bytes big. If this is not used, error messages go to stderr instead:
Function that will be called to store the output (instead of fwrite). The parameters will use fwrite() syntax, make sure to follow them.
Function that will be called to read the input (instead of fread). The parameters will use fread() syntax, make sure to follow them.
Time-out the read operation after this amount of seconds
If the CURLOPT_INFILE is used, this can be used to inform libcurl about how large the file being sent really is. That allows better error checking and better verifies that the upload was successful. -1 means unknown size.
For large file support, there is also a LARGE version of the key which takes an off_t type, allowing platforms with larger off_t sizes to handle larger files. See below for INFILESIZE_LARGE.
POST static input fields.
Set the referrer page (needed by some CGIs)
Set the FTP PORT string (interface name, named or numerical IP address) Use i.e '-' to use default address.
Set the User-Agent string (examined by some CGIs)
If the download receives less than "low speed limit" bytes/second during "low speed time" seconds, the operations is aborted. You could i.e if you have a pretty high speed connection, abort if it is less than 2000 bytes/sec during 20 seconds. Set the "low speed limit"
Set the "low speed time"
Set the continuation offset.
Note there is also a LARGE version of this key which uses off_t types, allowing for large file offsets on platforms which use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE.
Set cookie in request:
This points to a linked list of headers, struct curl_slist kind
This points to a linked list of post entries, struct curl_httppost
name of the file keeping your private SSL-certificate
password for the SSL or SSH private key
send TYPE parameter?
send linked-list of QUOTE commands
send FILE * or void * to store headers to, if you use a callback it is simply passed to the callback unmodified
point to a file to read the initial cookies from, also enables "cookie awareness"
What version to specifically try to use. See CURL_SSLVERSION defines below.
What kind of HTTP time condition to use, see defines
Time to use with the above condition. Specified in number of seconds since 1 Jan 1970
- HTTP:
- DELETE, TRACE and others
- FTP:
- to use a different list command
35 = OBSOLETE Custom request, for customizing the get command like
HTTP request, for odd commands like DELETE, TRACE and others
38 is not used send linked-list of post-transfer QUOTE commands
Pass a pointer to string of the output using full variable-replacement as described elsewhere.
talk a lot
throw the header out too
shut off the progress meter
use HEAD to get http document
no output on http error codes >= 300
this is an upload
HTTP POST method
return bare names when listing directories
Append instead of overwrite on upload!
Specify whether to read the user+password from the . netrc or the URL. This must be one of the CURL_NETRC_* enums below.
use Location: Luke!
transfer data in text/ASCII format
HTTP PUT
55 = OBSOLETE Function that will be called instead of the internal progress display function. This function should be defined as the curl_progress_callback prototype defines.
Data passed to the progress callback
We want the referrer field set automatically when following locations
Port of the proxy, can be set in the proxy string as well with: "[host]:[port]"
size of the POST input data, if strlen() is not good to use
tunnel non-http operations through a HTTP proxy
Set the interface string to use as outgoing network interface
Set the krb4/5 security level, this also enables krb4/5 awareness. This is a string, 'clear', 'safe', 'confidential' or 'private'. If the string is set but doesn't match one of these, 'private' will be used.
Set if we should verify the peer in ssl handshake, set 1 to verify.
The CApath or CAfile used to validate the peer certificate this option is used only if SSL_VERIFYPEER is true
66 = OBSOLETE 67 = OBSOLETE Maximum number of http redirects to follow
Pass a long set to 1 to get the date of the requested document (if possible)! Pass a zero to shut it off.
This points to a linked list of telnet options
Max amount of cached alive connections
What policy to use when closing connections when the cache is filled up
73 = OBSOLETE Set to explicitly use a new connection for the upcoming transfer. Do not use this unless you're absolutely sure of this, as it makes the operation slower and is less friendly for the network.
Set to explicitly forbid the upcoming transfer's connection to be re-used when done. Do not use this unless you're absolutely sure of this, as it makes the operation slower and is less friendly for the network.
Set to a file name that contains random data for libcurl to use to seed the random engine when doing SSL connects.
Set to the Entropy Gathering Daemon socket pathname
Time-out connect operations after this amount of seconds, if connects are OK within this time, then fine... This only aborts the connect phase. [Only works on unix-style/SIGALRM operating systems]
Function that will be called to store headers (instead of fwrite). The parameters will use fwrite() syntax, make sure to follow them.
Set this to force the HTTP request to get back to GET. Only really usable if POST, PUT or a custom request have been used first.
Set if we should verify the Common name from the peer certificate in ssl handshake, set 1 to check existence, 2 to ensure that it matches the provided hostname.
Specify which file name to write all known cookies in after completed operation. Set file name to "-" (dash) to make it go to stdout.
Specify which SSL ciphers to use
Specify which HTTP version to use! This must be set to one of the CURL_HTTP_VERSION* enums set below.
Specifically switch on or off the FTP engine's use of the EPSV command. By default, that one will always be attempted before the more traditional PASV command.
type of the file keeping your SSL-certificate ("DER", "PEM", "ENG")
name of the file keeping your private SSL-key
type of the file keeping your private SSL-key ("DER", "PEM", "ENG")
crypto engine for the SSL-sub system
set the crypto engine for the SSL-sub system as default the param has no meaning...
Non-zero value means to use the global dns cache
DNS cache timeout
send linked-list of pre-transfer QUOTE commands
set the debug function
set the data for the debug function
mark this as start of a cookie session
The CApath directory used to validate the peer certificate this option is used only if SSL_VERIFYPEER is true
Instruct libcurl to use a smaller receive buffer
Instruct libcurl to not use any signal/alarm handlers, even when using timeouts. This option is useful for multi-threaded applications. See libcurl-the-guide for more background information.
Provide a CURLShare for mutexing non-ts data
indicates type of proxy. accepted values are CURLPROXY_HTTP (default), CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5.
Set the Accept-Encoding string. Use this to tell a server you would like the response to be compressed.
Set pointer to private data
Set aliases for HTTP 200 in the HTTP Response header
Continue to send authentication (user+password) when following locations, even when hostname changed. This can potentially send off the name and password to whatever host the server decides.
Specifically switch on or off the FTP engine's use of the EPRT command ( it also disables the LPRT attempt). By default, those ones will always be attempted before the good old traditional PORT command.
Set this to a bitmask value to enable the particular authentications methods you like. Use this in combination with CURLOPT_USERPWD. Note that setting multiple bits may cause extra network round-trips.
Set the ssl context callback function, currently only for OpenSSL ssl_ctx in second argument. The function must be matching the curl_ssl_ctx_callback proto.
Set the userdata for the ssl context callback function's third argument
FTP Option that causes missing dirs to be created on the remote server. In 7.19.4 we introduced the convenience enums for this option using the CURLFTP_CREATE_DIR prefix.
Set this to a bitmask value to enable the particular authentications methods you like. Use this in combination with CURLOPT_PROXYUSERPWD. Note that setting multiple bits may cause extra network round-trips.
FTP option that changes the timeout, in seconds, associated with getting a response. This is different from transfer timeout time and essentially places a demand on the FTP server to acknowledge commands in a timely manner.
Set this option to one of the CURL_IPRESOLVE_* defines (see below) to tell libcurl to resolve names to those IP versions only. This only has affect on systems with support for more than one, i.e IPv4 and_ IPv6.
Set this option to limit the size of a file that will be downloaded from an HTTP or FTP server.
Note there is also LARGE version which adds large file support for platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below.
See the comment for INFILESIZE above, but in short, specifies the size of the file being uploaded. -1 means unknown.
Sets the continuation offset. There is also a LONG version of this; look above for RESUME_FROM.
Sets the maximum size of data that will be downloaded from an HTTP or FTP server. See MAXFILESIZE above for the LONG version.
Set this option to the file name of your .netrc file you want libcurl to parse (using the CURLOPT_NETRC option). If not set, libcurl will do a poor attempt to find the user's home directory and check for a .netrc file in there.
Enable SSL/TLS for FTP, pick one of: CURLFTPSSL_TRY - try using SSL, proceed anyway otherwise CURLFTPSSL_CONTROL - SSL for the control connection or fail CURLFTPSSL_ALL - SSL for all communication or fail
The LARGE version of the standard POSTFIELDSIZE option
Enable/disable the TCP Nagle algorithm
122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 123 OBSOLETE. Gone in 7.16.0 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 127 OBSOLETE. Gone in 7.16.0 128 OBSOLETE. Gone in 7.16.0 When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option can be used to change libcurl's default action which is to first try "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK response has been received.
Available parameters are: CURLFTPAUTH_DEFAULT - let libcurl decide CURLFTPAUTH_SSL - try "AUTH SSL" first, then TLS CURLFTPAUTH_TLS - try "AUTH TLS" first, then SSL
132 OBSOLETE. Gone in 7.16.0 133 OBSOLETE. Gone in 7.16.0 zero terminated string for pass on to the FTP server when asked for "account" info
feed cookies into cookie engine
ignore Content-Length
Set to non-zero to skip the IP address received in a 227 PASV FTP server response. Typically used for FTP-SSL purposes but is not restricted to that. libcurl will then instead use the same IP address it used for the control connection.
Select "file method" to use when doing FTP, see the curl_ftpmethod above.
Local port number to bind the socket to
Number of ports to try, including the first one set with LOCALPORT. Thus, setting it to 1 will make no additional attempts but the first.
no transfer, set up connection and let application use the socket by extracting it with CURLINFO_LASTSOCKET
Function that will be called to convert from the network encoding (instead of using the iconv calls in libcurl)
Function that will be called to convert to the network encoding (instead of using the iconv calls in libcurl)
Function that will be called to convert from UTF8 (instead of using the iconv calls in libcurl) Note that this is used only for SSL certificate processing
if the connection proceeds too quickly then need to slow it down limit-rate: maximum number of bytes per second to send or receive
Pointer to command string to send if USER/PASS fails.
callback function for setting socket options
set to 0 to disable session ID re-use for this transfer, default is enabled (== 1)
allowed SSH authentication methods
Used by scp/sftp to do public/private key authentication
Send CCC (Clear Command Channel) after authentication
Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution
set to zero to disable the libcurl's decoding and thus pass the raw body data to the application even when it is encoded/compressed
Permission used when creating new files and directories on the remote server for protocols that support it, SFTP/SCP/FILE
Set the behaviour of POST when redirecting. Values must be set to one of CURL_REDIR* defines below. This used to be called CURLOPT_POST301
used by scp/sftp to verify the host's public key
Callback function for opening socket (instead of socket(2)). Optionally, callback is able change the address or refuse to connect returning CURL_SOCKET_BAD. The callback should have type curl_opensocket_callback
POST volatile input fields.
set transfer mode (;type=
Callback function for seeking in the input stream
CRL file
Issuer certificate
(IPv6) Address scope
Collect certificate chain info and allow it to get retrievable with CURLINFO_CERTINFO after the transfer is complete. (Unfortunately) only working with OpenSSL-powered builds.
"name" and "pwd" to use when fetching.
"name" and "pwd" to use with Proxy when fetching.
Comma separated list of hostnames defining no-proxy zones. These should match both hostnames directly, and hostnames within a domain. For example, local.com will match local.com and www.local.com, but NOT notlocal.com or www.notlocal.com. For compatibility with other implementations of this, .local.com will be considered to be the same as local.com. A single * is the only valid wildcard, and effectively disables the use of proxy.
block size for TFTP transfers
Socks Service
Socks Service
set the bitmask for the protocols that are allowed to be used for the transfer, which thus helps the app which takes URLs from users or other external inputs and want to restrict what protocol(s) to deal with. Defaults to CURLPROTO_ALL.
set the bitmask for the protocols that libcurl is allowed to follow to, as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs to be set in both bitmasks to be allowed to get redirected to. Defaults to all protocols except FILE and SCP.
set the SSH knownhost file name to use
set the SSH host key callback, must point to a curl_sshkeycallback function
set the SSH host key callback custom pointer
set the SMTP mail originator
set the SMTP mail receiver(s)
- FTP:
- send PRET before PASV
RTSP request method (OPTIONS, SETUP, PLAY, etc...)
The RTSP session identifier
The RTSP stream URI
The Transport: header to use in RTSP requests
Manually initialize the client RTSP CSeq for this handle
Manually initialize the server RTSP CSeq for this handle
The stream to pass to INTERLEAVEFUNCTION.
Let the application define a custom write method for RTP data
Turn on wildcard matching
Directory matching callback called before downloading of an individual file (chunk) started
Directory matching callback called after the file (chunk) was downloaded, or skipped
Change match (fnmatch-like) callback for wildcard matching
Let the application define custom chunk data pointer
FNMATCH_FUNCTION user pointer
send linked-list of name:port:address sets
Set a username for authenticated TLS
Set a password for authenticated TLS
Set authentication type for authenticated TLS
the last unused
alias CURLoption = int;
CurlOption CURLOPT_SERVER_RESPONSE_TIMEOUT;
enum CurlIpResolve: int;
Below here follows defines for the CURLOPT_IPRESOLVE option. If a host name resolves addresses using more than one IP protocol version, this option might be handy to force libcurl to use a specific IP version.
CurlOption CURLOPT_WRITEDATA;
CurlOption CURLOPT_READDATA;
CurlOption CURLOPT_HEADERDATA;
CurlOption CURLOPT_RTSPHEADER;
three convenient "aliases" that follow the name scheme better
enum CurlHttpVersion: int;
These enums are for use with the CURLOPT_HTTP_VERSION option.
enum CurlRtspReq: int;
Public API enums for RTSP requests
enum CurlNetRcOption: int;
These enums are for use with the CURLOPT_NETRC option.
enum CurlSslVersion: int;
enum CurlTlsAuth: int;
enum CurlRedir: int;
symbols to use with CURLOPT_POSTREDIR. CURL_REDIR_POST_301 and CURL_REDIR_POST_302 can be bitwise ORed so that CURL_REDIR_POST_301 | CURL_REDIR_POST_302 == CURL_REDIR_POST_ALL
enum CurlTimeCond: int;
alias curl_TimeCond = int;
int curl_strequal(char* s1, char* s2);
curl_strequal() and curl_strnequal() are subject for removal in a future libcurl, see lib/README.curlx for details
int curl_strnequal(char* s1, char* s2, size_t n);
ditto curl_strequal() and curl_strnequal() are subject for removal in a future libcurl, see lib/README.curlx for details
struct curl_forms;
enum CurlFormAdd: int;
- Returns
- CURL_FORMADD_OK on success CURL_FORMADD_MEMORY if the FormInfo allocation fails CURL_FORMADD_OPTION_TWICE if one option is given twice for one Form CURL_FORMADD_NULL if a null pointer was given for a char CURL_FORMADD_MEMORY if the allocation of a FormInfo struct failed CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used CURL_FORMADD_INCOMPLETE if the some FormInfo is not complete (or error) CURL_FORMADD_MEMORY if a curl_httppost struct cannot be allocated CURL_FORMADD_MEMORY if some allocation for string copying failed. CURL_FORMADD_ILLEGAL_ARRAY if an illegal option is used in an array
use this for multipart formpost building Returns code for curl_formadd()
alias CURLFORMcode = int;
CURLFORMcode curl_formadd(curl_httppost** httppost, curl_httppost** last_post, ...);
- Name:
- curl_formadd()
- Description:
- Pretty advanced function for building multi-part formposts. Each invoke adds one part that together construct a full post. Then use CURLOPT_HTTPPOST to send it off to libcurl.
alias curl_formget_callback = extern (C) uint function(void* arg, char* buf, uint len);
callback function for curl_formget() The void *arg pointer will be the one passed as second argument to curl_formget(). The character buffer passed to it must not be freed. Should return the buffer length passed to it as the argument "len" on success.
int curl_formget(curl_httppost* form, void* arg, curl_formget_callback append);
- Name:
- curl_formget()
- Description:
- Serialize a curl_httppost struct built with curl_formadd(). Accepts a void pointer as second argument which will be passed to the curl_formget_callback function. Returns 0 on success.
void curl_formfree(curl_httppost* form);
- Name:
- curl_formfree()
- Description:
- Free a multipart formpost previously built with curl_formadd().
char* curl_getenv(char* variable);
- Name:
- curl_getenv()
- Description:
- Returns a malloc()'ed string that MUST be curl_free()ed after usage is complete. DEPRECATED - see lib/README.curlx
char* curl_version();
- Name:
- curl_version()
- Description:
- Returns a static ascii string of the libcurl version.
char* curl_easy_escape(CURL* handle, char* string, int length);
- Name:
- curl_easy_escape()
- Description:
- Escapes URL strings (converts all letters consider illegal in URLs to their %XX versions). This function returns a new allocated string or NULL if an error occurred.
char* curl_escape(char* string, int length);
the previous version:
char* curl_easy_unescape(CURL* handle, char* string, int length, int* outlength);
- Name:
- curl_easy_unescape()
- Description:
- Unescapes URL encoding in strings (converts all %XX codes to their 8bit versions). This function returns a new allocated string or NULL if an error occurred. Conversion Note: On non-ASCII platforms the ASCII %XX codes are converted into the host encoding.
char* curl_unescape(char* string, int length);
the previous version
void curl_free(void* p);
- Name:
- curl_free()
- Description:
- Provided for de-allocation in the same translation unit that did the allocation. Added in libcurl 7.10
CURLcode curl_global_init(c_long flags);
- Name:
- curl_global_init()
- Description:
-
curl_global_init() should be invoked exactly once for each application that
uses libcurl and before any call of other libcurl functions.
This function is not thread-safe!
CURLcode curl_global_init_mem(c_long flags, curl_malloc_callback m, curl_free_callback f, curl_realloc_callback r, curl_strdup_callback s, curl_calloc_callback c);
- Name:
- curl_global_init_mem()
- Description:
- curl_global_init() or curl_global_init_mem() should be invoked exactly once for each application that uses libcurl. This function can be used to initialize libcurl and set user defined memory management callback functions. Users can implement memory management routines to check for memory leaks, check for mis-use of the curl library etc. User registered callback routines with be invoked by this library instead of the system memory management routines like malloc, free etc.
void curl_global_cleanup();
- Name:
- curl_global_cleanup()
- Description:
- curl_global_cleanup() should be invoked exactly once for each application that uses libcurl
struct curl_slist;
linked-list structure for the CURLOPT_QUOTE option (and other)
curl_slist* curl_slist_append(curl_slist*, char*);
- Name:
- curl_slist_append()
- Description:
- Appends a string to a linked list. If no list exists, it will be created first. Returns the new list, after appending. linked-list structure for the CURLOPT_QUOTE option (and other)
void curl_slist_free_all(curl_slist*);
- Name:
- curl_slist_free_all()
- Description:
- free a previously built curl_slist. linked-list structure for the CURLOPT_QUOTE option (and other)
time_t curl_getdate(char* p, time_t* unused);
- Name:
- curl_getdate()
- Description:
- Returns the time, in seconds since 1 Jan 1970 of the time string given in the first argument. The time argument in the second parameter is unused and should be set to NULL. linked-list structure for the CURLOPT_QUOTE option (and other)
struct curl_certinfo;
info about the certificate chain, only for OpenSSL builds. Asked for with CURLOPT_CERTINFO / CURLINFO_CERTINFO linked-list structure for the CURLOPT_QUOTE option (and other)
int num_of_certs;
number of certificates with information
curl_slist** certinfo;
for each index in this array, there's a linked list with textual information in the format "name: value"
int CURLINFO_STRING;
int CURLINFO_LONG;
int CURLINFO_DOUBLE;
int CURLINFO_SLIST;
int CURLINFO_MASK;
int CURLINFO_TYPEMASK;
enum CurlInfo: int;
Fill in new entries below here!
alias CURLINFO = int;
CurlInfo CURLINFO_HTTP_CODE;
CURLINFO_RESPONSE_CODE is the new name for the option previously known as CURLINFO_HTTP_CODE
enum CurlClosePolicy: int;
alias curl_closepolicy = int;
enum CurlGlobal: int;
enum CurlLockData: int;
Setup defines, protos etc for the sharing stuff. Different data locks for a single share
alias curl_lock_data = int;
enum CurlLockAccess: int;
Different lock access types
alias curl_lock_access = int;
alias curl_lock_function = void function(void* handle, int data, int locktype, void* userptr);
alias curl_unlock_function = void function(void* handle, int data, void* userptr);
alias CURLSH = void;
enum CurlShError: int;
alias CURLSHcode = int;
enum CurlShOption: int;
pass in a user data pointer used in the lock/unlock callback functions
alias CURLSHoption = int;
CURLSH* curl_share_init();
CURLSHcode curl_share_setopt(CURLSH*, CURLSHoption option, ...);
CURLSHcode curl_share_cleanup(CURLSH*);
enum CurlVer: int;
Structures for querying information about the curl library at runtime.
alias CURLversion = int;
CurlVer CURLVERSION_NOW;
The ' CURLVERSION_NOW' is the symbolic name meant to be used by basically all programs ever that want to get version information. It is meant to be a built-in version number for what kind of struct the caller expects. If the struct ever changes, we redefine the NOW to another enum from above.
struct _N28;
CURLversion age;
age of the returned struct
char* version_;
LIBCURL_VERSION
uint version_num;
LIBCURL_VERSION_NUM
char* host;
OS/ host/cpu/machine when configured
int features;
bitmask, see defines below
char* ssl_version;
human readable string
c_long ssl_version_num;
not used anymore, always 0
char* libz_version;
human readable string
char** protocols;
protocols is terminated by an entry with a NULL protoname
char* ares;
The fields below this were added in CURLVERSION_SECOND
char* libidn;
This field was added in CURLVERSION_THIRD
int iconv_ver_num;
These field were added in CURLVERSION_FOURTH Same as 'libiconv_version' if built with HAVE_ICONV
char* libssh_version;
human readable string
alias curl_version_info_data = _N28;
enum CurlVersion: int;
IPv6-enabled
kerberos auth is supported
SSL options are present
libz features are present
NTLM auth is supported
Negotiate auth support
built with debug capabilities
asynchronous dns resolves
SPNEGO auth
supports files bigger than 2GB
International Domain Names support
SSPI is supported
character conversions supported
debug memory tracking supported
TLS-SRP auth is supported
curl_version_info_data* curl_version_info(CURLversion);
- Name:
- curl_version_info()
- Description:
- This function returns a pointer to a static copy of the version info struct. See above.
char* curl_easy_strerror(CURLcode);
- Name:
- curl_easy_strerror()
- Description:
- The curl_easy_strerror function may be used to turn a CURLcode value into the equivalent human readable error string. This is useful for printing meaningful error messages.
char* curl_share_strerror(CURLSHcode);
- Name:
- curl_share_strerror()
- Description:
- The curl_share_strerror function may be used to turn a CURLSHcode value into the equivalent human readable error string. This is useful for printing meaningful error messages.
CURLcode curl_easy_pause(CURL* handle, int bitmask);
- Name:
- curl_easy_pause()
- Description:
- The curl_easy_pause function pauses or unpauses transfers. Select the new state by setting the bitmask, use the convenience defines below.
enum CurlPause: int;
CURL* curl_easy_init();
CURLcode curl_easy_setopt(CURL* curl, CURLoption option, ...);
CURLcode curl_easy_perform(CURL* curl);
void curl_easy_cleanup(CURL* curl);
CURLcode curl_easy_getinfo(CURL* curl, CURLINFO info, ...);
- Name:
- curl_easy_getinfo()
- Description:
- Request internal information from the curl session with this function. The third argument MUST be a pointer to a long, a pointer to a char * or a pointer to a double (as the documentation describes elsewhere). The data pointed to will be filled in accordingly and can be relied upon only if the function returns CURLE_OK. This function is intended to get used *AFTER* a performed transfer, all results from this function are undefined until the transfer is completed.
CURL* curl_easy_duphandle(CURL* curl);
- Name:
- curl_easy_duphandle()
- Description:
- Creates a new curl session handle with the same options set for the handle passed in. Duplicating a handle could only be a matter of cloning data and options, internal state info and things like persistant connections cannot be transfered. It is useful in multithreaded applications when you can run curl_easy_duphandle() for each new thread to avoid a series of identical curl_easy_setopt() invokes in every thread.
void curl_easy_reset(CURL* curl);
- Name:
- curl_easy_reset()
- Description:
-
Re-initializes a CURL handle to the default values. This puts back the
handle to the same state as it was in when it was just created.
It does keep: live connections, the Session ID cache, the DNS cache and the cookies.
CURLcode curl_easy_recv(CURL* curl, void* buffer, size_t buflen, size_t* n);
- Name:
- curl_easy_recv()
- Description:
- Receives data from the connected socket. Use after successful curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
CURLcode curl_easy_send(CURL* curl, void* buffer, size_t buflen, size_t* n);
- Name:
- curl_easy_send()
- Description:
- Sends data over the connected socket. Use after successful curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
alias CURLM = void;
enum CurlM: int;
please call curl_multi_perform() or curl_multi_socket*() soon
the passed-in handle is not a valid CURLM handle
an easy handle was not good/valid
if you ever get this, you're in deep sh*t
this is a libcurl bug
the passed in socket argument did not match
curl_multi_setopt() with unsupported option
alias CURLMcode = int;
CurlM CURLM_CALL_MULTI_SOCKET;
just to make code nicer when using curl_multi_socket() you can now check for CURLM_CALL_MULTI_SOCKET too in the same style it works for curl_multi_perform() and CURLM_CALL_MULTI_PERFORM
enum CurlMsg: int;
alias CURLMSG = int;
union _N31;
struct CURLMsg;
CURLM* curl_multi_init();
- Name:
- curl_multi_init()
- Desc:
- inititalize multi-style curl usage
- Returns
- a new CURLM handle to use in all 'curl_multi' functions.
CURLMcode curl_multi_add_handle(CURLM* multi_handle, CURL* curl_handle);
- Name:
- curl_multi_add_handle()
- Desc:
- add a standard curl handle to the multi stack
- Returns
- CURLMcode type, general multi error code.
CURLMcode curl_multi_remove_handle(CURLM* multi_handle, CURL* curl_handle);
- Name:
- curl_multi_remove_handle()
- Desc:
- removes a curl handle from the multi stack again
- Returns
- CURLMcode type, general multi error code.
alias fd_set = int;
- Name:
- curl_multi_fdset()
- Desc:
- Ask curl for its fd_set sets. The app can use these to select() or poll() on. We want curl_multi_perform() called as soon as one of them are ready.
- Returns
- CURLMcode type, general multi error code. tmp decl
CURLMcode curl_multi_fdset(CURLM* multi_handle, fd_set* read_fd_set, fd_set* write_fd_set, fd_set* exc_fd_set, int* max_fd);
CURLMcode curl_multi_perform(CURLM* multi_handle, int* running_handles);
- Name:
- curl_multi_perform()
- Desc:
- When the app thinks there's data available for curl it calls this function to read/write whatever there is right now. This returns as soon as the reads and writes are done. This function does not require that there actually is data available for reading or that data can be written, it can be called just in case. It returns the number of handles that still transfer data in the second argument's integer-pointer.
- Returns
- CURLMcode type, general multi error code. *NOTE* that this only returns errors etc regarding the whole multi stack. There might still have occurred problems on invidual transfers even when this returns OK.
CURLMcode curl_multi_cleanup(CURLM* multi_handle);
- Name:
- curl_multi_cleanup()
- Desc:
- Cleans up and removes a whole multi stack. It does not free or touch any individual easy handles in any way. We need to define in what state those handles will be if this function is called in the middle of a transfer.
- Returns
- CURLMcode type, general multi error code.
CURLMsg* curl_multi_info_read(CURLM* multi_handle, int* msgs_in_queue);
- Name:
- curl_multi_info_read()
- Desc:
-
Ask the multi handle if there's any messages/informationals from
the individual transfers. Messages include informationals such as
error code from the transfer or just the fact that a transfer is
completed. More details on these should be written down as well.
Repeated calls to this function will return a new struct each time, until a special "end of msgs" struct is returned as a signal that there is no more to get at this point.
The data the returned pointer points to will not survive calling curl_multi_cleanup().
The 'CURLMsg' struct is meant to be very simple and only contain very basic informations. If more involved information is wanted, we will provide the particular "transfer handle" in that struct and that should/could/would be used in subsequent curl_easy_getinfo() calls (or similar). The point being that we must never expose complex structs to applications, as then we'll undoubtably get backwards compatibility problems in the future. - Returns
- A pointer to a filled-in struct, or NULL if it failed or ran out of structs. It also writes the number of messages left in the queue (after this read) in the integer the second argument points to.
char* curl_multi_strerror(CURLMcode);
- Name:
- curl_multi_strerror()
- Desc:
- The curl_multi_strerror function may be used to turn a CURLMcode value into the equivalent human readable error string. This is useful for printing meaningful error messages.
- Returns
- A pointer to a zero-terminated error message.
enum CurlPoll: int;
- Name:
- curl_multi_socket() and curl_multi_socket_all()
- Desc:
- An alternative version of curl_multi_perform() that allows the application to pass in one of the file descriptors that have been detected to have "action" on them and let libcurl perform. See man page for details.
alias CURL_SOCKET_TIMEOUT = CURL_SOCKET_BAD;
enum CurlCSelect: int;
alias curl_socket_callback = extern (C) int function(void* easy, socket_t s, int what, void* userp, void* socketp);
private socket pointer
alias curl_multi_timer_callback = extern (C) int function(void* multi, int timeout_ms, void* userp);
- Name:
- curl_multi_timer_callback
- Desc:
- Called by libcurl whenever the library detects a change in the maximum number of milliseconds the app is allowed to wait before curl_multi_socket() or curl_multi_perform() must be called (to allow libcurl's timed events to take place).
- Returns
- The callback should return zero. private callback pointer
private callback pointer
CURLMcode curl_multi_socket(CURLM* multi_handle, curl_socket_t s, int* running_handles);
- Name:
- curl_multi_timer_callback
- Desc:
- Called by libcurl whenever the library detects a change in the maximum number of milliseconds the app is allowed to wait before curl_multi_socket() or curl_multi_perform() must be called (to allow libcurl's timed events to take place).
- Returns
- The callback should return zero. private callback pointer
ditto
CURLMcode curl_multi_socket_action(CURLM* multi_handle, curl_socket_t s, int ev_bitmask, int* running_handles);
- Name:
- curl_multi_timer_callback
- Desc:
- Called by libcurl whenever the library detects a change in the maximum number of milliseconds the app is allowed to wait before curl_multi_socket() or curl_multi_perform() must be called (to allow libcurl's timed events to take place).
- Returns
- The callback should return zero. private callback pointer
ditto
CURLMcode curl_multi_socket_all(CURLM* multi_handle, int* running_handles);
- Name:
- curl_multi_timer_callback
- Desc:
- Called by libcurl whenever the library detects a change in the maximum number of milliseconds the app is allowed to wait before curl_multi_socket() or curl_multi_perform() must be called (to allow libcurl's timed events to take place).
- Returns
- The callback should return zero. private callback pointer
ditto
CURLMcode curl_multi_timeout(CURLM* multi_handle, c_long* milliseconds);
- Name:
- curl_multi_timeout()
- Desc:
- Returns the maximum number of milliseconds the app is allowed to wait before curl_multi_socket() or curl_multi_perform() must be called (to allow libcurl's timed events to take place).
- Returns
- CURLM error code.
This macro below was added in 7.16.3 to push users who recompile to use the new curl_multi_socket_action() instead of the old curl_multi_socket()
enum CurlMOption: int;
This is the socket callback function pointer
This is the argument passed to the socket callback
set to 1 to enable pipelining for this multi handle
This is the timer callback function pointer
This is the argument passed to the timer callback
maximum number of entries in the connection cache
alias CURLMoption = int;
CURLMcode curl_multi_setopt(CURLM* multi_handle, CURLMoption option, ...);
- Name:
- curl_multi_setopt()
- Desc:
- Sets options for the multi handle.
- Returns
- CURLM error code.
CURLMcode curl_multi_assign(CURLM* multi_handle, curl_socket_t sockfd, void* sockp);
- Name:
- curl_multi_assign()
- Desc:
- This function sets an association in the multi handle between the given socket and a private pointer of the application. This is (only) useful for curl_multi_socket uses.
- Returns
- CURLM error code.