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