mingw/include/curl/curl.h

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