etc.c.curl

This is an interface to the libcurl library.

Converted to D from curl headers by htod and cleaned up by Jonas Drewsen (jdrewsen)

Windows x86 note: A DMD compatible libcurl static library can be downloaded from the dlang.org

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.

var CURL_ERROR_SIZE CURL_MAX_HTTP_HEADER CURL_MAX_WRITE_SIZE CURL_WRITEFUNC_PAUSE CURLINFO_DOUBLE CURLINFO_HTTP_CODE CURLINFO_LONG CURLINFO_MASK CURLINFO_SLIST CURLINFO_STRING CURLINFO_TYPEMASK CURLM_CALL_MULTI_SOCKET CURLOPT_HEADERDATA CURLOPT_READDATA CURLOPT_RTSPHEADER CURLOPT_SERVER_RESPONSE_TIMEOUT CURLOPT_WRITEDATA CURLOPTTYPE_FUNCTIONPOINT CURLOPTTYPE_LONG CURLOPTTYPE_OBJECTPOINT CURLOPTTYPE_OFF_T CURLVERSION_NOW HTTPPOST_BUFFER HTTPPOST_CALLBACK HTTPPOST_FILENAME HTTPPOST_PTRBUFFER HTTPPOST_PTRCONTENTS HTTPPOST_PTRNAME HTTPPOST_READFILE LIBCURL_COPYRIGHT LIBCURL_TIMESTAMP LIBCURL_VERSION LIBCURL_VERSION_MAJOR LIBCURL_VERSION_MINOR LIBCURL_VERSION_NUM LIBCURL_VERSION_PATCH

alias CURL curl_calloc_callback curl_chunk_bgn_callback curl_chunk_end_callback curl_closepolicy curl_conv_callback curl_debug_callback curl_fnmatch_callback curl_formget_callback curl_free_callback curl_ftpauth curl_ftpccc curl_ftpcreatedir curl_ftpmethod curl_infotype curl_ioctl_callback curl_lock_access curl_lock_data curl_lock_function curl_malloc_callback curl_multi_timer_callback curl_off_t curl_opensocket_callback curl_progress_callback curl_proxytype curl_read_callback curl_realloc_callback curl_seek_callback curl_socket_callback curl_socket_t CURL_SOCKET_TIMEOUT curl_sockopt_callback curl_sshkeycallback curl_ssl_ctx_callback curl_strdup_callback curl_TimeCond curl_unlock_function curl_usessl curl_version_info_data curl_write_callback CURLcode curlfiletype CURLFORMcode CURLformoption CURLINFO curliocmd curlioerr CURLM CURLMcode CURLMoption CURLMSG CURLoption CURLSH CURLSHcode CURLSHoption curlsocktype CURLversion fd_set FUNCTIONPOINT LONG OBJECTPOINT OFF_T

enum CurlAuth CurlCallbackInfo CurlChunkBgnFunc CurlChunkEndFunc CurlClosePolicy CurlCSelect CurlError CurlFileType CurlFInfoFlagKnown CurlFnMAtchFunc CurlForm CurlFormAdd CurlFtp CurlFtpAuth CurlFtpMethod CurlFtpSSL CurlGlobal CurlHttpVersion CurlInfo CurlIoCmd CurlIoError CurlIpResolve CurlKHMatch CurlKHStat CurlKHType CurlLockAccess CurlLockData CurlM CurlMOption CurlMsg CurlNetRcOption CurlOption CurlPause CurlPoll CurlProto CurlProxy CurlReadFunc CurlRedir CurlRtspReq CurlSeek CurlSeekPos CurlShError CurlShOption CurlSockType CurlSshAuth CurlSslVersion CurlTimeCond CurlTlsAuth CurlUseSSL CurlVer CurlVersion

struct _N2 _N28 curl_certinfo curl_fileinfo curl_forms curl_httppost curl_khkey curl_slist curl_sockaddr CURLMsg

union _N31

fn curl_easy_cleanup curl_easy_duphandle curl_easy_escape curl_easy_getinfo curl_easy_init curl_easy_pause curl_easy_perform curl_easy_recv curl_easy_reset curl_easy_send curl_easy_setopt curl_easy_strerror curl_easy_unescape curl_escape curl_formadd curl_formfree curl_formget curl_free curl_getdate curl_getenv curl_global_cleanup curl_global_init curl_global_init_mem curl_multi_add_handle curl_multi_assign curl_multi_cleanup curl_multi_fdset curl_multi_info_read curl_multi_init curl_multi_perform curl_multi_remove_handle curl_multi_setopt curl_multi_socket curl_multi_socket_action curl_multi_socket_all curl_multi_strerror curl_multi_timeout curl_share_cleanup curl_share_init curl_share_setopt curl_share_strerror curl_slist_append curl_slist_free_all curl_strequal curl_strnequal curl_unescape curl_version curl_version_info

Types 124

aliascurl_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.

aliasCURL = void

aliascurl_socket_t = socket_t

jdrewsen - Get socket alias from std.socket

structcurl_httppost

Fields

curl_httppost *next next

char *name name

c_long namelength

char *contents contents

c_long contentslength

char *buffer buffer

c_long bufferlength

char *contenttype contenttype

curl_slist *contentheader contentheader

curl_httppost *more more

c_long flags

char *showfilename showfilename

void *userp userp

aliascurl_progress_callback = int function(void * clientp, double dltotal, double dlnow, double ultotal, double ulnow)

aliascurl_write_callback = size_t function(char * buffer, size_t size, size_t nitems, void * outstream)

enumCurlFileType

enumeration of file types

file

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

okfirst, no error

memory

option_twice

null_ptr

unknown_option

incomplete

illegal_array

disabledlibcurl was built with this disabled

last

aliasCURLFORMcode = int

aliascurl_formget_callback = size_t function(void * arg, const(char) * buf, size_t 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.

structcurl_slist

linked-list structure for the CURLOPT_QUOTE option (and other)

Fields

char *data data

curl_slist *next next

structcurl_certinfo

info about the certificate chain, only for OpenSSL builds. Asked for with CURLOPT_CERTINFO / CURLINFO_CERTINFO

Fields

int num_of_certs

curl_slist * *certinfo certinfo

enumCurlInfo

none

effective_url = 1_048_577

response_code = 2_097_154

total_time = 3_145_731

namelookup_time

connect_time

pretransfer_time

size_upload

size_download

speed_download

speed_upload

header_size = 2_097_163

request_size

ssl_verifyresult

filetime

content_length_download = 3_145_743

content_length_upload

starttransfer_time

content_type = 1_048_594

redirect_time = 3_145_747

redirect_count = 2_097_172

private_info = 1_048_597

http_connectcode = 2_097_174

httpauth_avail

proxyauth_avail

os_errno

num_connects

ssl_engines = 4_194_331

cookielist

lastsocket = 2_097_181

ftp_entry_path = 1_048_606

redirect_url

primary_ip

appconnect_time = 3_145_761

certinfo = 4_194_338

condition_unmet = 2_097_187

rtsp_session_id = 1_048_612

rtsp_client_cseq = 2_097_189

rtsp_server_cseq

rtsp_cseq_recv

primary_port

local_ip = 1_048_617

local_port = 2_097_194

lastone = 42Fill in new entries below here!

aliasCURLINFO = int

enumCurlClosePolicy

none

oldest

least_recently_used

least_traffic

slowest

callback

last

aliascurl_closepolicy = int

enumCurlGlobal

ssl = 1

win32 = 2

all = (1 | 2)

nothing = 0

default_ = (1 | 2)all

enumCurlLockData

Setup defines, protos etc for the sharing stuff. Different data locks for a single share

none

shareCURLLOCKDATA_SHARE is used internally to say that the locking is just made to change the internal state of the share itself.

dns

ssl_session

connect

last

aliascurl_lock_data = int

enumCurlLockAccess

Different lock access types

noneunspecified action

shared_accessfor read perhaps

singlefor write perhaps

lastnever use

aliascurl_lock_access = int

aliascurl_lock_function = void function(CURL * handle, curl_lock_data data, curl_lock_access locktype, void * userptr)

aliascurl_unlock_function = void function(CURL * handle, curl_lock_data data, void * userptr)

aliasCURLSH = void

enumCurlShError

okall is fine

bad_option1

in_use2

invalid3

nomemout of memory

lastnever use

aliasCURLSHcode = int

enumCurlShOption

pass in a user data pointer used in the lock/unlock callback functions

nonedon't use

sharespecify a data type to share

unsharespecify which data type to stop sharing

lockfuncpass in a 'curllockfunction' pointer

unlockfuncpass in a 'curlunlockfunction' pointer

userdatapass in a user data pointer used in the lock/unlock callback functions

lastnever use

aliasCURLSHoption = int

enumCurlVer

Structures for querying information about the curl library at runtime.

first

second

third

fourth

last

aliasCURLversion = int

struct_N28

Fields

CURLversion age

const(char) *version_ version_

uint version_num

const(char) *host host

int features

const(char) *ssl_version ssl_version

c_long ssl_version_num

const(char) *libz_version libz_version

const(char) * *protocols protocolsprotocols is terminated by an entry with a NULL protoname

const(char) *ares aresThe fields below this were added in CURLVERSION_SECOND

int ares_num

const(char) *libidn libidnThis field was added in CURLVERSION_THIRD

int iconv_ver_numThese field were added in CURLVERSIONFOURTH. Same as 'libiconvversion' if built with HAVEICONV

const(char) *libssh_version libssh_version

aliascurl_version_info_data = _N28

enumCurlVersion

ipv6 = 1IPv6-enabled

kerberos4 = 2kerberos auth is supported

ssl = 4SSL options are present

libz = 8libz features are present

ntlm = 16NTLM auth is supported

gssnegotiate = 32Negotiate auth support

dbg = 64built with debug capabilities

asynchdns = 128asynchronous dns resolves

spnego = 256SPNEGO auth

largefile = 512supports files bigger than 2GB

idn = 1024International Domain Names support

sspi = 2048SSPI is supported

conv = 4096character conversions supported

curldebug = 8192debug memory tracking supported

tlsauth_srp = 16_384TLS-SRP auth is supported

enumCurlPause

recv = 1

recv_cont = 0

send = 4

send_cont = 0

all = (1 | 4)

cont = (0 | 0)

aliasCURLM = void

enumCurlM

call_multi_perform = - 1please call curlmultiperform() or curlmultisocket*() soon

bad_handlethe passed-in handle is not a valid CURLM handle

bad_easy_handlean easy handle was not good/valid

out_of_memoryif you ever get this, you're in deep sh*t

internal_errorthis is a libcurl bug

bad_socketthe passed in socket argument did not match

unknown_optioncurlmultisetopt() with unsupported option

last

aliasCURLMcode = int

enumCurlMsg

none

doneThis easy handle has completed. 'result' contains the CURLcode of the transfer

lastno used

aliasCURLMSG = int

union_N31

Fields

void *whatever whatever

CURLcode result

structCURLMsg

Fields

CURLMSG msg

CURL *easy_handle easy_handle

_N31 data

aliasfd_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

enumCurlPoll

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.

none_ = 0jdrewsen - underscored in order not to clash with reserved D symbols

in_ = 1

out_ = 2

inout_ = 3

remove_ = 4

aliasCURL_SOCKET_TIMEOUT = CURL_SOCKET_BAD

enumCurlCSelect

in_ = 0x01jdrewsen - underscored in order not to clash with reserved D symbols

out_ = 0x02

err_ = 0x04

aliascurl_socket_callback = int function(CURL * easy, /** easy handle */ curl_socket_t s, /** socket */ int what, /** see above */ void * userp, /** private callback pointer */ void * socketp)

private socket pointer

aliascurl_multi_timer_callback = int function(CURLM * multi, /** multi handle */ c_long timeout_ms, /** see above */ 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

enumCurlMOption

socketfunction = 20_001This is the socket callback function pointer

socketdata = 10_002This is the argument passed to the socket callback

pipelining = 3set to 1 to enable pipelining for this multi handle

timerfunction = 20_004This is the timer callback function pointer

timerdata = 10_005This is the argument passed to the timer callback

maxconnects = 6maximum number of entries in the connection cache

lastentry

aliasCURLMoption = int

Functions 48

fnint curl_strequal(scope const(char) * s1, scope const(char) * s2)curlstrequal() and curlstrnequal() are subject for removal in a future libcurl, see lib/README.curlx for details

fnint curl_strnequal(scope const(char) * s1, scope const(char) * s2, size_t n)ditto

fnCURLFORMcode curl_formadd(curl_httppost * * httppost, curl_httppost * * last_post,...)Name: curl_formadd()

fnint curl_formget(curl_httppost * form, void * arg, curl_formget_callback append)Name: curl_formget()

fnvoid curl_formfree(curl_httppost * form)Name: curl_formfree()

fnchar * curl_getenv(scope const(char) * variable)Name: curl_getenv()

fnchar * curl_version()Name: curl_version()

fnchar * curl_easy_escape(CURL * handle, scope const(char) * string, int length)Name: curleasyescape()

fnchar * curl_escape(scope const(char) * string, int length)the previous version:

fnchar * curl_easy_unescape(CURL * handle, scope const(char) * string, int length, int * outlength)Name: curleasyunescape()

fnchar * curl_unescape(scope const(char) * string, int length)the previous version

fnvoid curl_free(void * p)Name: curl_free()

fnCURLcode curl_global_init(c_long flags)Name: curlglobalinit()

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: curlglobalinit_mem()

fnvoid curl_global_cleanup()Name: curlglobalcleanup()

fncurl_slist * curl_slist_append(curl_slist *, const(char) *)Name: curlslistappend()

fnvoid curl_slist_free_all(curl_slist *)Name: curlslistfree_all()

fntime_t curl_getdate(const(char) * p, const(time_t) * unused)Name: curl_getdate()

fnCURLSH * curl_share_init()

fnCURLSHcode curl_share_setopt(CURLSH *, CURLSHoption option,...)

fnCURLSHcode curl_share_cleanup(CURLSH *)

fncurl_version_info_data * curl_version_info(CURLversion )Name: curlversioninfo()

fnconst(char) * curl_easy_strerror(CURLcode )Name: curleasystrerror()

fnconst(char) * curl_share_strerror(CURLSHcode )Name: curlsharestrerror()

fnCURLcode curl_easy_pause(CURL * handle, int bitmask)Name: curleasypause()

fnCURL * curl_easy_init()

fnCURLcode curl_easy_setopt(CURL * curl, CURLoption option,...)

fnCURLcode curl_easy_perform(CURL * curl)

fnvoid curl_easy_cleanup(CURL * curl)

fnCURLcode curl_easy_getinfo(CURL * curl, CURLINFO info,...)Name: curleasygetinfo()

fnCURL * curl_easy_duphandle(CURL * curl)Name: curleasyduphandle()

fnvoid curl_easy_reset(CURL * curl)Name: curleasyreset()

fnCURLcode curl_easy_recv(CURL * curl, void * buffer, size_t buflen, size_t * n)Name: curleasyrecv()

fnCURLcode curl_easy_send(CURL * curl, void * buffer, size_t buflen, size_t * n)Name: curleasysend()

fnCURLM * curl_multi_init()Name: curlmultiinit()

fnCURLMcode curl_multi_add_handle(CURLM * multi_handle, CURL * curl_handle)Name: curlmultiadd_handle()

fnCURLMcode curl_multi_remove_handle(CURLM * multi_handle, CURL * curl_handle)Name: curlmultiremove_handle()

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
)

fnCURLMcode curl_multi_perform(CURLM * multi_handle, int * running_handles)Name: curlmultiperform()

fnCURLMcode curl_multi_cleanup(CURLM * multi_handle)Name: curlmulticleanup()

fnCURLMsg * curl_multi_info_read(CURLM * multi_handle, int * msgs_in_queue)Name: curlmultiinfo_read()

fnconst(char) * curl_multi_strerror(CURLMcode )Name: curlmultistrerror()

fnCURLMcode curl_multi_socket(CURLM * multi_handle, curl_socket_t s, int * running_handles)ditto

fnCURLMcode curl_multi_socket_action(CURLM * multi_handle, curl_socket_t s, int ev_bitmask, int * running_handles)ditto

fnCURLMcode curl_multi_socket_all(CURLM * multi_handle, int * running_handles)ditto

fnCURLMcode curl_multi_timeout(CURLM * multi_handle, c_long * milliseconds)This macro below was added in 7.16.3 to push users who recompile to use the new curlmultisocketaction() instead of the old curlmultisocket() Name: curlmulti_timeout()

fnCURLMcode curl_multi_setopt(CURLM * multi_handle, CURLMoption option,...)Name: curlmultisetopt()

fnCURLMcode curl_multi_assign(CURLM * multi_handle, curl_socket_t sockfd, void * sockp)Name: curlmultiassign()

Variables 36

enumvarLIBCURL_COPYRIGHT = "1996 - 2010 Daniel Stenberg, <daniel@haxx.se>."

This is the global package copyright

enumvarLIBCURL_VERSION = "7.21.4"

This is the version number of the libcurl package from which this header file origins:

enumvarLIBCURL_VERSION_MAJOR = 7

The numeric version number is also available "in parts" by using these constants

enumvarLIBCURL_VERSION_MINOR = 21

ditto

enumvarLIBCURL_VERSION_PATCH = 4

ditto

enumvarLIBCURL_VERSION_NUM = 0x071504

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.

enumvarLIBCURL_TIMESTAMP = "Thu Feb 17 12:19:40 UTC 2011"

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"

enumvarHTTPPOST_FILENAME = 1

specified content is a file name

enumvarHTTPPOST_READFILE = 2

specified content is a file name

enumvarHTTPPOST_PTRNAME = 4

name is only stored pointer do not free in formfree

enumvarHTTPPOST_PTRCONTENTS = 8

contents is only stored pointer do not free in formfree

enumvarHTTPPOST_BUFFER = 16

upload file from buffer

enumvarHTTPPOST_PTRBUFFER = 32

upload file from pointer contents

enumvarHTTPPOST_CALLBACK = 64

upload file contents by using the regular read callback to get the data and pass the given pointer as custom pointer

enumvarCURL_MAX_WRITE_SIZE = 16_384

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).

enumvarCURL_MAX_HTTP_HEADER = (100 * 1024)

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

enumvarCURL_WRITEFUNC_PAUSE = 0x10000001

This is a magic return code for the write callback that, when returned, will signal libcurl to pause receiving on the current transfer.

enumvarCURL_ERROR_SIZE = 256

enumvarCURLOPTTYPE_LONG = 0

long may be 32 or 64 bits, but we should never depend on anything else but 32

enumvarCURLOPTTYPE_OBJECTPOINT = 10_000

ditto

enumvarCURLOPTTYPE_FUNCTIONPOINT = 20_000

ditto

enumvarCURLOPTTYPE_OFF_T = 30_000

ditto

enumvarCURLOPT_SERVER_RESPONSE_TIMEOUT = CurlOption.ftp_response_timeout

enumvarCURLOPT_WRITEDATA = CurlOption.file

three convenient "aliases" that follow the name scheme better

enumvarCURLOPT_READDATA = CurlOption.infile

ditto

enumvarCURLOPT_HEADERDATA = CurlOption.writeheader

ditto

enumvarCURLOPT_RTSPHEADER = CurlOption.httpheader

ditto

enumvarCURLINFO_STRING = 0x100000

enumvarCURLINFO_LONG = 0x200000

enumvarCURLINFO_DOUBLE = 0x300000

enumvarCURLINFO_SLIST = 0x400000

enumvarCURLINFO_MASK = 0x0fffff

enumvarCURLINFO_TYPEMASK = 0xf00000

enumvarCURLINFO_HTTP_CODE = CurlInfo.response_code

CURLINFO_RESPONSE_CODE is the new name for the option previously known as CURLINFO_HTTP_CODE

enumvarCURLVERSION_NOW = CurlVer.fourth

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.

enumvarCURLM_CALL_MULTI_SOCKET = CurlM.call_multi_perform

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