include/curl/curl.h

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