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