include/curl/curl.h

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