1 #ifndef __CURL_CURL_H 2 #define __CURL_CURL_H 3 /*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. 11 * 12 * This software is licensed as described in the file COPYING, which 13 * you should have received as part of this distribution. The terms 14 * are also available at http://curl.haxx.se/docs/copyright.html. 15 * 16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 17 * copies of the Software, and permit persons to whom the Software is 18 * furnished to do so, under the terms of the COPYING file. 19 * 20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 21 * KIND, either express or implied. 22 * 23 ***************************************************************************/ 24 25 /* 26 * If you have libcurl problems, all docs and details are found here: 27 * http://curl.haxx.se/libcurl/ 28 * 29 * curl-library mailing list subscription and unsubscription web interface: 30 * http://cool.haxx.se/mailman/listinfo/curl-library/ 31 */ 32 33 #include "curlver.h" /* libcurl version defines */ 34 #include "curlbuild.h" /* libcurl build definitions */ 35 #include "curlrules.h" /* libcurl rules enforcement */ 36 37 /* 38 * Define WIN32 when build target is Win32 API 39 */ 40 41 #if (defined(_WIN32) || defined(__WIN32__)) && \ 42 !defined(WIN32) && !defined(__SYMBIAN32__) 43 #define WIN32 44 #endif 45 46 #include <stdio.h> 47 #include <limits.h> 48 49 #if defined(__FreeBSD__) && (__FreeBSD__ >= 2) 50 /* Needed for __FreeBSD_version symbol definition */ 51 #include <osreldate.h> 52 #endif 53 54 /* The include stuff here below is mainly for time_t! */ 55 #include <sys/types.h> 56 #include <time.h> 57 58 #if defined(WIN32) && !defined(_WIN32_WCE) && !defined(__GNUC__) && \ 59 !defined(__CYGWIN__) || defined(__MINGW32__) 60 #if !(defined(_WINSOCKAPI_) || defined(_WINSOCK_H)) 61 /* The check above prevents the winsock2 inclusion if winsock.h already was 62 included, since they can't co-exist without problems */ 63 #include <winsock2.h> 64 #include <ws2tcpip.h> 65 #endif 66 #else 67 68 /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish 69 libc5-based Linux systems. Only include it on system that are known to 70 require it! */ 71 #if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \ 72 defined(__minix) || defined(__SYMBIAN32__) || defined(__INTEGRITY) || \ 73 defined(ANDROID) || \ 74 (defined(__FreeBSD_version) && (__FreeBSD_version < 800000)) 75 #include <sys/select.h> 76 #endif 77 78 #ifndef _WIN32_WCE 79 #include <sys/socket.h> 80 #endif 81 #if !defined(WIN32) && !defined(__WATCOMC__) && !defined(__VXWORKS__) 82 #include <sys/time.h> 83 #endif 84 #include <sys/types.h> 85 #endif 86 87 #ifdef __BEOS__ 88 #include <support/SupportDefs.h> 89 #endif 90 91 #ifdef __cplusplus 92 extern "C" { 93 #endif 94 95 typedef void CURL; 96 97 /* 98 * Decorate exportable functions for Win32 and Symbian OS DLL linking. 99 * This avoids using a .def file for building libcurl.dll. 100 */ 101 #if (defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__)) && \ 102 !defined(CURL_STATICLIB) 103 #if defined(BUILDING_LIBCURL) 104 #define CURL_EXTERN __declspec(dllexport) 105 #else 106 #define CURL_EXTERN __declspec(dllimport) 107 #endif 108 #else 109 110 #ifdef CURL_HIDDEN_SYMBOLS 111 /* 112 * This definition is used to make external definitions visible in the 113 * shared library when symbols are hidden by default. It makes no 114 * difference when compiling applications whether this is set or not, 115 * only when compiling the library. 116 */ 117 #define CURL_EXTERN CURL_EXTERN_SYMBOL 118 #else 119 #define CURL_EXTERN 120 #endif 121 #endif 122 123 #ifndef curl_socket_typedef 124 /* socket typedef */ 125 #ifdef WIN32 126 typedef SOCKET curl_socket_t; 127 #define CURL_SOCKET_BAD INVALID_SOCKET 128 #else 129 typedef int curl_socket_t; 130 #define CURL_SOCKET_BAD -1 131 #endif 132 #define curl_socket_typedef 133 #endif /* curl_socket_typedef */ 134 135 struct curl_httppost { 136 struct curl_httppost *next; /* next entry in the list */ 137 char *name; /* pointer to allocated name */ 138 long namelength; /* length of name length */ 139 char *contents; /* pointer to allocated data contents */ 140 long contentslength; /* length of contents field */ 141 char *buffer; /* pointer to allocated buffer contents */ 142 long bufferlength; /* length of buffer field */ 143 char *contenttype; /* Content-Type */ 144 struct curl_slist* contentheader; /* list of extra headers for this form */ 145 struct curl_httppost *more; /* if one field name has more than one 146 file, this link should link to following 147 files */ 148 long flags; /* as defined below */ 149 #define HTTPPOST_FILENAME (1<<0) /* specified content is a file name */ 150 #define HTTPPOST_READFILE (1<<1) /* specified content is a file name */ 151 #define HTTPPOST_PTRNAME (1<<2) /* name is only stored pointer 152 do not free in formfree */ 153 #define HTTPPOST_PTRCONTENTS (1<<3) /* contents is only stored pointer 154 do not free in formfree */ 155 #define HTTPPOST_BUFFER (1<<4) /* upload file from buffer */ 156 #define HTTPPOST_PTRBUFFER (1<<5) /* upload file from pointer contents */ 157 #define HTTPPOST_CALLBACK (1<<6) /* upload file contents by using the 158 regular read callback to get the data 159 and pass the given pointer as custom 160 pointer */ 161 162 char *showfilename; /* The file name to show. If not set, the 163 actual file name will be used (if this 164 is a file part) */ 165 void *userp; /* custom pointer used for 166 HTTPPOST_CALLBACK posts */ 167 }; 168 169 typedef int (*curl_progress_callback)(void *clientp, 170 double dltotal, 171 double dlnow, 172 double ultotal, 173 double ulnow); 174 175 #ifndef CURL_MAX_WRITE_SIZE 176 /* Tests have proven that 20K is a very bad buffer size for uploads on 177 Windows, while 16K for some odd reason performed a lot better. 178 We do the ifndef check to allow this value to easier be changed at build 179 time for those who feel adventurous. The practical minimum is about 180 400 bytes since libcurl uses a buffer of this size as a scratch area 181 (unrelated to network send operations). */ 182 #define CURL_MAX_WRITE_SIZE 16384 183 #endif 184 185 #ifndef CURL_MAX_HTTP_HEADER 186 /* The only reason to have a max limit for this is to avoid the risk of a bad 187 server feeding libcurl with a never-ending header that will cause reallocs 188 infinitely */ 189 #define CURL_MAX_HTTP_HEADER (100*1024) 190 #endif 191 192 193 /* This is a magic return code for the write callback that, when returned, 194 will signal libcurl to pause receiving on the current transfer. */ 195 #define CURL_WRITEFUNC_PAUSE 0x10000001 196 typedef size_t (*curl_write_callback)(char *buffer, 197 size_t size, 198 size_t nitems, 199 void *outstream); 200 201 202 203 /* enumeration of file types */ 204 typedef enum { 205 CURLFILETYPE_FILE = 0, 206 CURLFILETYPE_DIRECTORY, 207 CURLFILETYPE_SYMLINK, 208 CURLFILETYPE_DEVICE_BLOCK, 209 CURLFILETYPE_DEVICE_CHAR, 210 CURLFILETYPE_NAMEDPIPE, 211 CURLFILETYPE_SOCKET, 212 CURLFILETYPE_DOOR, /* is possible only on Sun Solaris now */ 213 214 CURLFILETYPE_UNKNOWN /* should never occur */ 215 } curlfiletype; 216 217 #define CURLFINFOFLAG_KNOWN_FILENAME (1<<0) 218 #define CURLFINFOFLAG_KNOWN_FILETYPE (1<<1) 219 #define CURLFINFOFLAG_KNOWN_TIME (1<<2) 220 #define CURLFINFOFLAG_KNOWN_PERM (1<<3) 221 #define CURLFINFOFLAG_KNOWN_UID (1<<4) 222 #define CURLFINFOFLAG_KNOWN_GID (1<<5) 223 #define CURLFINFOFLAG_KNOWN_SIZE (1<<6) 224 #define CURLFINFOFLAG_KNOWN_HLINKCOUNT (1<<7) 225 226 /* Content of this structure depends on information which is known and is 227 achievable (e.g. by FTP LIST parsing). Please see the url_easy_setopt(3) man 228 page for callbacks returning this structure -- some fields are mandatory, 229 some others are optional. The FLAG field has special meaning. */ 230 struct curl_fileinfo { 231 char *filename; 232 curlfiletype filetype; 233 time_t time; 234 unsigned int perm; 235 int uid; 236 int gid; 237 curl_off_t size; 238 long int hardlinks; 239 240 struct { 241 /* If some of these fields is not NULL, it is a pointer to b_data. */ 242 char *time; 243 char *perm; 244 char *user; 245 char *group; 246 char *target; /* pointer to the target filename of a symlink */ 247 } strings; 248 249 unsigned int flags; 250 251 /* used internally */ 252 char * b_data; 253 size_t b_size; 254 size_t b_used; 255 }; 256 257 /* return codes for CURLOPT_CHUNK_BGN_FUNCTION */ 258 #define CURL_CHUNK_BGN_FUNC_OK 0 259 #define CURL_CHUNK_BGN_FUNC_FAIL 1 /* tell the lib to end the task */ 260 #define CURL_CHUNK_BGN_FUNC_SKIP 2 /* skip this chunk over */ 261 262 /* if splitting of data transfer is enabled, this callback is called before 263 download of an individual chunk started. Note that parameter "remains" works 264 only for FTP wildcard downloading (for now), otherwise is not used */ 265 typedef long (*curl_chunk_bgn_callback)(const void *transfer_info, 266 void *ptr, 267 int remains); 268 269 /* return codes for CURLOPT_CHUNK_END_FUNCTION */ 270 #define CURL_CHUNK_END_FUNC_OK 0 271 #define CURL_CHUNK_END_FUNC_FAIL 1 /* tell the lib to end the task */ 272 273 /* If splitting of data transfer is enabled this callback is called after 274 download of an individual chunk finished. 275 Note! After this callback was set then it have to be called FOR ALL chunks. 276 Even if downloading of this chunk was skipped in CHUNK_BGN_FUNC. 277 This is the reason why we don't need "transfer_info" parameter in this 278 callback and we are not interested in "remains" parameter too. */ 279 typedef long (*curl_chunk_end_callback)(void *ptr); 280 281 /* return codes for FNMATCHFUNCTION */ 282 #define CURL_FNMATCHFUNC_MATCH 0 /* string corresponds to the pattern */ 283 #define CURL_FNMATCHFUNC_NOMATCH 1 /* pattern doesn't match the string */ 284 #define CURL_FNMATCHFUNC_FAIL 2 /* an error occurred */ 285 286 /* callback type for wildcard downloading pattern matching. If the 287 string matches the pattern, return CURL_FNMATCHFUNC_MATCH value, etc. */ 288 typedef int (*curl_fnmatch_callback)(void *ptr, 289 const char *pattern, 290 const char *string); 291 292 /* These are the return codes for the seek callbacks */ 293 #define CURL_SEEKFUNC_OK 0 294 #define CURL_SEEKFUNC_FAIL 1 /* fail the entire transfer */ 295 #define CURL_SEEKFUNC_CANTSEEK 2 /* tell libcurl seeking can't be done, so 296 libcurl might try other means instead */ 297 typedef int (*curl_seek_callback)(void *instream, 298 curl_off_t offset, 299 int origin); /* 'whence' */ 300 301 /* This is a return code for the read callback that, when returned, will 302 signal libcurl to immediately abort the current transfer. */ 303 #define CURL_READFUNC_ABORT 0x10000000 304 /* This is a return code for the read callback that, when returned, will 305 signal libcurl to pause sending data on the current transfer. */ 306 #define CURL_READFUNC_PAUSE 0x10000001 307 308 typedef size_t (*curl_read_callback)(char *buffer, 309 size_t size, 310 size_t nitems, 311 void *instream); 312 313 typedef enum { 314 CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */ 315 CURLSOCKTYPE_LAST /* never use */ 316 } curlsocktype; 317 318 /* The return code from the sockopt_callback can signal information back 319 to libcurl: */ 320 #define CURL_SOCKOPT_OK 0 321 #define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return 322 CURLE_ABORTED_BY_CALLBACK */ 323 #define CURL_SOCKOPT_ALREADY_CONNECTED 2 324 325 typedef int (*curl_sockopt_callback)(void *clientp, 326 curl_socket_t curlfd, 327 curlsocktype purpose); 328 329 struct curl_sockaddr { 330 int family; 331 int socktype; 332 int protocol; 333 unsigned int addrlen; /* addrlen was a socklen_t type before 7.18.0 but it 334 turned really ugly and painful on the systems that 335 lack this type */ 336 struct sockaddr addr; 337 }; 338 339 typedef curl_socket_t 340 (*curl_opensocket_callback)(void *clientp, 341 curlsocktype purpose, 342 struct curl_sockaddr *address); 343 344 typedef enum { 345 CURLIOE_OK, /* I/O operation successful */ 346 CURLIOE_UNKNOWNCMD, /* command was unknown to callback */ 347 CURLIOE_FAILRESTART, /* failed to restart the read */ 348 CURLIOE_LAST /* never use */ 349 } curlioerr; 350 351 typedef enum { 352 CURLIOCMD_NOP, /* no operation */ 353 CURLIOCMD_RESTARTREAD, /* restart the read stream from start */ 354 CURLIOCMD_LAST /* never use */ 355 } curliocmd; 356 357 typedef curlioerr (*curl_ioctl_callback)(CURL *handle, 358 int cmd, 359 void *clientp); 360 361 /* 362 * The following typedef's are signatures of malloc, free, realloc, strdup and 363 * calloc respectively. Function pointers of these types can be passed to the 364 * curl_global_init_mem() function to set user defined memory management 365 * callback routines. 366 */ 367 typedef void *(*curl_malloc_callback)(size_t size); 368 typedef void (*curl_free_callback)(void *ptr); 369 typedef void *(*curl_realloc_callback)(void *ptr, size_t size); 370 typedef char *(*curl_strdup_callback)(const char *str); 371 typedef void *(*curl_calloc_callback)(size_t nmemb, size_t size); 372 373 /* the kind of data that is passed to information_callback*/ 374 typedef enum { 375 CURLINFO_TEXT = 0, 376 CURLINFO_HEADER_IN, /* 1 */ 377 CURLINFO_HEADER_OUT, /* 2 */ 378 CURLINFO_DATA_IN, /* 3 */ 379 CURLINFO_DATA_OUT, /* 4 */ 380 CURLINFO_SSL_DATA_IN, /* 5 */ 381 CURLINFO_SSL_DATA_OUT, /* 6 */ 382 CURLINFO_END 383 } curl_infotype; 384 385 typedef int (*curl_debug_callback) 386 (CURL *handle, /* the handle/transfer this concerns */ 387 curl_infotype type, /* what kind of data */ 388 char *data, /* points to the data */ 389 size_t size, /* size of the data pointed to */ 390 void *userptr); /* whatever the user please */ 391 392 /* All possible error codes from all sorts of curl functions. Future versions 393 may return other values, stay prepared. 394 395 Always add new return codes last. Never *EVER* remove any. The return 396 codes must remain the same! 397 */ 398 399 typedef enum { 400 CURLE_OK = 0, 401 CURLE_UNSUPPORTED_PROTOCOL, /* 1 */ 402 CURLE_FAILED_INIT, /* 2 */ 403 CURLE_URL_MALFORMAT, /* 3 */ 404 CURLE_NOT_BUILT_IN, /* 4 - [was obsoleted in August 2007 for 405 7.17.0, reused in April 2011 for 7.21.5] */ 406 CURLE_COULDNT_RESOLVE_PROXY, /* 5 */ 407 CURLE_COULDNT_RESOLVE_HOST, /* 6 */ 408 CURLE_COULDNT_CONNECT, /* 7 */ 409 CURLE_FTP_WEIRD_SERVER_REPLY, /* 8 */ 410 CURLE_REMOTE_ACCESS_DENIED, /* 9 a service was denied by the server 411 due to lack of access - when login fails 412 this is not returned. */ 413 CURLE_OBSOLETE10, /* 10 - NOT USED */ 414 CURLE_FTP_WEIRD_PASS_REPLY, /* 11 */ 415 CURLE_OBSOLETE12, /* 12 - NOT USED */ 416 CURLE_FTP_WEIRD_PASV_REPLY, /* 13 */ 417 CURLE_FTP_WEIRD_227_FORMAT, /* 14 */ 418 CURLE_FTP_CANT_GET_HOST, /* 15 */ 419 CURLE_OBSOLETE16, /* 16 - NOT USED */ 420 CURLE_FTP_COULDNT_SET_TYPE, /* 17 */ 421 CURLE_PARTIAL_FILE, /* 18 */ 422 CURLE_FTP_COULDNT_RETR_FILE, /* 19 */ 423 CURLE_OBSOLETE20, /* 20 - NOT USED */ 424 CURLE_QUOTE_ERROR, /* 21 - quote command failure */ 425 CURLE_HTTP_RETURNED_ERROR, /* 22 */ 426 CURLE_WRITE_ERROR, /* 23 */ 427 CURLE_OBSOLETE24, /* 24 - NOT USED */ 428 CURLE_UPLOAD_FAILED, /* 25 - failed upload "command" */ 429 CURLE_READ_ERROR, /* 26 - couldn't open/read from file */ 430 CURLE_OUT_OF_MEMORY, /* 27 */ 431 /* Note: CURLE_OUT_OF_MEMORY may sometimes indicate a conversion error 432 instead of a memory allocation error if CURL_DOES_CONVERSIONS 433 is defined 434 */ 435 CURLE_OPERATION_TIMEDOUT, /* 28 - the timeout time was reached */ 436 CURLE_OBSOLETE29, /* 29 - NOT USED */ 437 CURLE_FTP_PORT_FAILED, /* 30 - FTP PORT operation failed */ 438 CURLE_FTP_COULDNT_USE_REST, /* 31 - the REST command failed */ 439 CURLE_OBSOLETE32, /* 32 - NOT USED */ 440 CURLE_RANGE_ERROR, /* 33 - RANGE "command" didn't work */ 441 CURLE_HTTP_POST_ERROR, /* 34 */ 442 CURLE_SSL_CONNECT_ERROR, /* 35 - wrong when connecting with SSL */ 443 CURLE_BAD_DOWNLOAD_RESUME, /* 36 - couldn't resume download */ 444 CURLE_FILE_COULDNT_READ_FILE, /* 37 */ 445 CURLE_LDAP_CANNOT_BIND, /* 38 */ 446 CURLE_LDAP_SEARCH_FAILED, /* 39 */ 447 CURLE_OBSOLETE40, /* 40 - NOT USED */ 448 CURLE_FUNCTION_NOT_FOUND, /* 41 */ 449 CURLE_ABORTED_BY_CALLBACK, /* 42 */ 450 CURLE_BAD_FUNCTION_ARGUMENT, /* 43 */ 451 CURLE_OBSOLETE44, /* 44 - NOT USED */ 452 CURLE_INTERFACE_FAILED, /* 45 - CURLOPT_INTERFACE failed */ 453 CURLE_OBSOLETE46, /* 46 - NOT USED */ 454 CURLE_TOO_MANY_REDIRECTS , /* 47 - catch endless re-direct loops */ 455 CURLE_UNKNOWN_OPTION, /* 48 - User specified an unknown option */ 456 CURLE_TELNET_OPTION_SYNTAX , /* 49 - Malformed telnet option */ 457 CURLE_OBSOLETE50, /* 50 - NOT USED */ 458 CURLE_PEER_FAILED_VERIFICATION, /* 51 - peer's certificate or fingerprint 459 wasn't verified fine */ 460 CURLE_GOT_NOTHING, /* 52 - when this is a specific error */ 461 CURLE_SSL_ENGINE_NOTFOUND, /* 53 - SSL crypto engine not found */ 462 CURLE_SSL_ENGINE_SETFAILED, /* 54 - can not set SSL crypto engine as 463 default */ 464 CURLE_SEND_ERROR, /* 55 - failed sending network data */ 465 CURLE_RECV_ERROR, /* 56 - failure in receiving network data */ 466 CURLE_OBSOLETE57, /* 57 - NOT IN USE */ 467 CURLE_SSL_CERTPROBLEM, /* 58 - problem with the local certificate */ 468 CURLE_SSL_CIPHER, /* 59 - couldn't use specified cipher */ 469 CURLE_SSL_CACERT, /* 60 - problem with the CA cert (path?) */ 470 CURLE_BAD_CONTENT_ENCODING, /* 61 - Unrecognized/bad encoding */ 471 CURLE_LDAP_INVALID_URL, /* 62 - Invalid LDAP URL */ 472 CURLE_FILESIZE_EXCEEDED, /* 63 - Maximum file size exceeded */ 473 CURLE_USE_SSL_FAILED, /* 64 - Requested FTP SSL level failed */ 474 CURLE_SEND_FAIL_REWIND, /* 65 - Sending the data requires a rewind 475 that failed */ 476 CURLE_SSL_ENGINE_INITFAILED, /* 66 - failed to initialise ENGINE */ 477 CURLE_LOGIN_DENIED, /* 67 - user, password or similar was not 478 accepted and we failed to login */ 479 CURLE_TFTP_NOTFOUND, /* 68 - file not found on server */ 480 CURLE_TFTP_PERM, /* 69 - permission problem on server */ 481 CURLE_REMOTE_DISK_FULL, /* 70 - out of disk space on server */ 482 CURLE_TFTP_ILLEGAL, /* 71 - Illegal TFTP operation */ 483 CURLE_TFTP_UNKNOWNID, /* 72 - Unknown transfer ID */ 484 CURLE_REMOTE_FILE_EXISTS, /* 73 - File already exists */ 485 CURLE_TFTP_NOSUCHUSER, /* 74 - No such user */ 486 CURLE_CONV_FAILED, /* 75 - conversion failed */ 487 CURLE_CONV_REQD, /* 76 - caller must register conversion 488 callbacks using curl_easy_setopt options 489 CURLOPT_CONV_FROM_NETWORK_FUNCTION, 490 CURLOPT_CONV_TO_NETWORK_FUNCTION, and 491 CURLOPT_CONV_FROM_UTF8_FUNCTION */ 492 CURLE_SSL_CACERT_BADFILE, /* 77 - could not load CACERT file, missing 493 or wrong format */ 494 CURLE_REMOTE_FILE_NOT_FOUND, /* 78 - remote file not found */ 495 CURLE_SSH, /* 79 - error from the SSH layer, somewhat 496 generic so the error message will be of 497 interest when this has happened */ 498 499 CURLE_SSL_SHUTDOWN_FAILED, /* 80 - Failed to shut down the SSL 500 connection */ 501 CURLE_AGAIN, /* 81 - socket is not ready for send/recv, 502 wait till it's ready and try again (Added 503 in 7.18.2) */ 504 CURLE_SSL_CRL_BADFILE, /* 82 - could not load CRL file, missing or 505 wrong format (Added in 7.19.0) */ 506 CURLE_SSL_ISSUER_ERROR, /* 83 - Issuer check failed. (Added in 507 7.19.0) */ 508 CURLE_FTP_PRET_FAILED, /* 84 - a PRET command failed */ 509 CURLE_RTSP_CSEQ_ERROR, /* 85 - mismatch of RTSP CSeq numbers */ 510 CURLE_RTSP_SESSION_ERROR, /* 86 - mismatch of RTSP Session Identifiers */ 511 CURLE_FTP_BAD_FILE_LIST, /* 87 - unable to parse FTP file list */ 512 CURLE_CHUNK_FAILED, /* 88 - chunk callback reported error */ 513 514 CURL_LAST /* never use! */ 515 } CURLcode; 516 517 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 518 the obsolete stuff removed! */ 519 520 /* compatibility with older names */ 521 #define CURLOPT_ENCODING CURLOPT_ACCEPT_ENCODING 522 523 /* The following were added in 7.21.5, April 2011 */ 524 #define CURLE_UNKNOWN_TELNET_OPTION CURLE_UNKNOWN_OPTION 525 526 /* The following were added in 7.17.1 */ 527 /* These are scheduled to disappear by 2009 */ 528 #define CURLE_SSL_PEER_CERTIFICATE CURLE_PEER_FAILED_VERIFICATION 529 530 /* The following were added in 7.17.0 */ 531 /* These are scheduled to disappear by 2009 */ 532 #define CURLE_OBSOLETE CURLE_OBSOLETE50 /* no one should be using this! */ 533 #define CURLE_BAD_PASSWORD_ENTERED CURLE_OBSOLETE46 534 #define CURLE_BAD_CALLING_ORDER CURLE_OBSOLETE44 535 #define CURLE_FTP_USER_PASSWORD_INCORRECT CURLE_OBSOLETE10 536 #define CURLE_FTP_CANT_RECONNECT CURLE_OBSOLETE16 537 #define CURLE_FTP_COULDNT_GET_SIZE CURLE_OBSOLETE32 538 #define CURLE_FTP_COULDNT_SET_ASCII CURLE_OBSOLETE29 539 #define CURLE_FTP_WEIRD_USER_REPLY CURLE_OBSOLETE12 540 #define CURLE_FTP_WRITE_ERROR CURLE_OBSOLETE20 541 #define CURLE_LIBRARY_NOT_FOUND CURLE_OBSOLETE40 542 #define CURLE_MALFORMAT_USER CURLE_OBSOLETE24 543 #define CURLE_SHARE_IN_USE CURLE_OBSOLETE57 544 #define CURLE_URL_MALFORMAT_USER CURLE_NOT_BUILT_IN 545 546 #define CURLE_FTP_ACCESS_DENIED CURLE_REMOTE_ACCESS_DENIED 547 #define CURLE_FTP_COULDNT_SET_BINARY CURLE_FTP_COULDNT_SET_TYPE 548 #define CURLE_FTP_QUOTE_ERROR CURLE_QUOTE_ERROR 549 #define CURLE_TFTP_DISKFULL CURLE_REMOTE_DISK_FULL 550 #define CURLE_TFTP_EXISTS CURLE_REMOTE_FILE_EXISTS 551 #define CURLE_HTTP_RANGE_ERROR CURLE_RANGE_ERROR 552 #define CURLE_FTP_SSL_FAILED CURLE_USE_SSL_FAILED 553 554 /* The following were added earlier */ 555 556 #define CURLE_OPERATION_TIMEOUTED CURLE_OPERATION_TIMEDOUT 557 558 #define CURLE_HTTP_NOT_FOUND CURLE_HTTP_RETURNED_ERROR 559 #define CURLE_HTTP_PORT_FAILED CURLE_INTERFACE_FAILED 560 #define CURLE_FTP_COULDNT_STOR_FILE CURLE_UPLOAD_FAILED 561 562 #define CURLE_FTP_PARTIAL_FILE CURLE_PARTIAL_FILE 563 #define CURLE_FTP_BAD_DOWNLOAD_RESUME CURLE_BAD_DOWNLOAD_RESUME 564 565 /* This was the error code 50 in 7.7.3 and a few earlier versions, this 566 is no longer used by libcurl but is instead #defined here only to not 567 make programs break */ 568 #define CURLE_ALREADY_COMPLETE 99999 569 570 #endif /*!CURL_NO_OLDIES*/ 571 572 /* This prototype applies to all conversion callbacks */ 573 typedef CURLcode (*curl_conv_callback)(char *buffer, size_t length); 574 575 typedef CURLcode (*curl_ssl_ctx_callback)(CURL *curl, /* easy handle */ 576 void *ssl_ctx, /* actually an 577 OpenSSL SSL_CTX */ 578 void *userptr); 579 580 typedef enum { 581 CURLPROXY_HTTP = 0, /* added in 7.10, new in 7.19.4 default is to use 582 CONNECT HTTP/1.1 */ 583 CURLPROXY_HTTP_1_0 = 1, /* added in 7.19.4, force to use CONNECT 584 HTTP/1.0 */ 585 CURLPROXY_SOCKS4 = 4, /* support added in 7.15.2, enum existed already 586 in 7.10 */ 587 CURLPROXY_SOCKS5 = 5, /* added in 7.10 */ 588 CURLPROXY_SOCKS4A = 6, /* added in 7.18.0 */ 589 CURLPROXY_SOCKS5_HOSTNAME = 7 /* Use the SOCKS5 protocol but pass along the 590 host name rather than the IP address. added 591 in 7.18.0 */ 592 } curl_proxytype; /* this enum was added in 7.10 */ 593 594 #define CURLAUTH_NONE 0 /* nothing */ 595 #define CURLAUTH_BASIC (1<<0) /* Basic (default) */ 596 #define CURLAUTH_DIGEST (1<<1) /* Digest */ 597 #define CURLAUTH_GSSNEGOTIATE (1<<2) /* GSS-Negotiate */ 598 #define CURLAUTH_NTLM (1<<3) /* NTLM */ 599 #define CURLAUTH_DIGEST_IE (1<<4) /* Digest with IE flavour */ 600 #define CURLAUTH_ONLY (1<<31) /* used together with a single other 601 type to force no auth or just that 602 single type */ 603 #define CURLAUTH_ANY (~CURLAUTH_DIGEST_IE) /* all fine types set */ 604 #define CURLAUTH_ANYSAFE (~(CURLAUTH_BASIC|CURLAUTH_DIGEST_IE)) 605 606 #define CURLSSH_AUTH_ANY ~0 /* all types supported by the server */ 607 #define CURLSSH_AUTH_NONE 0 /* none allowed, silly but complete */ 608 #define CURLSSH_AUTH_PUBLICKEY (1<<0) /* public/private key files */ 609 #define CURLSSH_AUTH_PASSWORD (1<<1) /* password */ 610 #define CURLSSH_AUTH_HOST (1<<2) /* host key files */ 611 #define CURLSSH_AUTH_KEYBOARD (1<<3) /* keyboard interactive */ 612 #define CURLSSH_AUTH_DEFAULT CURLSSH_AUTH_ANY 613 614 #define CURL_ERROR_SIZE 256 615 616 struct curl_khkey { 617 const char *key; /* points to a zero-terminated string encoded with base64 618 if len is zero, otherwise to the "raw" data */ 619 size_t len; 620 enum type { 621 CURLKHTYPE_UNKNOWN, 622 CURLKHTYPE_RSA1, 623 CURLKHTYPE_RSA, 624 CURLKHTYPE_DSS 625 } keytype; 626 }; 627 628 /* this is the set of return values expected from the curl_sshkeycallback 629 callback */ 630 enum curl_khstat { 631 CURLKHSTAT_FINE_ADD_TO_FILE, 632 CURLKHSTAT_FINE, 633 CURLKHSTAT_REJECT, /* reject the connection, return an error */ 634 CURLKHSTAT_DEFER, /* do not accept it, but we can't answer right now so 635 this causes a CURLE_DEFER error but otherwise the 636 connection will be left intact etc */ 637 CURLKHSTAT_LAST /* not for use, only a marker for last-in-list */ 638 }; 639 640 /* this is the set of status codes pass in to the callback */ 641 enum curl_khmatch { 642 CURLKHMATCH_OK, /* match */ 643 CURLKHMATCH_MISMATCH, /* host found, key mismatch! */ 644 CURLKHMATCH_MISSING, /* no matching host/key found */ 645 CURLKHMATCH_LAST /* not for use, only a marker for last-in-list */ 646 }; 647 648 typedef int 649 (*curl_sshkeycallback) (CURL *easy, /* easy handle */ 650 const struct curl_khkey *knownkey, /* known */ 651 const struct curl_khkey *foundkey, /* found */ 652 enum curl_khmatch, /* libcurl's view on the keys */ 653 void *clientp); /* custom pointer passed from app */ 654 655 /* parameter for the CURLOPT_USE_SSL option */ 656 typedef enum { 657 CURLUSESSL_NONE, /* do not attempt to use SSL */ 658 CURLUSESSL_TRY, /* try using SSL, proceed anyway otherwise */ 659 CURLUSESSL_CONTROL, /* SSL for the control connection or fail */ 660 CURLUSESSL_ALL, /* SSL for all communication or fail */ 661 CURLUSESSL_LAST /* not an option, never use */ 662 } curl_usessl; 663 664 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 665 the obsolete stuff removed! */ 666 667 /* Backwards compatibility with older names */ 668 /* These are scheduled to disappear by 2009 */ 669 670 #define CURLFTPSSL_NONE CURLUSESSL_NONE 671 #define CURLFTPSSL_TRY CURLUSESSL_TRY 672 #define CURLFTPSSL_CONTROL CURLUSESSL_CONTROL 673 #define CURLFTPSSL_ALL CURLUSESSL_ALL 674 #define CURLFTPSSL_LAST CURLUSESSL_LAST 675 #define curl_ftpssl curl_usessl 676 #endif /*!CURL_NO_OLDIES*/ 677 678 /* parameter for the CURLOPT_FTP_SSL_CCC option */ 679 typedef enum { 680 CURLFTPSSL_CCC_NONE, /* do not send CCC */ 681 CURLFTPSSL_CCC_PASSIVE, /* Let the server initiate the shutdown */ 682 CURLFTPSSL_CCC_ACTIVE, /* Initiate the shutdown */ 683 CURLFTPSSL_CCC_LAST /* not an option, never use */ 684 } curl_ftpccc; 685 686 /* parameter for the CURLOPT_FTPSSLAUTH option */ 687 typedef enum { 688 CURLFTPAUTH_DEFAULT, /* let libcurl decide */ 689 CURLFTPAUTH_SSL, /* use "AUTH SSL" */ 690 CURLFTPAUTH_TLS, /* use "AUTH TLS" */ 691 CURLFTPAUTH_LAST /* not an option, never use */ 692 } curl_ftpauth; 693 694 /* parameter for the CURLOPT_FTP_CREATE_MISSING_DIRS option */ 695 typedef enum { 696 CURLFTP_CREATE_DIR_NONE, /* do NOT create missing dirs! */ 697 CURLFTP_CREATE_DIR, /* (FTP/SFTP) if CWD fails, try MKD and then CWD 698 again if MKD succeeded, for SFTP this does 699 similar magic */ 700 CURLFTP_CREATE_DIR_RETRY, /* (FTP only) if CWD fails, try MKD and then CWD 701 again even if MKD failed! */ 702 CURLFTP_CREATE_DIR_LAST /* not an option, never use */ 703 } curl_ftpcreatedir; 704 705 /* parameter for the CURLOPT_FTP_FILEMETHOD option */ 706 typedef enum { 707 CURLFTPMETHOD_DEFAULT, /* let libcurl pick */ 708 CURLFTPMETHOD_MULTICWD, /* single CWD operation for each path part */ 709 CURLFTPMETHOD_NOCWD, /* no CWD at all */ 710 CURLFTPMETHOD_SINGLECWD, /* one CWD to full dir, then work on file */ 711 CURLFTPMETHOD_LAST /* not an option, never use */ 712 } curl_ftpmethod; 713 714 /* CURLPROTO_ defines are for the CURLOPT_*PROTOCOLS options */ 715 #define CURLPROTO_HTTP (1<<0) 716 #define CURLPROTO_HTTPS (1<<1) 717 #define CURLPROTO_FTP (1<<2) 718 #define CURLPROTO_FTPS (1<<3) 719 #define CURLPROTO_SCP (1<<4) 720 #define CURLPROTO_SFTP (1<<5) 721 #define CURLPROTO_TELNET (1<<6) 722 #define CURLPROTO_LDAP (1<<7) 723 #define CURLPROTO_LDAPS (1<<8) 724 #define CURLPROTO_DICT (1<<9) 725 #define CURLPROTO_FILE (1<<10) 726 #define CURLPROTO_TFTP (1<<11) 727 #define CURLPROTO_IMAP (1<<12) 728 #define CURLPROTO_IMAPS (1<<13) 729 #define CURLPROTO_POP3 (1<<14) 730 #define CURLPROTO_POP3S (1<<15) 731 #define CURLPROTO_SMTP (1<<16) 732 #define CURLPROTO_SMTPS (1<<17) 733 #define CURLPROTO_RTSP (1<<18) 734 #define CURLPROTO_RTMP (1<<19) 735 #define CURLPROTO_RTMPT (1<<20) 736 #define CURLPROTO_RTMPE (1<<21) 737 #define CURLPROTO_RTMPTE (1<<22) 738 #define CURLPROTO_RTMPS (1<<23) 739 #define CURLPROTO_RTMPTS (1<<24) 740 #define CURLPROTO_GOPHER (1<<25) 741 #define CURLPROTO_ALL (~0) /* enable everything */ 742 743 /* long may be 32 or 64 bits, but we should never depend on anything else 744 but 32 */ 745 #define CURLOPTTYPE_LONG 0 746 #define CURLOPTTYPE_OBJECTPOINT 10000 747 #define CURLOPTTYPE_FUNCTIONPOINT 20000 748 #define CURLOPTTYPE_OFF_T 30000 749 750 /* name is uppercase CURLOPT_<name>, 751 type is one of the defined CURLOPTTYPE_<type> 752 number is unique identifier */ 753 #ifdef CINIT 754 #undef CINIT 755 #endif 756 757 #ifdef CURL_ISOCPP 758 #define CINIT(name,type,number) CURLOPT_ ## name = CURLOPTTYPE_ ## type + number 759 #else 760 /* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */ 761 #define LONG CURLOPTTYPE_LONG 762 #define OBJECTPOINT CURLOPTTYPE_OBJECTPOINT 763 #define FUNCTIONPOINT CURLOPTTYPE_FUNCTIONPOINT 764 #define OFF_T CURLOPTTYPE_OFF_T 765 #define CINIT(name,type,number) CURLOPT_/**/name = type + number 766 #endif 767 768 /* 769 * This macro-mania below setups the CURLOPT_[what] enum, to be used with 770 * curl_easy_setopt(). The first argument in the CINIT() macro is the [what] 771 * word. 772 */ 773 774 typedef enum { 775 /* This is the FILE * or void * the regular output should be written to. */ 776 CINIT(FILE, OBJECTPOINT, 1), 777 778 /* The full URL to get/put */ 779 CINIT(URL, OBJECTPOINT, 2), 780 781 /* Port number to connect to, if other than default. */ 782 CINIT(PORT, LONG, 3), 783 784 /* Name of proxy to use. */ 785 CINIT(PROXY, OBJECTPOINT, 4), 786 787 /* "name:password" to use when fetching. */ 788 CINIT(USERPWD, OBJECTPOINT, 5), 789 790 /* "name:password" to use with proxy. */ 791 CINIT(PROXYUSERPWD, OBJECTPOINT, 6), 792 793 /* Range to get, specified as an ASCII string. */ 794 CINIT(RANGE, OBJECTPOINT, 7), 795 796 /* not used */ 797 798 /* Specified file stream to upload from (use as input): */ 799 CINIT(INFILE, OBJECTPOINT, 9), 800 801 /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE 802 * bytes big. If this is not used, error messages go to stderr instead: */ 803 CINIT(ERRORBUFFER, OBJECTPOINT, 10), 804 805 /* Function that will be called to store the output (instead of fwrite). The 806 * parameters will use fwrite() syntax, make sure to follow them. */ 807 CINIT(WRITEFUNCTION, FUNCTIONPOINT, 11), 808 809 /* Function that will be called to read the input (instead of fread). The 810 * parameters will use fread() syntax, make sure to follow them. */ 811 CINIT(READFUNCTION, FUNCTIONPOINT, 12), 812 813 /* Time-out the read operation after this amount of seconds */ 814 CINIT(TIMEOUT, LONG, 13), 815 816 /* If the CURLOPT_INFILE is used, this can be used to inform libcurl about 817 * how large the file being sent really is. That allows better error 818 * checking and better verifies that the upload was successful. -1 means 819 * unknown size. 820 * 821 * For large file support, there is also a _LARGE version of the key 822 * which takes an off_t type, allowing platforms with larger off_t 823 * sizes to handle larger files. See below for INFILESIZE_LARGE. 824 */ 825 CINIT(INFILESIZE, LONG, 14), 826 827 /* POST static input fields. */ 828 CINIT(POSTFIELDS, OBJECTPOINT, 15), 829 830 /* Set the referrer page (needed by some CGIs) */ 831 CINIT(REFERER, OBJECTPOINT, 16), 832 833 /* Set the FTP PORT string (interface name, named or numerical IP address) 834 Use i.e '-' to use default address. */ 835 CINIT(FTPPORT, OBJECTPOINT, 17), 836 837 /* Set the User-Agent string (examined by some CGIs) */ 838 CINIT(USERAGENT, OBJECTPOINT, 18), 839 840 /* If the download receives less than "low speed limit" bytes/second 841 * during "low speed time" seconds, the operations is aborted. 842 * You could i.e if you have a pretty high speed connection, abort if 843 * it is less than 2000 bytes/sec during 20 seconds. 844 */ 845 846 /* Set the "low speed limit" */ 847 CINIT(LOW_SPEED_LIMIT, LONG, 19), 848 849 /* Set the "low speed time" */ 850 CINIT(LOW_SPEED_TIME, LONG, 20), 851 852 /* Set the continuation offset. 853 * 854 * Note there is also a _LARGE version of this key which uses 855 * off_t types, allowing for large file offsets on platforms which 856 * use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE. 857 */ 858 CINIT(RESUME_FROM, LONG, 21), 859 860 /* Set cookie in request: */ 861 CINIT(COOKIE, OBJECTPOINT, 22), 862 863 /* This points to a linked list of headers, struct curl_slist kind */ 864 CINIT(HTTPHEADER, OBJECTPOINT, 23), 865 866 /* This points to a linked list of post entries, struct curl_httppost */ 867 CINIT(HTTPPOST, OBJECTPOINT, 24), 868 869 /* name of the file keeping your private SSL-certificate */ 870 CINIT(SSLCERT, OBJECTPOINT, 25), 871 872 /* password for the SSL or SSH private key */ 873 CINIT(KEYPASSWD, OBJECTPOINT, 26), 874 875 /* send TYPE parameter? */ 876 CINIT(CRLF, LONG, 27), 877 878 /* send linked-list of QUOTE commands */ 879 CINIT(QUOTE, OBJECTPOINT, 28), 880 881 /* send FILE * or void * to store headers to, if you use a callback it 882 is simply passed to the callback unmodified */ 883 CINIT(WRITEHEADER, OBJECTPOINT, 29), 884 885 /* point to a file to read the initial cookies from, also enables 886 "cookie awareness" */ 887 CINIT(COOKIEFILE, OBJECTPOINT, 31), 888 889 /* What version to specifically try to use. 890 See CURL_SSLVERSION defines below. */ 891 CINIT(SSLVERSION, LONG, 32), 892 893 /* What kind of HTTP time condition to use, see defines */ 894 CINIT(TIMECONDITION, LONG, 33), 895 896 /* Time to use with the above condition. Specified in number of seconds 897 since 1 Jan 1970 */ 898 CINIT(TIMEVALUE, LONG, 34), 899 900 /* 35 = OBSOLETE */ 901 902 /* Custom request, for customizing the get command like 903 HTTP: DELETE, TRACE and others 904 FTP: to use a different list command 905 */ 906 CINIT(CUSTOMREQUEST, OBJECTPOINT, 36), 907 908 /* HTTP request, for odd commands like DELETE, TRACE and others */ 909 CINIT(STDERR, OBJECTPOINT, 37), 910 911 /* 38 is not used */ 912 913 /* send linked-list of post-transfer QUOTE commands */ 914 CINIT(POSTQUOTE, OBJECTPOINT, 39), 915 916 /* Pass a pointer to string of the output using full variable-replacement 917 as described elsewhere. */ 918 CINIT(WRITEINFO, OBJECTPOINT, 40), 919 920 CINIT(VERBOSE, LONG, 41), /* talk a lot */ 921 CINIT(HEADER, LONG, 42), /* throw the header out too */ 922 CINIT(NOPROGRESS, LONG, 43), /* shut off the progress meter */ 923 CINIT(NOBODY, LONG, 44), /* use HEAD to get http document */ 924 CINIT(FAILONERROR, LONG, 45), /* no output on http error codes >= 300 */ 925 CINIT(UPLOAD, LONG, 46), /* this is an upload */ 926 CINIT(POST, LONG, 47), /* HTTP POST method */ 927 CINIT(DIRLISTONLY, LONG, 48), /* return bare names when listing directories */ 928 929 CINIT(APPEND, LONG, 50), /* Append instead of overwrite on upload! */ 930 931 /* Specify whether to read the user+password from the .netrc or the URL. 932 * This must be one of the CURL_NETRC_* enums below. */ 933 CINIT(NETRC, LONG, 51), 934 935 CINIT(FOLLOWLOCATION, LONG, 52), /* use Location: Luke! */ 936 937 CINIT(TRANSFERTEXT, LONG, 53), /* transfer data in text/ASCII format */ 938 CINIT(PUT, LONG, 54), /* HTTP PUT */ 939 940 /* 55 = OBSOLETE */ 941 942 /* Function that will be called instead of the internal progress display 943 * function. This function should be defined as the curl_progress_callback 944 * prototype defines. */ 945 CINIT(PROGRESSFUNCTION, FUNCTIONPOINT, 56), 946 947 /* Data passed to the progress callback */ 948 CINIT(PROGRESSDATA, OBJECTPOINT, 57), 949 950 /* We want the referrer field set automatically when following locations */ 951 CINIT(AUTOREFERER, LONG, 58), 952 953 /* Port of the proxy, can be set in the proxy string as well with: 954 "[host]:[port]" */ 955 CINIT(PROXYPORT, LONG, 59), 956 957 /* size of the POST input data, if strlen() is not good to use */ 958 CINIT(POSTFIELDSIZE, LONG, 60), 959 960 /* tunnel non-http operations through a HTTP proxy */ 961 CINIT(HTTPPROXYTUNNEL, LONG, 61), 962 963 /* Set the interface string to use as outgoing network interface */ 964 CINIT(INTERFACE, OBJECTPOINT, 62), 965 966 /* Set the krb4/5 security level, this also enables krb4/5 awareness. This 967 * is a string, 'clear', 'safe', 'confidential' or 'private'. If the string 968 * is set but doesn't match one of these, 'private' will be used. */ 969 CINIT(KRBLEVEL, OBJECTPOINT, 63), 970 971 /* Set if we should verify the peer in ssl handshake, set 1 to verify. */ 972 CINIT(SSL_VERIFYPEER, LONG, 64), 973 974 /* The CApath or CAfile used to validate the peer certificate 975 this option is used only if SSL_VERIFYPEER is true */ 976 CINIT(CAINFO, OBJECTPOINT, 65), 977 978 /* 66 = OBSOLETE */ 979 /* 67 = OBSOLETE */ 980 981 /* Maximum number of http redirects to follow */ 982 CINIT(MAXREDIRS, LONG, 68), 983 984 /* Pass a long set to 1 to get the date of the requested document (if 985 possible)! Pass a zero to shut it off. */ 986 CINIT(FILETIME, LONG, 69), 987 988 /* This points to a linked list of telnet options */ 989 CINIT(TELNETOPTIONS, OBJECTPOINT, 70), 990 991 /* Max amount of cached alive connections */ 992 CINIT(MAXCONNECTS, LONG, 71), 993 994 /* What policy to use when closing connections when the cache is filled 995 up */ 996 CINIT(CLOSEPOLICY, LONG, 72), 997 998 /* 73 = OBSOLETE */ 999 1000 /* Set to explicitly use a new connection for the upcoming transfer. 1001 Do not use this unless you're absolutely sure of this, as it makes the 1002 operation slower and is less friendly for the network. */ 1003 CINIT(FRESH_CONNECT, LONG, 74), 1004 1005 /* Set to explicitly forbid the upcoming transfer's connection to be re-used 1006 when done. Do not use this unless you're absolutely sure of this, as it 1007 makes the operation slower and is less friendly for the network. */ 1008 CINIT(FORBID_REUSE, LONG, 75), 1009 1010 /* Set to a file name that contains random data for libcurl to use to 1011 seed the random engine when doing SSL connects. */ 1012 CINIT(RANDOM_FILE, OBJECTPOINT, 76), 1013 1014 /* Set to the Entropy Gathering Daemon socket pathname */ 1015 CINIT(EGDSOCKET, OBJECTPOINT, 77), 1016 1017 /* Time-out connect operations after this amount of seconds, if connects 1018 are OK within this time, then fine... This only aborts the connect 1019 phase. [Only works on unix-style/SIGALRM operating systems] */ 1020 CINIT(CONNECTTIMEOUT, LONG, 78), 1021 1022 /* Function that will be called to store headers (instead of fwrite). The 1023 * parameters will use fwrite() syntax, make sure to follow them. */ 1024 CINIT(HEADERFUNCTION, FUNCTIONPOINT, 79), 1025 1026 /* Set this to force the HTTP request to get back to GET. Only really usable 1027 if POST, PUT or a custom request have been used first. 1028 */ 1029 CINIT(HTTPGET, LONG, 80), 1030 1031 /* Set if we should verify the Common name from the peer certificate in ssl 1032 * handshake, set 1 to check existence, 2 to ensure that it matches the 1033 * provided hostname. */ 1034 CINIT(SSL_VERIFYHOST, LONG, 81), 1035 1036 /* Specify which file name to write all known cookies in after completed 1037 operation. Set file name to "-" (dash) to make it go to stdout. */ 1038 CINIT(COOKIEJAR, OBJECTPOINT, 82), 1039 1040 /* Specify which SSL ciphers to use */ 1041 CINIT(SSL_CIPHER_LIST, OBJECTPOINT, 83), 1042 1043 /* Specify which HTTP version to use! This must be set to one of the 1044 CURL_HTTP_VERSION* enums set below. */ 1045 CINIT(HTTP_VERSION, LONG, 84), 1046 1047 /* Specifically switch on or off the FTP engine's use of the EPSV command. By 1048 default, that one will always be attempted before the more traditional 1049 PASV command. */ 1050 CINIT(FTP_USE_EPSV, LONG, 85), 1051 1052 /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */ 1053 CINIT(SSLCERTTYPE, OBJECTPOINT, 86), 1054 1055 /* name of the file keeping your private SSL-key */ 1056 CINIT(SSLKEY, OBJECTPOINT, 87), 1057 1058 /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */ 1059 CINIT(SSLKEYTYPE, OBJECTPOINT, 88), 1060 1061 /* crypto engine for the SSL-sub system */ 1062 CINIT(SSLENGINE, OBJECTPOINT, 89), 1063 1064 /* set the crypto engine for the SSL-sub system as default 1065 the param has no meaning... 1066 */ 1067 CINIT(SSLENGINE_DEFAULT, LONG, 90), 1068 1069 /* Non-zero value means to use the global dns cache */ 1070 CINIT(DNS_USE_GLOBAL_CACHE, LONG, 91), /* To become OBSOLETE soon */ 1071 1072 /* DNS cache timeout */ 1073 CINIT(DNS_CACHE_TIMEOUT, LONG, 92), 1074 1075 /* send linked-list of pre-transfer QUOTE commands */ 1076 CINIT(PREQUOTE, OBJECTPOINT, 93), 1077 1078 /* set the debug function */ 1079 CINIT(DEBUGFUNCTION, FUNCTIONPOINT, 94), 1080 1081 /* set the data for the debug function */ 1082 CINIT(DEBUGDATA, OBJECTPOINT, 95), 1083 1084 /* mark this as start of a cookie session */ 1085 CINIT(COOKIESESSION, LONG, 96), 1086 1087 /* The CApath directory used to validate the peer certificate 1088 this option is used only if SSL_VERIFYPEER is true */ 1089 CINIT(CAPATH, OBJECTPOINT, 97), 1090 1091 /* Instruct libcurl to use a smaller receive buffer */ 1092 CINIT(BUFFERSIZE, LONG, 98), 1093 1094 /* Instruct libcurl to not use any signal/alarm handlers, even when using 1095 timeouts. This option is useful for multi-threaded applications. 1096 See libcurl-the-guide for more background information. */ 1097 CINIT(NOSIGNAL, LONG, 99), 1098 1099 /* Provide a CURLShare for mutexing non-ts data */ 1100 CINIT(SHARE, OBJECTPOINT, 100), 1101 1102 /* indicates type of proxy. accepted values are CURLPROXY_HTTP (default), 1103 CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5. */ 1104 CINIT(PROXYTYPE, LONG, 101), 1105 1106 /* Set the Accept-Encoding string. Use this to tell a server you would like 1107 the response to be compressed. Before 7.21.6, this was known as 1108 CURLOPT_ENCODING */ 1109 CINIT(ACCEPT_ENCODING, OBJECTPOINT, 102), 1110 1111 /* Set pointer to private data */ 1112 CINIT(PRIVATE, OBJECTPOINT, 103), 1113 1114 /* Set aliases for HTTP 200 in the HTTP Response header */ 1115 CINIT(HTTP200ALIASES, OBJECTPOINT, 104), 1116 1117 /* Continue to send authentication (user+password) when following locations, 1118 even when hostname changed. This can potentially send off the name 1119 and password to whatever host the server decides. */ 1120 CINIT(UNRESTRICTED_AUTH, LONG, 105), 1121 1122 /* Specifically switch on or off the FTP engine's use of the EPRT command ( it 1123 also disables the LPRT attempt). By default, those ones will always be 1124 attempted before the good old traditional PORT command. */ 1125 CINIT(FTP_USE_EPRT, LONG, 106), 1126 1127 /* Set this to a bitmask value to enable the particular authentications 1128 methods you like. Use this in combination with CURLOPT_USERPWD. 1129 Note that setting multiple bits may cause extra network round-trips. */ 1130 CINIT(HTTPAUTH, LONG, 107), 1131 1132 /* Set the ssl context callback function, currently only for OpenSSL ssl_ctx 1133 in second argument. The function must be matching the 1134 curl_ssl_ctx_callback proto. */ 1135 CINIT(SSL_CTX_FUNCTION, FUNCTIONPOINT, 108), 1136 1137 /* Set the userdata for the ssl context callback function's third 1138 argument */ 1139 CINIT(SSL_CTX_DATA, OBJECTPOINT, 109), 1140 1141 /* FTP Option that causes missing dirs to be created on the remote server. 1142 In 7.19.4 we introduced the convenience enums for this option using the 1143 CURLFTP_CREATE_DIR prefix. 1144 */ 1145 CINIT(FTP_CREATE_MISSING_DIRS, LONG, 110), 1146 1147 /* Set this to a bitmask value to enable the particular authentications 1148 methods you like. Use this in combination with CURLOPT_PROXYUSERPWD. 1149 Note that setting multiple bits may cause extra network round-trips. */ 1150 CINIT(PROXYAUTH, LONG, 111), 1151 1152 /* FTP option that changes the timeout, in seconds, associated with 1153 getting a response. This is different from transfer timeout time and 1154 essentially places a demand on the FTP server to acknowledge commands 1155 in a timely manner. */ 1156 CINIT(FTP_RESPONSE_TIMEOUT, LONG, 112), 1157 #define CURLOPT_SERVER_RESPONSE_TIMEOUT CURLOPT_FTP_RESPONSE_TIMEOUT 1158 1159 /* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to 1160 tell libcurl to resolve names to those IP versions only. This only has 1161 affect on systems with support for more than one, i.e IPv4 _and_ IPv6. */ 1162 CINIT(IPRESOLVE, LONG, 113), 1163 1164 /* Set this option to limit the size of a file that will be downloaded from 1165 an HTTP or FTP server. 1166 1167 Note there is also _LARGE version which adds large file support for 1168 platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below. */ 1169 CINIT(MAXFILESIZE, LONG, 114), 1170 1171 /* See the comment for INFILESIZE above, but in short, specifies 1172 * the size of the file being uploaded. -1 means unknown. 1173 */ 1174 CINIT(INFILESIZE_LARGE, OFF_T, 115), 1175 1176 /* Sets the continuation offset. There is also a LONG version of this; 1177 * look above for RESUME_FROM. 1178 */ 1179 CINIT(RESUME_FROM_LARGE, OFF_T, 116), 1180 1181 /* Sets the maximum size of data that will be downloaded from 1182 * an HTTP or FTP server. See MAXFILESIZE above for the LONG version. 1183 */ 1184 CINIT(MAXFILESIZE_LARGE, OFF_T, 117), 1185 1186 /* Set this option to the file name of your .netrc file you want libcurl 1187 to parse (using the CURLOPT_NETRC option). If not set, libcurl will do 1188 a poor attempt to find the user's home directory and check for a .netrc 1189 file in there. */ 1190 CINIT(NETRC_FILE, OBJECTPOINT, 118), 1191 1192 /* Enable SSL/TLS for FTP, pick one of: 1193 CURLFTPSSL_TRY - try using SSL, proceed anyway otherwise 1194 CURLFTPSSL_CONTROL - SSL for the control connection or fail 1195 CURLFTPSSL_ALL - SSL for all communication or fail 1196 */ 1197 CINIT(USE_SSL, LONG, 119), 1198 1199 /* The _LARGE version of the standard POSTFIELDSIZE option */ 1200 CINIT(POSTFIELDSIZE_LARGE, OFF_T, 120), 1201 1202 /* Enable/disable the TCP Nagle algorithm */ 1203 CINIT(TCP_NODELAY, LONG, 121), 1204 1205 /* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1206 /* 123 OBSOLETE. Gone in 7.16.0 */ 1207 /* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1208 /* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1209 /* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1210 /* 127 OBSOLETE. Gone in 7.16.0 */ 1211 /* 128 OBSOLETE. Gone in 7.16.0 */ 1212 1213 /* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option 1214 can be used to change libcurl's default action which is to first try 1215 "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK 1216 response has been received. 1217 1218 Available parameters are: 1219 CURLFTPAUTH_DEFAULT - let libcurl decide 1220 CURLFTPAUTH_SSL - try "AUTH SSL" first, then TLS 1221 CURLFTPAUTH_TLS - try "AUTH TLS" first, then SSL 1222 */ 1223 CINIT(FTPSSLAUTH, LONG, 129), 1224 1225 CINIT(IOCTLFUNCTION, FUNCTIONPOINT, 130), 1226 CINIT(IOCTLDATA, OBJECTPOINT, 131), 1227 1228 /* 132 OBSOLETE. Gone in 7.16.0 */ 1229 /* 133 OBSOLETE. Gone in 7.16.0 */ 1230 1231 /* zero terminated string for pass on to the FTP server when asked for 1232 "account" info */ 1233 CINIT(FTP_ACCOUNT, OBJECTPOINT, 134), 1234 1235 /* feed cookies into cookie engine */ 1236 CINIT(COOKIELIST, OBJECTPOINT, 135), 1237 1238 /* ignore Content-Length */ 1239 CINIT(IGNORE_CONTENT_LENGTH, LONG, 136), 1240 1241 /* Set to non-zero to skip the IP address received in a 227 PASV FTP server 1242 response. Typically used for FTP-SSL purposes but is not restricted to 1243 that. libcurl will then instead use the same IP address it used for the 1244 control connection. */ 1245 CINIT(FTP_SKIP_PASV_IP, LONG, 137), 1246 1247 /* Select "file method" to use when doing FTP, see the curl_ftpmethod 1248 above. */ 1249 CINIT(FTP_FILEMETHOD, LONG, 138), 1250 1251 /* Local port number to bind the socket to */ 1252 CINIT(LOCALPORT, LONG, 139), 1253 1254 /* Number of ports to try, including the first one set with LOCALPORT. 1255 Thus, setting it to 1 will make no additional attempts but the first. 1256 */ 1257 CINIT(LOCALPORTRANGE, LONG, 140), 1258 1259 /* no transfer, set up connection and let application use the socket by 1260 extracting it with CURLINFO_LASTSOCKET */ 1261 CINIT(CONNECT_ONLY, LONG, 141), 1262 1263 /* Function that will be called to convert from the 1264 network encoding (instead of using the iconv calls in libcurl) */ 1265 CINIT(CONV_FROM_NETWORK_FUNCTION, FUNCTIONPOINT, 142), 1266 1267 /* Function that will be called to convert to the 1268 network encoding (instead of using the iconv calls in libcurl) */ 1269 CINIT(CONV_TO_NETWORK_FUNCTION, FUNCTIONPOINT, 143), 1270 1271 /* Function that will be called to convert from UTF8 1272 (instead of using the iconv calls in libcurl) 1273 Note that this is used only for SSL certificate processing */ 1274 CINIT(CONV_FROM_UTF8_FUNCTION, FUNCTIONPOINT, 144), 1275 1276 /* if the connection proceeds too quickly then need to slow it down */ 1277 /* limit-rate: maximum number of bytes per second to send or receive */ 1278 CINIT(MAX_SEND_SPEED_LARGE, OFF_T, 145), 1279 CINIT(MAX_RECV_SPEED_LARGE, OFF_T, 146), 1280 1281 /* Pointer to command string to send if USER/PASS fails. */ 1282 CINIT(FTP_ALTERNATIVE_TO_USER, OBJECTPOINT, 147), 1283 1284 /* callback function for setting socket options */ 1285 CINIT(SOCKOPTFUNCTION, FUNCTIONPOINT, 148), 1286 CINIT(SOCKOPTDATA, OBJECTPOINT, 149), 1287 1288 /* set to 0 to disable session ID re-use for this transfer, default is 1289 enabled (== 1) */ 1290 CINIT(SSL_SESSIONID_CACHE, LONG, 150), 1291 1292 /* allowed SSH authentication methods */ 1293 CINIT(SSH_AUTH_TYPES, LONG, 151), 1294 1295 /* Used by scp/sftp to do public/private key authentication */ 1296 CINIT(SSH_PUBLIC_KEYFILE, OBJECTPOINT, 152), 1297 CINIT(SSH_PRIVATE_KEYFILE, OBJECTPOINT, 153), 1298 1299 /* Send CCC (Clear Command Channel) after authentication */ 1300 CINIT(FTP_SSL_CCC, LONG, 154), 1301 1302 /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */ 1303 CINIT(TIMEOUT_MS, LONG, 155), 1304 CINIT(CONNECTTIMEOUT_MS, LONG, 156), 1305 1306 /* set to zero to disable the libcurl's decoding and thus pass the raw body 1307 data to the application even when it is encoded/compressed */ 1308 CINIT(HTTP_TRANSFER_DECODING, LONG, 157), 1309 CINIT(HTTP_CONTENT_DECODING, LONG, 158), 1310 1311 /* Permission used when creating new files and directories on the remote 1312 server for protocols that support it, SFTP/SCP/FILE */ 1313 CINIT(NEW_FILE_PERMS, LONG, 159), 1314 CINIT(NEW_DIRECTORY_PERMS, LONG, 160), 1315 1316 /* Set the behaviour of POST when redirecting. Values must be set to one 1317 of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */ 1318 CINIT(POSTREDIR, LONG, 161), 1319 1320 /* used by scp/sftp to verify the host's public key */ 1321 CINIT(SSH_HOST_PUBLIC_KEY_MD5, OBJECTPOINT, 162), 1322 1323 /* Callback function for opening socket (instead of socket(2)). Optionally, 1324 callback is able change the address or refuse to connect returning 1325 CURL_SOCKET_BAD. The callback should have type 1326 curl_opensocket_callback */ 1327 CINIT(OPENSOCKETFUNCTION, FUNCTIONPOINT, 163), 1328 CINIT(OPENSOCKETDATA, OBJECTPOINT, 164), 1329 1330 /* POST volatile input fields. */ 1331 CINIT(COPYPOSTFIELDS, OBJECTPOINT, 165), 1332 1333 /* set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy */ 1334 CINIT(PROXY_TRANSFER_MODE, LONG, 166), 1335 1336 /* Callback function for seeking in the input stream */ 1337 CINIT(SEEKFUNCTION, FUNCTIONPOINT, 167), 1338 CINIT(SEEKDATA, OBJECTPOINT, 168), 1339 1340 /* CRL file */ 1341 CINIT(CRLFILE, OBJECTPOINT, 169), 1342 1343 /* Issuer certificate */ 1344 CINIT(ISSUERCERT, OBJECTPOINT, 170), 1345 1346 /* (IPv6) Address scope */ 1347 CINIT(ADDRESS_SCOPE, LONG, 171), 1348 1349 /* Collect certificate chain info and allow it to get retrievable with 1350 CURLINFO_CERTINFO after the transfer is complete. (Unfortunately) only 1351 working with OpenSSL-powered builds. */ 1352 CINIT(CERTINFO, LONG, 172), 1353 1354 /* "name" and "pwd" to use when fetching. */ 1355 CINIT(USERNAME, OBJECTPOINT, 173), 1356 CINIT(PASSWORD, OBJECTPOINT, 174), 1357 1358 /* "name" and "pwd" to use with Proxy when fetching. */ 1359 CINIT(PROXYUSERNAME, OBJECTPOINT, 175), 1360 CINIT(PROXYPASSWORD, OBJECTPOINT, 176), 1361 1362 /* Comma separated list of hostnames defining no-proxy zones. These should 1363 match both hostnames directly, and hostnames within a domain. For 1364 example, local.com will match local.com and www.local.com, but NOT 1365 notlocal.com or www.notlocal.com. For compatibility with other 1366 implementations of this, .local.com will be considered to be the same as 1367 local.com. A single * is the only valid wildcard, and effectively 1368 disables the use of proxy. */ 1369 CINIT(NOPROXY, OBJECTPOINT, 177), 1370 1371 /* block size for TFTP transfers */ 1372 CINIT(TFTP_BLKSIZE, LONG, 178), 1373 1374 /* Socks Service */ 1375 CINIT(SOCKS5_GSSAPI_SERVICE, OBJECTPOINT, 179), 1376 1377 /* Socks Service */ 1378 CINIT(SOCKS5_GSSAPI_NEC, LONG, 180), 1379 1380 /* set the bitmask for the protocols that are allowed to be used for the 1381 transfer, which thus helps the app which takes URLs from users or other 1382 external inputs and want to restrict what protocol(s) to deal 1383 with. Defaults to CURLPROTO_ALL. */ 1384 CINIT(PROTOCOLS, LONG, 181), 1385 1386 /* set the bitmask for the protocols that libcurl is allowed to follow to, 1387 as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs 1388 to be set in both bitmasks to be allowed to get redirected to. Defaults 1389 to all protocols except FILE and SCP. */ 1390 CINIT(REDIR_PROTOCOLS, LONG, 182), 1391 1392 /* set the SSH knownhost file name to use */ 1393 CINIT(SSH_KNOWNHOSTS, OBJECTPOINT, 183), 1394 1395 /* set the SSH host key callback, must point to a curl_sshkeycallback 1396 function */ 1397 CINIT(SSH_KEYFUNCTION, FUNCTIONPOINT, 184), 1398 1399 /* set the SSH host key callback custom pointer */ 1400 CINIT(SSH_KEYDATA, OBJECTPOINT, 185), 1401 1402 /* set the SMTP mail originator */ 1403 CINIT(MAIL_FROM, OBJECTPOINT, 186), 1404 1405 /* set the SMTP mail receiver(s) */ 1406 CINIT(MAIL_RCPT, OBJECTPOINT, 187), 1407 1408 /* FTP: send PRET before PASV */ 1409 CINIT(FTP_USE_PRET, LONG, 188), 1410 1411 /* RTSP request method (OPTIONS, SETUP, PLAY, etc...) */ 1412 CINIT(RTSP_REQUEST, LONG, 189), 1413 1414 /* The RTSP session identifier */ 1415 CINIT(RTSP_SESSION_ID, OBJECTPOINT, 190), 1416 1417 /* The RTSP stream URI */ 1418 CINIT(RTSP_STREAM_URI, OBJECTPOINT, 191), 1419 1420 /* The Transport: header to use in RTSP requests */ 1421 CINIT(RTSP_TRANSPORT, OBJECTPOINT, 192), 1422 1423 /* Manually initialize the client RTSP CSeq for this handle */ 1424 CINIT(RTSP_CLIENT_CSEQ, LONG, 193), 1425 1426 /* Manually initialize the server RTSP CSeq for this handle */ 1427 CINIT(RTSP_SERVER_CSEQ, LONG, 194), 1428 1429 /* The stream to pass to INTERLEAVEFUNCTION. */ 1430 CINIT(INTERLEAVEDATA, OBJECTPOINT, 195), 1431 1432 /* Let the application define a custom write method for RTP data */ 1433 CINIT(INTERLEAVEFUNCTION, FUNCTIONPOINT, 196), 1434 1435 /* Turn on wildcard matching */ 1436 CINIT(WILDCARDMATCH, LONG, 197), 1437 1438 /* Directory matching callback called before downloading of an 1439 individual file (chunk) started */ 1440 CINIT(CHUNK_BGN_FUNCTION, FUNCTIONPOINT, 198), 1441 1442 /* Directory matching callback called after the file (chunk) 1443 was downloaded, or skipped */ 1444 CINIT(CHUNK_END_FUNCTION, FUNCTIONPOINT, 199), 1445 1446 /* Change match (fnmatch-like) callback for wildcard matching */ 1447 CINIT(FNMATCH_FUNCTION, FUNCTIONPOINT, 200), 1448 1449 /* Let the application define custom chunk data pointer */ 1450 CINIT(CHUNK_DATA, OBJECTPOINT, 201), 1451 1452 /* FNMATCH_FUNCTION user pointer */ 1453 CINIT(FNMATCH_DATA, OBJECTPOINT, 202), 1454 1455 /* send linked-list of name:port:address sets */ 1456 CINIT(RESOLVE, OBJECTPOINT, 203), 1457 1458 /* Set a username for authenticated TLS */ 1459 CINIT(TLSAUTH_USERNAME, OBJECTPOINT, 204), 1460 1461 /* Set a password for authenticated TLS */ 1462 CINIT(TLSAUTH_PASSWORD, OBJECTPOINT, 205), 1463 1464 /* Set authentication type for authenticated TLS */ 1465 CINIT(TLSAUTH_TYPE, OBJECTPOINT, 206), 1466 1467 /* Set to 1 to enable the "TE:" header in HTTP requests to ask for 1468 compressed transfer-encoded responses. Set to 0 to disable the use of TE: 1469 in outgoing requests. The current default is 0, but it might change in a 1470 future libcurl release. 1471 1472 libcurl will ask for the compressed methods it knows of, and if that 1473 isn't any, it will not ask for transfer-encoding at all even if this 1474 option is set to 1. 1475 1476 */ 1477 CINIT(TRANSFER_ENCODING, LONG, 207), 1478 1479 CURLOPT_LASTENTRY /* the last unused */ 1480 } CURLoption; 1481 1482 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 1483 the obsolete stuff removed! */ 1484 1485 /* Backwards compatibility with older names */ 1486 /* These are scheduled to disappear by 2011 */ 1487 1488 /* This was added in version 7.19.1 */ 1489 #define CURLOPT_POST301 CURLOPT_POSTREDIR 1490 1491 /* These are scheduled to disappear by 2009 */ 1492 1493 /* The following were added in 7.17.0 */ 1494 #define CURLOPT_SSLKEYPASSWD CURLOPT_KEYPASSWD 1495 #define CURLOPT_FTPAPPEND CURLOPT_APPEND 1496 #define CURLOPT_FTPLISTONLY CURLOPT_DIRLISTONLY 1497 #define CURLOPT_FTP_SSL CURLOPT_USE_SSL 1498 1499 /* The following were added earlier */ 1500 1501 #define CURLOPT_SSLCERTPASSWD CURLOPT_KEYPASSWD 1502 #define CURLOPT_KRB4LEVEL CURLOPT_KRBLEVEL 1503 1504 #else 1505 /* This is set if CURL_NO_OLDIES is defined at compile-time */ 1506 #undef CURLOPT_DNS_USE_GLOBAL_CACHE /* soon obsolete */ 1507 #endif 1508 1509 1510 /* Below here follows defines for the CURLOPT_IPRESOLVE option. If a host 1511 name resolves addresses using more than one IP protocol version, this 1512 option might be handy to force libcurl to use a specific IP version. */ 1513 #define CURL_IPRESOLVE_WHATEVER 0 /* default, resolves addresses to all IP 1514 versions that your system allows */ 1515 #define CURL_IPRESOLVE_V4 1 /* resolve to ipv4 addresses */ 1516 #define CURL_IPRESOLVE_V6 2 /* resolve to ipv6 addresses */ 1517 1518 /* three convenient "aliases" that follow the name scheme better */ 1519 #define CURLOPT_WRITEDATA CURLOPT_FILE 1520 #define CURLOPT_READDATA CURLOPT_INFILE 1521 #define CURLOPT_HEADERDATA CURLOPT_WRITEHEADER 1522 #define CURLOPT_RTSPHEADER CURLOPT_HTTPHEADER 1523 1524 /* These enums are for use with the CURLOPT_HTTP_VERSION option. */ 1525 enum { 1526 CURL_HTTP_VERSION_NONE, /* setting this means we don't care, and that we'd 1527 like the library to choose the best possible 1528 for us! */ 1529 CURL_HTTP_VERSION_1_0, /* please use HTTP 1.0 in the request */ 1530 CURL_HTTP_VERSION_1_1, /* please use HTTP 1.1 in the request */ 1531 1532 CURL_HTTP_VERSION_LAST /* *ILLEGAL* http version */ 1533 }; 1534 1535 /* 1536 * Public API enums for RTSP requests 1537 */ 1538 enum { 1539 CURL_RTSPREQ_NONE, /* first in list */ 1540 CURL_RTSPREQ_OPTIONS, 1541 CURL_RTSPREQ_DESCRIBE, 1542 CURL_RTSPREQ_ANNOUNCE, 1543 CURL_RTSPREQ_SETUP, 1544 CURL_RTSPREQ_PLAY, 1545 CURL_RTSPREQ_PAUSE, 1546 CURL_RTSPREQ_TEARDOWN, 1547 CURL_RTSPREQ_GET_PARAMETER, 1548 CURL_RTSPREQ_SET_PARAMETER, 1549 CURL_RTSPREQ_RECORD, 1550 CURL_RTSPREQ_RECEIVE, 1551 CURL_RTSPREQ_LAST /* last in list */ 1552 }; 1553 1554 /* These enums are for use with the CURLOPT_NETRC option. */ 1555 enum CURL_NETRC_OPTION { 1556 CURL_NETRC_IGNORED, /* The .netrc will never be read. 1557 * This is the default. */ 1558 CURL_NETRC_OPTIONAL, /* A user:password in the URL will be preferred 1559 * to one in the .netrc. */ 1560 CURL_NETRC_REQUIRED, /* A user:password in the URL will be ignored. 1561 * Unless one is set programmatically, the .netrc 1562 * will be queried. */ 1563 CURL_NETRC_LAST 1564 }; 1565 1566 enum { 1567 CURL_SSLVERSION_DEFAULT, 1568 CURL_SSLVERSION_TLSv1, 1569 CURL_SSLVERSION_SSLv2, 1570 CURL_SSLVERSION_SSLv3, 1571 1572 CURL_SSLVERSION_LAST /* never use, keep last */ 1573 }; 1574 1575 enum CURL_TLSAUTH { 1576 CURL_TLSAUTH_NONE, 1577 CURL_TLSAUTH_SRP, 1578 CURL_TLSAUTH_LAST /* never use, keep last */ 1579 }; 1580 1581 /* symbols to use with CURLOPT_POSTREDIR. 1582 CURL_REDIR_POST_301 and CURL_REDIR_POST_302 can be bitwise ORed so that 1583 CURL_REDIR_POST_301 | CURL_REDIR_POST_302 == CURL_REDIR_POST_ALL */ 1584 1585 #define CURL_REDIR_GET_ALL 0 1586 #define CURL_REDIR_POST_301 1 1587 #define CURL_REDIR_POST_302 2 1588 #define CURL_REDIR_POST_ALL (CURL_REDIR_POST_301|CURL_REDIR_POST_302) 1589 1590 typedef enum { 1591 CURL_TIMECOND_NONE, 1592 1593 CURL_TIMECOND_IFMODSINCE, 1594 CURL_TIMECOND_IFUNMODSINCE, 1595 CURL_TIMECOND_LASTMOD, 1596 1597 CURL_TIMECOND_LAST 1598 } curl_TimeCond; 1599 1600 1601 /* curl_strequal() and curl_strnequal() are subject for removal in a future 1602 libcurl, see lib/README.curlx for details */ 1603 CURL_EXTERN int (curl_strequal)(const char *s1, const char *s2); 1604 CURL_EXTERN int (curl_strnequal)(const char *s1, const char *s2, size_t n); 1605 1606 /* name is uppercase CURLFORM_<name> */ 1607 #ifdef CFINIT 1608 #undef CFINIT 1609 #endif 1610 1611 #ifdef CURL_ISOCPP 1612 #define CFINIT(name) CURLFORM_ ## name 1613 #else 1614 /* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */ 1615 #define CFINIT(name) CURLFORM_/**/name 1616 #endif 1617 1618 typedef enum { 1619 CFINIT(NOTHING), /********* the first one is unused ************/ 1620 1621 /* */ 1622 CFINIT(COPYNAME), 1623 CFINIT(PTRNAME), 1624 CFINIT(NAMELENGTH), 1625 CFINIT(COPYCONTENTS), 1626 CFINIT(PTRCONTENTS), 1627 CFINIT(CONTENTSLENGTH), 1628 CFINIT(FILECONTENT), 1629 CFINIT(ARRAY), 1630 CFINIT(OBSOLETE), 1631 CFINIT(FILE), 1632 1633 CFINIT(BUFFER), 1634 CFINIT(BUFFERPTR), 1635 CFINIT(BUFFERLENGTH), 1636 1637 CFINIT(CONTENTTYPE), 1638 CFINIT(CONTENTHEADER), 1639 CFINIT(FILENAME), 1640 CFINIT(END), 1641 CFINIT(OBSOLETE2), 1642 1643 CFINIT(STREAM), 1644 1645 CURLFORM_LASTENTRY /* the last unused */ 1646 } CURLformoption; 1647 1648 #undef CFINIT /* done */ 1649 1650 /* structure to be used as parameter for CURLFORM_ARRAY */ 1651 struct curl_forms { 1652 CURLformoption option; 1653 const char *value; 1654 }; 1655 1656 /* use this for multipart formpost building */ 1657 /* Returns code for curl_formadd() 1658 * 1659 * Returns: 1660 * CURL_FORMADD_OK on success 1661 * CURL_FORMADD_MEMORY if the FormInfo allocation fails 1662 * CURL_FORMADD_OPTION_TWICE if one option is given twice for one Form 1663 * CURL_FORMADD_NULL if a null pointer was given for a char 1664 * CURL_FORMADD_MEMORY if the allocation of a FormInfo struct failed 1665 * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used 1666 * CURL_FORMADD_INCOMPLETE if the some FormInfo is not complete (or error) 1667 * CURL_FORMADD_MEMORY if a curl_httppost struct cannot be allocated 1668 * CURL_FORMADD_MEMORY if some allocation for string copying failed. 1669 * CURL_FORMADD_ILLEGAL_ARRAY if an illegal option is used in an array 1670 * 1671 ***************************************************************************/ 1672 typedef enum { 1673 CURL_FORMADD_OK, /* first, no error */ 1674 1675 CURL_FORMADD_MEMORY, 1676 CURL_FORMADD_OPTION_TWICE, 1677 CURL_FORMADD_NULL, 1678 CURL_FORMADD_UNKNOWN_OPTION, 1679 CURL_FORMADD_INCOMPLETE, 1680 CURL_FORMADD_ILLEGAL_ARRAY, 1681 CURL_FORMADD_DISABLED, /* libcurl was built with this disabled */ 1682 1683 CURL_FORMADD_LAST /* last */ 1684 } CURLFORMcode; 1685 1686 /* 1687 * NAME curl_formadd() 1688 * 1689 * DESCRIPTION 1690 * 1691 * Pretty advanced function for building multi-part formposts. Each invoke 1692 * adds one part that together construct a full post. Then use 1693 * CURLOPT_HTTPPOST to send it off to libcurl. 1694 */ 1695 CURL_EXTERN CURLFORMcode curl_formadd(struct curl_httppost **httppost, 1696 struct curl_httppost **last_post, 1697 ...); 1698 1699 /* 1700 * callback function for curl_formget() 1701 * The void *arg pointer will be the one passed as second argument to 1702 * curl_formget(). 1703 * The character buffer passed to it must not be freed. 1704 * Should return the buffer length passed to it as the argument "len" on 1705 * success. 1706 */ 1707 typedef size_t (*curl_formget_callback)(void *arg, const char *buf, size_t len); 1708 1709 /* 1710 * NAME curl_formget() 1711 * 1712 * DESCRIPTION 1713 * 1714 * Serialize a curl_httppost struct built with curl_formadd(). 1715 * Accepts a void pointer as second argument which will be passed to 1716 * the curl_formget_callback function. 1717 * Returns 0 on success. 1718 */ 1719 CURL_EXTERN int curl_formget(struct curl_httppost *form, void *arg, 1720 curl_formget_callback append); 1721 /* 1722 * NAME curl_formfree() 1723 * 1724 * DESCRIPTION 1725 * 1726 * Free a multipart formpost previously built with curl_formadd(). 1727 */ 1728 CURL_EXTERN void curl_formfree(struct curl_httppost *form); 1729 1730 /* 1731 * NAME curl_getenv() 1732 * 1733 * DESCRIPTION 1734 * 1735 * Returns a malloc()'ed string that MUST be curl_free()ed after usage is 1736 * complete. DEPRECATED - see lib/README.curlx 1737 */ 1738 CURL_EXTERN char *curl_getenv(const char *variable); 1739 1740 /* 1741 * NAME curl_version() 1742 * 1743 * DESCRIPTION 1744 * 1745 * Returns a static ascii string of the libcurl version. 1746 */ 1747 CURL_EXTERN char *curl_version(void); 1748 1749 /* 1750 * NAME curl_easy_escape() 1751 * 1752 * DESCRIPTION 1753 * 1754 * Escapes URL strings (converts all letters consider illegal in URLs to their 1755 * %XX versions). This function returns a new allocated string or NULL if an 1756 * error occurred. 1757 */ 1758 CURL_EXTERN char *curl_easy_escape(CURL *handle, 1759 const char *string, 1760 int length); 1761 1762 /* the previous version: */ 1763 CURL_EXTERN char *curl_escape(const char *string, 1764 int length); 1765 1766 1767 /* 1768 * NAME curl_easy_unescape() 1769 * 1770 * DESCRIPTION 1771 * 1772 * Unescapes URL encoding in strings (converts all %XX codes to their 8bit 1773 * versions). This function returns a new allocated string or NULL if an error 1774 * occurred. 1775 * Conversion Note: On non-ASCII platforms the ASCII %XX codes are 1776 * converted into the host encoding. 1777 */ 1778 CURL_EXTERN char *curl_easy_unescape(CURL *handle, 1779 const char *string, 1780 int length, 1781 int *outlength); 1782 1783 /* the previous version */ 1784 CURL_EXTERN char *curl_unescape(const char *string, 1785 int length); 1786 1787 /* 1788 * NAME curl_free() 1789 * 1790 * DESCRIPTION 1791 * 1792 * Provided for de-allocation in the same translation unit that did the 1793 * allocation. Added in libcurl 7.10 1794 */ 1795 CURL_EXTERN void curl_free(void *p); 1796 1797 /* 1798 * NAME curl_global_init() 1799 * 1800 * DESCRIPTION 1801 * 1802 * curl_global_init() should be invoked exactly once for each application that 1803 * uses libcurl and before any call of other libcurl functions. 1804 * 1805 * This function is not thread-safe! 1806 */ 1807 CURL_EXTERN CURLcode curl_global_init(long flags); 1808 1809 /* 1810 * NAME curl_global_init_mem() 1811 * 1812 * DESCRIPTION 1813 * 1814 * curl_global_init() or curl_global_init_mem() should be invoked exactly once 1815 * for each application that uses libcurl. This function can be used to 1816 * initialize libcurl and set user defined memory management callback 1817 * functions. Users can implement memory management routines to check for 1818 * memory leaks, check for mis-use of the curl library etc. User registered 1819 * callback routines with be invoked by this library instead of the system 1820 * memory management routines like malloc, free etc. 1821 */ 1822 CURL_EXTERN CURLcode curl_global_init_mem(long flags, 1823 curl_malloc_callback m, 1824 curl_free_callback f, 1825 curl_realloc_callback r, 1826 curl_strdup_callback s, 1827 curl_calloc_callback c); 1828 1829 /* 1830 * NAME curl_global_cleanup() 1831 * 1832 * DESCRIPTION 1833 * 1834 * curl_global_cleanup() should be invoked exactly once for each application 1835 * that uses libcurl 1836 */ 1837 CURL_EXTERN void curl_global_cleanup(void); 1838 1839 /* linked-list structure for the CURLOPT_QUOTE option (and other) */ 1840 struct curl_slist { 1841 char *data; 1842 struct curl_slist *next; 1843 }; 1844 1845 /* 1846 * NAME curl_slist_append() 1847 * 1848 * DESCRIPTION 1849 * 1850 * Appends a string to a linked list. If no list exists, it will be created 1851 * first. Returns the new list, after appending. 1852 */ 1853 CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *, 1854 const char *); 1855 1856 /* 1857 * NAME curl_slist_free_all() 1858 * 1859 * DESCRIPTION 1860 * 1861 * free a previously built curl_slist. 1862 */ 1863 CURL_EXTERN void curl_slist_free_all(struct curl_slist *); 1864 1865 /* 1866 * NAME curl_getdate() 1867 * 1868 * DESCRIPTION 1869 * 1870 * Returns the time, in seconds since 1 Jan 1970 of the time string given in 1871 * the first argument. The time argument in the second parameter is unused 1872 * and should be set to NULL. 1873 */ 1874 CURL_EXTERN time_t curl_getdate(const char *p, const time_t *unused); 1875 1876 /* info about the certificate chain, only for OpenSSL builds. Asked 1877 for with CURLOPT_CERTINFO / CURLINFO_CERTINFO */ 1878 struct curl_certinfo { 1879 int num_of_certs; /* number of certificates with information */ 1880 struct curl_slist **certinfo; /* for each index in this array, there's a 1881 linked list with textual information in the 1882 format "name: value" */ 1883 }; 1884 1885 #define CURLINFO_STRING 0x100000 1886 #define CURLINFO_LONG 0x200000 1887 #define CURLINFO_DOUBLE 0x300000 1888 #define CURLINFO_SLIST 0x400000 1889 #define CURLINFO_MASK 0x0fffff 1890 #define CURLINFO_TYPEMASK 0xf00000 1891 1892 typedef enum { 1893 CURLINFO_NONE, /* first, never use this */ 1894 CURLINFO_EFFECTIVE_URL = CURLINFO_STRING + 1, 1895 CURLINFO_RESPONSE_CODE = CURLINFO_LONG + 2, 1896 CURLINFO_TOTAL_TIME = CURLINFO_DOUBLE + 3, 1897 CURLINFO_NAMELOOKUP_TIME = CURLINFO_DOUBLE + 4, 1898 CURLINFO_CONNECT_TIME = CURLINFO_DOUBLE + 5, 1899 CURLINFO_PRETRANSFER_TIME = CURLINFO_DOUBLE + 6, 1900 CURLINFO_SIZE_UPLOAD = CURLINFO_DOUBLE + 7, 1901 CURLINFO_SIZE_DOWNLOAD = CURLINFO_DOUBLE + 8, 1902 CURLINFO_SPEED_DOWNLOAD = CURLINFO_DOUBLE + 9, 1903 CURLINFO_SPEED_UPLOAD = CURLINFO_DOUBLE + 10, 1904 CURLINFO_HEADER_SIZE = CURLINFO_LONG + 11, 1905 CURLINFO_REQUEST_SIZE = CURLINFO_LONG + 12, 1906 CURLINFO_SSL_VERIFYRESULT = CURLINFO_LONG + 13, 1907 CURLINFO_FILETIME = CURLINFO_LONG + 14, 1908 CURLINFO_CONTENT_LENGTH_DOWNLOAD = CURLINFO_DOUBLE + 15, 1909 CURLINFO_CONTENT_LENGTH_UPLOAD = CURLINFO_DOUBLE + 16, 1910 CURLINFO_STARTTRANSFER_TIME = CURLINFO_DOUBLE + 17, 1911 CURLINFO_CONTENT_TYPE = CURLINFO_STRING + 18, 1912 CURLINFO_REDIRECT_TIME = CURLINFO_DOUBLE + 19, 1913 CURLINFO_REDIRECT_COUNT = CURLINFO_LONG + 20, 1914 CURLINFO_PRIVATE = CURLINFO_STRING + 21, 1915 CURLINFO_HTTP_CONNECTCODE = CURLINFO_LONG + 22, 1916 CURLINFO_HTTPAUTH_AVAIL = CURLINFO_LONG + 23, 1917 CURLINFO_PROXYAUTH_AVAIL = CURLINFO_LONG + 24, 1918 CURLINFO_OS_ERRNO = CURLINFO_LONG + 25, 1919 CURLINFO_NUM_CONNECTS = CURLINFO_LONG + 26, 1920 CURLINFO_SSL_ENGINES = CURLINFO_SLIST + 27, 1921 CURLINFO_COOKIELIST = CURLINFO_SLIST + 28, 1922 CURLINFO_LASTSOCKET = CURLINFO_LONG + 29, 1923 CURLINFO_FTP_ENTRY_PATH = CURLINFO_STRING + 30, 1924 CURLINFO_REDIRECT_URL = CURLINFO_STRING + 31, 1925 CURLINFO_PRIMARY_IP = CURLINFO_STRING + 32, 1926 CURLINFO_APPCONNECT_TIME = CURLINFO_DOUBLE + 33, 1927 CURLINFO_CERTINFO = CURLINFO_SLIST + 34, 1928 CURLINFO_CONDITION_UNMET = CURLINFO_LONG + 35, 1929 CURLINFO_RTSP_SESSION_ID = CURLINFO_STRING + 36, 1930 CURLINFO_RTSP_CLIENT_CSEQ = CURLINFO_LONG + 37, 1931 CURLINFO_RTSP_SERVER_CSEQ = CURLINFO_LONG + 38, 1932 CURLINFO_RTSP_CSEQ_RECV = CURLINFO_LONG + 39, 1933 CURLINFO_PRIMARY_PORT = CURLINFO_LONG + 40, 1934 CURLINFO_LOCAL_IP = CURLINFO_STRING + 41, 1935 CURLINFO_LOCAL_PORT = CURLINFO_LONG + 42, 1936 /* Fill in new entries below here! */ 1937 1938 CURLINFO_LASTONE = 42 1939 } CURLINFO; 1940 1941 /* CURLINFO_RESPONSE_CODE is the new name for the option previously known as 1942 CURLINFO_HTTP_CODE */ 1943 #define CURLINFO_HTTP_CODE CURLINFO_RESPONSE_CODE 1944 1945 typedef enum { 1946 CURLCLOSEPOLICY_NONE, /* first, never use this */ 1947 1948 CURLCLOSEPOLICY_OLDEST, 1949 CURLCLOSEPOLICY_LEAST_RECENTLY_USED, 1950 CURLCLOSEPOLICY_LEAST_TRAFFIC, 1951 CURLCLOSEPOLICY_SLOWEST, 1952 CURLCLOSEPOLICY_CALLBACK, 1953 1954 CURLCLOSEPOLICY_LAST /* last, never use this */ 1955 } curl_closepolicy; 1956 1957 #define CURL_GLOBAL_SSL (1<<0) 1958 #define CURL_GLOBAL_WIN32 (1<<1) 1959 #define CURL_GLOBAL_ALL (CURL_GLOBAL_SSL|CURL_GLOBAL_WIN32) 1960 #define CURL_GLOBAL_NOTHING 0 1961 #define CURL_GLOBAL_DEFAULT CURL_GLOBAL_ALL 1962 1963 1964 /***************************************************************************** 1965 * Setup defines, protos etc for the sharing stuff. 1966 */ 1967 1968 /* Different data locks for a single share */ 1969 typedef enum { 1970 CURL_LOCK_DATA_NONE = 0, 1971 /* CURL_LOCK_DATA_SHARE is used internally to say that 1972 * the locking is just made to change the internal state of the share 1973 * itself. 1974 */ 1975 CURL_LOCK_DATA_SHARE, 1976 CURL_LOCK_DATA_COOKIE, 1977 CURL_LOCK_DATA_DNS, 1978 CURL_LOCK_DATA_SSL_SESSION, 1979 CURL_LOCK_DATA_CONNECT, 1980 CURL_LOCK_DATA_LAST 1981 } curl_lock_data; 1982 1983 /* Different lock access types */ 1984 typedef enum { 1985 CURL_LOCK_ACCESS_NONE = 0, /* unspecified action */ 1986 CURL_LOCK_ACCESS_SHARED = 1, /* for read perhaps */ 1987 CURL_LOCK_ACCESS_SINGLE = 2, /* for write perhaps */ 1988 CURL_LOCK_ACCESS_LAST /* never use */ 1989 } curl_lock_access; 1990 1991 typedef void (*curl_lock_function)(CURL *handle, 1992 curl_lock_data data, 1993 curl_lock_access locktype, 1994 void *userptr); 1995 typedef void (*curl_unlock_function)(CURL *handle, 1996 curl_lock_data data, 1997 void *userptr); 1998 1999 typedef void CURLSH; 2000 2001 typedef enum { 2002 CURLSHE_OK, /* all is fine */ 2003 CURLSHE_BAD_OPTION, /* 1 */ 2004 CURLSHE_IN_USE, /* 2 */ 2005 CURLSHE_INVALID, /* 3 */ 2006 CURLSHE_NOMEM, /* out of memory */ 2007 CURLSHE_LAST /* never use */ 2008 } CURLSHcode; 2009 2010 typedef enum { 2011 CURLSHOPT_NONE, /* don't use */ 2012 CURLSHOPT_SHARE, /* specify a data type to share */ 2013 CURLSHOPT_UNSHARE, /* specify which data type to stop sharing */ 2014 CURLSHOPT_LOCKFUNC, /* pass in a 'curl_lock_function' pointer */ 2015 CURLSHOPT_UNLOCKFUNC, /* pass in a 'curl_unlock_function' pointer */ 2016 CURLSHOPT_USERDATA, /* pass in a user data pointer used in the lock/unlock 2017 callback functions */ 2018 CURLSHOPT_LAST /* never use */ 2019 } CURLSHoption; 2020 2021 CURL_EXTERN CURLSH *curl_share_init(void); 2022 CURL_EXTERN CURLSHcode curl_share_setopt(CURLSH *, CURLSHoption option, ...); 2023 CURL_EXTERN CURLSHcode curl_share_cleanup(CURLSH *); 2024 2025 /**************************************************************************** 2026 * Structures for querying information about the curl library at runtime. 2027 */ 2028 2029 typedef enum { 2030 CURLVERSION_FIRST, 2031 CURLVERSION_SECOND, 2032 CURLVERSION_THIRD, 2033 CURLVERSION_FOURTH, 2034 CURLVERSION_LAST /* never actually use this */ 2035 } CURLversion; 2036 2037 /* The 'CURLVERSION_NOW' is the symbolic name meant to be used by 2038 basically all programs ever that want to get version information. It is 2039 meant to be a built-in version number for what kind of struct the caller 2040 expects. If the struct ever changes, we redefine the NOW to another enum 2041 from above. */ 2042 #define CURLVERSION_NOW CURLVERSION_FOURTH 2043 2044 typedef struct { 2045 CURLversion age; /* age of the returned struct */ 2046 const char *version; /* LIBCURL_VERSION */ 2047 unsigned int version_num; /* LIBCURL_VERSION_NUM */ 2048 const char *host; /* OS/host/cpu/machine when configured */ 2049 int features; /* bitmask, see defines below */ 2050 const char *ssl_version; /* human readable string */ 2051 long ssl_version_num; /* not used anymore, always 0 */ 2052 const char *libz_version; /* human readable string */ 2053 /* protocols is terminated by an entry with a NULL protoname */ 2054 const char * const *protocols; 2055 2056 /* The fields below this were added in CURLVERSION_SECOND */ 2057 const char *ares; 2058 int ares_num; 2059 2060 /* This field was added in CURLVERSION_THIRD */ 2061 const char *libidn; 2062 2063 /* These field were added in CURLVERSION_FOURTH */ 2064 2065 /* Same as '_libiconv_version' if built with HAVE_ICONV */ 2066 int iconv_ver_num; 2067 2068 const char *libssh_version; /* human readable string */ 2069 2070 } curl_version_info_data; 2071 2072 #define CURL_VERSION_IPV6 (1<<0) /* IPv6-enabled */ 2073 #define CURL_VERSION_KERBEROS4 (1<<1) /* kerberos auth is supported */ 2074 #define CURL_VERSION_SSL (1<<2) /* SSL options are present */ 2075 #define CURL_VERSION_LIBZ (1<<3) /* libz features are present */ 2076 #define CURL_VERSION_NTLM (1<<4) /* NTLM auth is supported */ 2077 #define CURL_VERSION_GSSNEGOTIATE (1<<5) /* Negotiate auth support */ 2078 #define CURL_VERSION_DEBUG (1<<6) /* built with debug capabilities */ 2079 #define CURL_VERSION_ASYNCHDNS (1<<7) /* asynchronous dns resolves */ 2080 #define CURL_VERSION_SPNEGO (1<<8) /* SPNEGO auth */ 2081 #define CURL_VERSION_LARGEFILE (1<<9) /* supports files bigger than 2GB */ 2082 #define CURL_VERSION_IDN (1<<10) /* International Domain Names support */ 2083 #define CURL_VERSION_SSPI (1<<11) /* SSPI is supported */ 2084 #define CURL_VERSION_CONV (1<<12) /* character conversions supported */ 2085 #define CURL_VERSION_CURLDEBUG (1<<13) /* debug memory tracking supported */ 2086 #define CURL_VERSION_TLSAUTH_SRP (1<<14) /* TLS-SRP auth is supported */ 2087 2088 /* 2089 * NAME curl_version_info() 2090 * 2091 * DESCRIPTION 2092 * 2093 * This function returns a pointer to a static copy of the version info 2094 * struct. See above. 2095 */ 2096 CURL_EXTERN curl_version_info_data *curl_version_info(CURLversion); 2097 2098 /* 2099 * NAME curl_easy_strerror() 2100 * 2101 * DESCRIPTION 2102 * 2103 * The curl_easy_strerror function may be used to turn a CURLcode value 2104 * into the equivalent human readable error string. This is useful 2105 * for printing meaningful error messages. 2106 */ 2107 CURL_EXTERN const char *curl_easy_strerror(CURLcode); 2108 2109 /* 2110 * NAME curl_share_strerror() 2111 * 2112 * DESCRIPTION 2113 * 2114 * The curl_share_strerror function may be used to turn a CURLSHcode value 2115 * into the equivalent human readable error string. This is useful 2116 * for printing meaningful error messages. 2117 */ 2118 CURL_EXTERN const char *curl_share_strerror(CURLSHcode); 2119 2120 /* 2121 * NAME curl_easy_pause() 2122 * 2123 * DESCRIPTION 2124 * 2125 * The curl_easy_pause function pauses or unpauses transfers. Select the new 2126 * state by setting the bitmask, use the convenience defines below. 2127 * 2128 */ 2129 CURL_EXTERN CURLcode curl_easy_pause(CURL *handle, int bitmask); 2130 2131 #define CURLPAUSE_RECV (1<<0) 2132 #define CURLPAUSE_RECV_CONT (0) 2133 2134 #define CURLPAUSE_SEND (1<<2) 2135 #define CURLPAUSE_SEND_CONT (0) 2136 2137 #define CURLPAUSE_ALL (CURLPAUSE_RECV|CURLPAUSE_SEND) 2138 #define CURLPAUSE_CONT (CURLPAUSE_RECV_CONT|CURLPAUSE_SEND_CONT) 2139 2140 #ifdef __cplusplus 2141 } 2142 #endif 2143 2144 /* unfortunately, the easy.h and multi.h include files need options and info 2145 stuff before they can be included! */ 2146 #include "easy.h" /* nothing in curl is fun without the easy stuff */ 2147 #include "multi.h" 2148 2149 /* the typechecker doesn't work in C++ (yet) */ 2150 #if defined(__GNUC__) && defined(__GNUC_MINOR__) && \ 2151 ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && \ 2152 !defined(__cplusplus) && !defined(CURL_DISABLE_TYPECHECK) 2153 #include "typecheck-gcc.h" 2154 #else 2155 #if defined(__STDC__) && (__STDC__ >= 1) 2156 /* This preprocessor magic that replaces a call with the exact same call is 2157 only done to make sure application authors pass exactly three arguments 2158 to these functions. */ 2159 #define curl_easy_setopt(handle,opt,param) curl_easy_setopt(handle,opt,param) 2160 #define curl_easy_getinfo(handle,info,arg) curl_easy_getinfo(handle,info,arg) 2161 #define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param) 2162 #define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param) 2163 #endif /* __STDC__ >= 1 */ 2164 #endif /* gcc >= 4.3 && !__cplusplus */ 2165 2166 #endif /* __CURL_CURL_H */ 2167