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