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_GOPHER (1<<25)
 726 #define CURLPROTO_ALL    (~0) /* enable everything */
 727
 728 /* long may be 32 or 64 bits, but we should never depend on anything else
 729    but 32 */
 730 #define CURLOPTTYPE_LONG          0
 731 #define CURLOPTTYPE_OBJECTPOINT   10000
 732 #define CURLOPTTYPE_FUNCTIONPOINT 20000
 733 #define CURLOPTTYPE_OFF_T         30000
 734
 735 /* name is uppercase CURLOPT_<name>,
 736    type is one of the defined CURLOPTTYPE_<type>
 737    number is unique identifier */
 738 #ifdef CINIT
 739 #undef CINIT
 740 #endif
 741
 742 #ifdef CURL_ISOCPP
 743 #define CINIT(name,type,number) CURLOPT_ ## name = CURLOPTTYPE_ ## type + number
 744 #else
 745 /* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */
 746 #define LONG          CURLOPTTYPE_LONG
 747 #define OBJECTPOINT   CURLOPTTYPE_OBJECTPOINT
 748 #define FUNCTIONPOINT CURLOPTTYPE_FUNCTIONPOINT
 749 #define OFF_T         CURLOPTTYPE_OFF_T
 750 #define CINIT(name,type,number) CURLOPT_/**/name = type + number
 751 #endif
 752
 753 /*
 754  * This macro-mania below setups the CURLOPT_[what] enum, to be used with
 755  * curl_easy_setopt(). The first argument in the CINIT() macro is the [what]
 756  * word.
 757  */
 758
 759 typedef enum {
 760   /* This is the FILE * or void * the regular output should be written to. */
 761   CINIT(FILE, OBJECTPOINT, 1),
 762
 763   /* The full URL to get/put */
 764   CINIT(URL,  OBJECTPOINT, 2),
 765
 766   /* Port number to connect to, if other than default. */
 767   CINIT(PORT, LONG, 3),
 768
 769   /* Name of proxy to use. */
 770   CINIT(PROXY, OBJECTPOINT, 4),
 771
 772   /* "name:password" to use when fetching. */
 773   CINIT(USERPWD, OBJECTPOINT, 5),
 774
 775   /* "name:password" to use with proxy. */
 776   CINIT(PROXYUSERPWD, OBJECTPOINT, 6),
 777
 778   /* Range to get, specified as an ASCII string. */
 779   CINIT(RANGE, OBJECTPOINT, 7),
 780
 781   /* not used */
 782
 783   /* Specified file stream to upload from (use as input): */
 784   CINIT(INFILE, OBJECTPOINT, 9),
 785
 786   /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE
 787    * bytes big. If this is not used, error messages go to stderr instead: */
 788   CINIT(ERRORBUFFER, OBJECTPOINT, 10),
 789
 790   /* Function that will be called to store the output (instead of fwrite). The
 791    * parameters will use fwrite() syntax, make sure to follow them. */
 792   CINIT(WRITEFUNCTION, FUNCTIONPOINT, 11),
 793
 794   /* Function that will be called to read the input (instead of fread). The
 795    * parameters will use fread() syntax, make sure to follow them. */
 796   CINIT(READFUNCTION, FUNCTIONPOINT, 12),
 797
 798   /* Time-out the read operation after this amount of seconds */
 799   CINIT(TIMEOUT, LONG, 13),
 800
 801   /* If the CURLOPT_INFILE is used, this can be used to inform libcurl about
 802    * how large the file being sent really is. That allows better error
 803    * checking and better verifies that the upload was successful. -1 means
 804    * unknown size.
 805    *
 806    * For large file support, there is also a _LARGE version of the key
 807    * which takes an off_t type, allowing platforms with larger off_t
 808    * sizes to handle larger files.  See below for INFILESIZE_LARGE.
 809    */
 810   CINIT(INFILESIZE, LONG, 14),
 811
 812   /* POST static input fields. */
 813   CINIT(POSTFIELDS, OBJECTPOINT, 15),
 814
 815   /* Set the referrer page (needed by some CGIs) */
 816   CINIT(REFERER, OBJECTPOINT, 16),
 817
 818   /* Set the FTP PORT string (interface name, named or numerical IP address)
 819      Use i.e '-' to use default address. */
 820   CINIT(FTPPORT, OBJECTPOINT, 17),
 821
 822   /* Set the User-Agent string (examined by some CGIs) */
 823   CINIT(USERAGENT, OBJECTPOINT, 18),
 824
 825   /* If the download receives less than "low speed limit" bytes/second
 826    * during "low speed time" seconds, the operations is aborted.
 827    * You could i.e if you have a pretty high speed connection, abort if
 828    * it is less than 2000 bytes/sec during 20 seconds.
 829    */
 830
 831   /* Set the "low speed limit" */
 832   CINIT(LOW_SPEED_LIMIT, LONG, 19),
 833
 834   /* Set the "low speed time" */
 835   CINIT(LOW_SPEED_TIME, LONG, 20),
 836
 837   /* Set the continuation offset.
 838    *
 839    * Note there is also a _LARGE version of this key which uses
 840    * off_t types, allowing for large file offsets on platforms which
 841    * use larger-than-32-bit off_t's.  Look below for RESUME_FROM_LARGE.
 842    */
 843   CINIT(RESUME_FROM, LONG, 21),
 844
 845   /* Set cookie in request: */
 846   CINIT(COOKIE, OBJECTPOINT, 22),
 847
 848   /* This points to a linked list of headers, struct curl_slist kind */
 849   CINIT(HTTPHEADER, OBJECTPOINT, 23),
 850
 851   /* This points to a linked list of post entries, struct curl_httppost */
 852   CINIT(HTTPPOST, OBJECTPOINT, 24),
 853
 854   /* name of the file keeping your private SSL-certificate */
 855   CINIT(SSLCERT, OBJECTPOINT, 25),
 856
 857   /* password for the SSL or SSH private key */
 858   CINIT(KEYPASSWD, OBJECTPOINT, 26),
 859
 860   /* send TYPE parameter? */
 861   CINIT(CRLF, LONG, 27),
 862
 863   /* send linked-list of QUOTE commands */
 864   CINIT(QUOTE, OBJECTPOINT, 28),
 865
 866   /* send FILE * or void * to store headers to, if you use a callback it
 867      is simply passed to the callback unmodified */
 868   CINIT(WRITEHEADER, OBJECTPOINT, 29),
 869
 870   /* point to a file to read the initial cookies from, also enables
 871      "cookie awareness" */
 872   CINIT(COOKIEFILE, OBJECTPOINT, 31),
 873
 874   /* What version to specifically try to use.
 875      See CURL_SSLVERSION defines below. */
 876   CINIT(SSLVERSION, LONG, 32),
 877
 878   /* What kind of HTTP time condition to use, see defines */
 879   CINIT(TIMECONDITION, LONG, 33),
 880
 881   /* Time to use with the above condition. Specified in number of seconds
 882      since 1 Jan 1970 */
 883   CINIT(TIMEVALUE, LONG, 34),
 884
 885   /* 35 = OBSOLETE */
 886
 887   /* Custom request, for customizing the get command like
 888      HTTP: DELETE, TRACE and others
 889      FTP: to use a different list command
 890      */
 891   CINIT(CUSTOMREQUEST, OBJECTPOINT, 36),
 892
 893   /* HTTP request, for odd commands like DELETE, TRACE and others */
 894   CINIT(STDERR, OBJECTPOINT, 37),
 895
 896   /* 38 is not used */
 897
 898   /* send linked-list of post-transfer QUOTE commands */
 899   CINIT(POSTQUOTE, OBJECTPOINT, 39),
 900
 901   /* Pass a pointer to string of the output using full variable-replacement
 902      as described elsewhere. */
 903   CINIT(WRITEINFO, OBJECTPOINT, 40),
 904
 905   CINIT(VERBOSE, LONG, 41),      /* talk a lot */
 906   CINIT(HEADER, LONG, 42),       /* throw the header out too */
 907   CINIT(NOPROGRESS, LONG, 43),   /* shut off the progress meter */
 908   CINIT(NOBODY, LONG, 44),       /* use HEAD to get http document */
 909   CINIT(FAILONERROR, LONG, 45),  /* no output on http error codes >= 300 */
 910   CINIT(UPLOAD, LONG, 46),       /* this is an upload */
 911   CINIT(POST, LONG, 47),         /* HTTP POST method */
 912   CINIT(DIRLISTONLY, LONG, 48),  /* return bare names when listing directories */
 913
 914   CINIT(APPEND, LONG, 50),       /* Append instead of overwrite on upload! */
 915
 916   /* Specify whether to read the user+password from the .netrc or the URL.
 917    * This must be one of the CURL_NETRC_* enums below. */
 918   CINIT(NETRC, LONG, 51),
 919
 920   CINIT(FOLLOWLOCATION, LONG, 52),  /* use Location: Luke! */
 921
 922   CINIT(TRANSFERTEXT, LONG, 53), /* transfer data in text/ASCII format */
 923   CINIT(PUT, LONG, 54),          /* HTTP PUT */
 924
 925   /* 55 = OBSOLETE */
 926
 927   /* Function that will be called instead of the internal progress display
 928    * function. This function should be defined as the curl_progress_callback
 929    * prototype defines. */
 930   CINIT(PROGRESSFUNCTION, FUNCTIONPOINT, 56),
 931
 932   /* Data passed to the progress callback */
 933   CINIT(PROGRESSDATA, OBJECTPOINT, 57),
 934
 935   /* We want the referrer field set automatically when following locations */
 936   CINIT(AUTOREFERER, LONG, 58),
 937
 938   /* Port of the proxy, can be set in the proxy string as well with:
 939      "[host]:[port]" */
 940   CINIT(PROXYPORT, LONG, 59),
 941
 942   /* size of the POST input data, if strlen() is not good to use */
 943   CINIT(POSTFIELDSIZE, LONG, 60),
 944
 945   /* tunnel non-http operations through a HTTP proxy */
 946   CINIT(HTTPPROXYTUNNEL, LONG, 61),
 947
 948   /* Set the interface string to use as outgoing network interface */
 949   CINIT(INTERFACE, OBJECTPOINT, 62),
 950
 951   /* Set the krb4/5 security level, this also enables krb4/5 awareness.  This
 952    * is a string, 'clear', 'safe', 'confidential' or 'private'.  If the string
 953    * is set but doesn't match one of these, 'private' will be used.  */
 954   CINIT(KRBLEVEL, OBJECTPOINT, 63),
 955
 956   /* Set if we should verify the peer in ssl handshake, set 1 to verify. */
 957   CINIT(SSL_VERIFYPEER, LONG, 64),
 958
 959   /* The CApath or CAfile used to validate the peer certificate
 960      this option is used only if SSL_VERIFYPEER is true */
 961   CINIT(CAINFO, OBJECTPOINT, 65),
 962
 963   /* 66 = OBSOLETE */
 964   /* 67 = OBSOLETE */
 965
 966   /* Maximum number of http redirects to follow */
 967   CINIT(MAXREDIRS, LONG, 68),
 968
 969   /* Pass a long set to 1 to get the date of the requested document (if
 970      possible)! Pass a zero to shut it off. */
 971   CINIT(FILETIME, LONG, 69),
 972
 973   /* This points to a linked list of telnet options */
 974   CINIT(TELNETOPTIONS, OBJECTPOINT, 70),
 975
 976   /* Max amount of cached alive connections */
 977   CINIT(MAXCONNECTS, LONG, 71),
 978
 979   /* What policy to use when closing connections when the cache is filled
 980      up */
 981   CINIT(CLOSEPOLICY, LONG, 72),
 982
 983   /* 73 = OBSOLETE */
 984
 985   /* Set to explicitly use a new connection for the upcoming transfer.
 986      Do not use this unless you're absolutely sure of this, as it makes the
 987      operation slower and is less friendly for the network. */
 988   CINIT(FRESH_CONNECT, LONG, 74),
 989
 990   /* Set to explicitly forbid the upcoming transfer's connection to be re-used
 991      when done. Do not use this unless you're absolutely sure of this, as it
 992      makes the operation slower and is less friendly for the network. */
 993   CINIT(FORBID_REUSE, LONG, 75),
 994
 995   /* Set to a file name that contains random data for libcurl to use to
 996      seed the random engine when doing SSL connects. */
 997   CINIT(RANDOM_FILE, OBJECTPOINT, 76),
 998
 999   /* Set to the Entropy Gathering Daemon socket pathname */
1000   CINIT(EGDSOCKET, OBJECTPOINT, 77),
1001
1002   /* Time-out connect operations after this amount of seconds, if connects
1003      are OK within this time, then fine... This only aborts the connect
1004      phase. [Only works on unix-style/SIGALRM operating systems] */
1005   CINIT(CONNECTTIMEOUT, LONG, 78),
1006
1007   /* Function that will be called to store headers (instead of fwrite). The
1008    * parameters will use fwrite() syntax, make sure to follow them. */
1009   CINIT(HEADERFUNCTION, FUNCTIONPOINT, 79),
1010
1011   /* Set this to force the HTTP request to get back to GET. Only really usable
1012      if POST, PUT or a custom request have been used first.
1013    */
1014   CINIT(HTTPGET, LONG, 80),
1015
1016   /* Set if we should verify the Common name from the peer certificate in ssl
1017    * handshake, set 1 to check existence, 2 to ensure that it matches the
1018    * provided hostname. */
1019   CINIT(SSL_VERIFYHOST, LONG, 81),
1020
1021   /* Specify which file name to write all known cookies in after completed
1022      operation. Set file name to "-" (dash) to make it go to stdout. */
1023   CINIT(COOKIEJAR, OBJECTPOINT, 82),
1024
1025   /* Specify which SSL ciphers to use */
1026   CINIT(SSL_CIPHER_LIST, OBJECTPOINT, 83),
1027
1028   /* Specify which HTTP version to use! This must be set to one of the
1029      CURL_HTTP_VERSION* enums set below. */
1030   CINIT(HTTP_VERSION, LONG, 84),
1031
1032   /* Specifically switch on or off the FTP engine's use of the EPSV command. By
1033      default, that one will always be attempted before the more traditional
1034      PASV command. */
1035   CINIT(FTP_USE_EPSV, LONG, 85),
1036
1037   /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */
1038   CINIT(SSLCERTTYPE, OBJECTPOINT, 86),
1039
1040   /* name of the file keeping your private SSL-key */
1041   CINIT(SSLKEY, OBJECTPOINT, 87),
1042
1043   /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */
1044   CINIT(SSLKEYTYPE, OBJECTPOINT, 88),
1045
1046   /* crypto engine for the SSL-sub system */
1047   CINIT(SSLENGINE, OBJECTPOINT, 89),
1048
1049   /* set the crypto engine for the SSL-sub system as default
1050      the param has no meaning...
1051    */
1052   CINIT(SSLENGINE_DEFAULT, LONG, 90),
1053
1054   /* Non-zero value means to use the global dns cache */
1055   CINIT(DNS_USE_GLOBAL_CACHE, LONG, 91), /* To become OBSOLETE soon */
1056
1057   /* DNS cache timeout */
1058   CINIT(DNS_CACHE_TIMEOUT, LONG, 92),
1059
1060   /* send linked-list of pre-transfer QUOTE commands */
1061   CINIT(PREQUOTE, OBJECTPOINT, 93),
1062
1063   /* set the debug function */
1064   CINIT(DEBUGFUNCTION, FUNCTIONPOINT, 94),
1065
1066   /* set the data for the debug function */
1067   CINIT(DEBUGDATA, OBJECTPOINT, 95),
1068
1069   /* mark this as start of a cookie session */
1070   CINIT(COOKIESESSION, LONG, 96),
1071
1072   /* The CApath directory used to validate the peer certificate
1073      this option is used only if SSL_VERIFYPEER is true */
1074   CINIT(CAPATH, OBJECTPOINT, 97),
1075
1076   /* Instruct libcurl to use a smaller receive buffer */
1077   CINIT(BUFFERSIZE, LONG, 98),
1078
1079   /* Instruct libcurl to not use any signal/alarm handlers, even when using
1080      timeouts. This option is useful for multi-threaded applications.
1081      See libcurl-the-guide for more background information. */
1082   CINIT(NOSIGNAL, LONG, 99),
1083
1084   /* Provide a CURLShare for mutexing non-ts data */
1085   CINIT(SHARE, OBJECTPOINT, 100),
1086
1087   /* indicates type of proxy. accepted values are CURLPROXY_HTTP (default),
1088      CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5. */
1089   CINIT(PROXYTYPE, LONG, 101),
1090
1091   /* Set the Accept-Encoding string. Use this to tell a server you would like
1092      the response to be compressed. */
1093   CINIT(ENCODING, OBJECTPOINT, 102),
1094
1095   /* Set pointer to private data */
1096   CINIT(PRIVATE, OBJECTPOINT, 103),
1097
1098   /* Set aliases for HTTP 200 in the HTTP Response header */
1099   CINIT(HTTP200ALIASES, OBJECTPOINT, 104),
1100
1101   /* Continue to send authentication (user+password) when following locations,
1102      even when hostname changed. This can potentially send off the name
1103      and password to whatever host the server decides. */
1104   CINIT(UNRESTRICTED_AUTH, LONG, 105),
1105
1106   /* Specifically switch on or off the FTP engine's use of the EPRT command ( it
1107      also disables the LPRT attempt). By default, those ones will always be
1108      attempted before the good old traditional PORT command. */
1109   CINIT(FTP_USE_EPRT, LONG, 106),
1110
1111   /* Set this to a bitmask value to enable the particular authentications
1112      methods you like. Use this in combination with CURLOPT_USERPWD.
1113      Note that setting multiple bits may cause extra network round-trips. */
1114   CINIT(HTTPAUTH, LONG, 107),
1115
1116   /* Set the ssl context callback function, currently only for OpenSSL ssl_ctx
1117      in second argument. The function must be matching the
1118      curl_ssl_ctx_callback proto. */
1119   CINIT(SSL_CTX_FUNCTION, FUNCTIONPOINT, 108),
1120
1121   /* Set the userdata for the ssl context callback function's third
1122      argument */
1123   CINIT(SSL_CTX_DATA, OBJECTPOINT, 109),
1124
1125   /* FTP Option that causes missing dirs to be created on the remote server.
1126      In 7.19.4 we introduced the convenience enums for this option using the
1127      CURLFTP_CREATE_DIR prefix.
1128   */
1129   CINIT(FTP_CREATE_MISSING_DIRS, LONG, 110),
1130
1131   /* Set this to a bitmask value to enable the particular authentications
1132      methods you like. Use this in combination with CURLOPT_PROXYUSERPWD.
1133      Note that setting multiple bits may cause extra network round-trips. */
1134   CINIT(PROXYAUTH, LONG, 111),
1135
1136   /* FTP option that changes the timeout, in seconds, associated with
1137      getting a response.  This is different from transfer timeout time and
1138      essentially places a demand on the FTP server to acknowledge commands
1139      in a timely manner. */
1140   CINIT(FTP_RESPONSE_TIMEOUT, LONG, 112),
1141 #define CURLOPT_SERVER_RESPONSE_TIMEOUT CURLOPT_FTP_RESPONSE_TIMEOUT
1142
1143   /* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to
1144      tell libcurl to resolve names to those IP versions only. This only has
1145      affect on systems with support for more than one, i.e IPv4 _and_ IPv6. */
1146   CINIT(IPRESOLVE, LONG, 113),
1147
1148   /* Set this option to limit the size of a file that will be downloaded from
1149      an HTTP or FTP server.
1150
1151      Note there is also _LARGE version which adds large file support for
1152      platforms which have larger off_t sizes.  See MAXFILESIZE_LARGE below. */
1153   CINIT(MAXFILESIZE, LONG, 114),
1154
1155   /* See the comment for INFILESIZE above, but in short, specifies
1156    * the size of the file being uploaded.  -1 means unknown.
1157    */
1158   CINIT(INFILESIZE_LARGE, OFF_T, 115),
1159
1160   /* Sets the continuation offset.  There is also a LONG version of this;
1161    * look above for RESUME_FROM.
1162    */
1163   CINIT(RESUME_FROM_LARGE, OFF_T, 116),
1164
1165   /* Sets the maximum size of data that will be downloaded from
1166    * an HTTP or FTP server.  See MAXFILESIZE above for the LONG version.
1167    */
1168   CINIT(MAXFILESIZE_LARGE, OFF_T, 117),
1169
1170   /* Set this option to the file name of your .netrc file you want libcurl
1171      to parse (using the CURLOPT_NETRC option). If not set, libcurl will do
1172      a poor attempt to find the user's home directory and check for a .netrc
1173      file in there. */
1174   CINIT(NETRC_FILE, OBJECTPOINT, 118),
1175
1176   /* Enable SSL/TLS for FTP, pick one of:
1177      CURLFTPSSL_TRY     - try using SSL, proceed anyway otherwise
1178      CURLFTPSSL_CONTROL - SSL for the control connection or fail
1179      CURLFTPSSL_ALL     - SSL for all communication or fail
1180   */
1181   CINIT(USE_SSL, LONG, 119),
1182
1183   /* The _LARGE version of the standard POSTFIELDSIZE option */
1184   CINIT(POSTFIELDSIZE_LARGE, OFF_T, 120),
1185
1186   /* Enable/disable the TCP Nagle algorithm */
1187   CINIT(TCP_NODELAY, LONG, 121),
1188
1189   /* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1190   /* 123 OBSOLETE. Gone in 7.16.0 */
1191   /* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1192   /* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1193   /* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1194   /* 127 OBSOLETE. Gone in 7.16.0 */
1195   /* 128 OBSOLETE. Gone in 7.16.0 */
1196
1197   /* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option
1198      can be used to change libcurl's default action which is to first try
1199      "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK
1200      response has been received.
1201
1202      Available parameters are:
1203      CURLFTPAUTH_DEFAULT - let libcurl decide
1204      CURLFTPAUTH_SSL     - try "AUTH SSL" first, then TLS
1205      CURLFTPAUTH_TLS     - try "AUTH TLS" first, then SSL
1206   */
1207   CINIT(FTPSSLAUTH, LONG, 129),
1208
1209   CINIT(IOCTLFUNCTION, FUNCTIONPOINT, 130),
1210   CINIT(IOCTLDATA, OBJECTPOINT, 131),
1211
1212   /* 132 OBSOLETE. Gone in 7.16.0 */
1213   /* 133 OBSOLETE. Gone in 7.16.0 */
1214
1215   /* zero terminated string for pass on to the FTP server when asked for
1216      "account" info */
1217   CINIT(FTP_ACCOUNT, OBJECTPOINT, 134),
1218
1219   /* feed cookies into cookie engine */
1220   CINIT(COOKIELIST, OBJECTPOINT, 135),
1221
1222   /* ignore Content-Length */
1223   CINIT(IGNORE_CONTENT_LENGTH, LONG, 136),
1224
1225   /* Set to non-zero to skip the IP address received in a 227 PASV FTP server
1226      response. Typically used for FTP-SSL purposes but is not restricted to
1227      that. libcurl will then instead use the same IP address it used for the
1228      control connection. */
1229   CINIT(FTP_SKIP_PASV_IP, LONG, 137),
1230
1231   /* Select "file method" to use when doing FTP, see the curl_ftpmethod
1232      above. */
1233   CINIT(FTP_FILEMETHOD, LONG, 138),
1234
1235   /* Local port number to bind the socket to */
1236   CINIT(LOCALPORT, LONG, 139),
1237
1238   /* Number of ports to try, including the first one set with LOCALPORT.
1239      Thus, setting it to 1 will make no additional attempts but the first.
1240   */
1241   CINIT(LOCALPORTRANGE, LONG, 140),
1242
1243   /* no transfer, set up connection and let application use the socket by
1244      extracting it with CURLINFO_LASTSOCKET */
1245   CINIT(CONNECT_ONLY, LONG, 141),
1246
1247   /* Function that will be called to convert from the
1248      network encoding (instead of using the iconv calls in libcurl) */
1249   CINIT(CONV_FROM_NETWORK_FUNCTION, FUNCTIONPOINT, 142),
1250
1251   /* Function that will be called to convert to the
1252      network encoding (instead of using the iconv calls in libcurl) */
1253   CINIT(CONV_TO_NETWORK_FUNCTION, FUNCTIONPOINT, 143),
1254
1255   /* Function that will be called to convert from UTF8
1256      (instead of using the iconv calls in libcurl)
1257      Note that this is used only for SSL certificate processing */
1258   CINIT(CONV_FROM_UTF8_FUNCTION, FUNCTIONPOINT, 144),
1259
1260   /* if the connection proceeds too quickly then need to slow it down */
1261   /* limit-rate: maximum number of bytes per second to send or receive */
1262   CINIT(MAX_SEND_SPEED_LARGE, OFF_T, 145),
1263   CINIT(MAX_RECV_SPEED_LARGE, OFF_T, 146),
1264
1265   /* Pointer to command string to send if USER/PASS fails. */
1266   CINIT(FTP_ALTERNATIVE_TO_USER, OBJECTPOINT, 147),
1267
1268   /* callback function for setting socket options */
1269   CINIT(SOCKOPTFUNCTION, FUNCTIONPOINT, 148),
1270   CINIT(SOCKOPTDATA, OBJECTPOINT, 149),
1271
1272   /* set to 0 to disable session ID re-use for this transfer, default is
1273      enabled (== 1) */
1274   CINIT(SSL_SESSIONID_CACHE, LONG, 150),
1275
1276   /* allowed SSH authentication methods */
1277   CINIT(SSH_AUTH_TYPES, LONG, 151),
1278
1279   /* Used by scp/sftp to do public/private key authentication */
1280   CINIT(SSH_PUBLIC_KEYFILE, OBJECTPOINT, 152),
1281   CINIT(SSH_PRIVATE_KEYFILE, OBJECTPOINT, 153),
1282
1283   /* Send CCC (Clear Command Channel) after authentication */
1284   CINIT(FTP_SSL_CCC, LONG, 154),
1285
1286   /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */
1287   CINIT(TIMEOUT_MS, LONG, 155),
1288   CINIT(CONNECTTIMEOUT_MS, LONG, 156),
1289
1290   /* set to zero to disable the libcurl's decoding and thus pass the raw body
1291      data to the application even when it is encoded/compressed */
1292   CINIT(HTTP_TRANSFER_DECODING, LONG, 157),
1293   CINIT(HTTP_CONTENT_DECODING, LONG, 158),
1294
1295   /* Permission used when creating new files and directories on the remote
1296      server for protocols that support it, SFTP/SCP/FILE */
1297   CINIT(NEW_FILE_PERMS, LONG, 159),
1298   CINIT(NEW_DIRECTORY_PERMS, LONG, 160),
1299
1300   /* Set the behaviour of POST when redirecting. Values must be set to one
1301      of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */
1302   CINIT(POSTREDIR, LONG, 161),
1303
1304   /* used by scp/sftp to verify the host's public key */
1305   CINIT(SSH_HOST_PUBLIC_KEY_MD5, OBJECTPOINT, 162),
1306
1307   /* Callback function for opening socket (instead of socket(2)). Optionally,
1308      callback is able change the address or refuse to connect returning
1309      CURL_SOCKET_BAD.  The callback should have type
1310      curl_opensocket_callback */
1311   CINIT(OPENSOCKETFUNCTION, FUNCTIONPOINT, 163),
1312   CINIT(OPENSOCKETDATA, OBJECTPOINT, 164),
1313
1314   /* POST volatile input fields. */
1315   CINIT(COPYPOSTFIELDS, OBJECTPOINT, 165),
1316
1317   /* set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy */
1318   CINIT(PROXY_TRANSFER_MODE, LONG, 166),
1319
1320   /* Callback function for seeking in the input stream */
1321   CINIT(SEEKFUNCTION, FUNCTIONPOINT, 167),
1322   CINIT(SEEKDATA, OBJECTPOINT, 168),
1323
1324   /* CRL file */
1325   CINIT(CRLFILE, OBJECTPOINT, 169),
1326
1327   /* Issuer certificate */
1328   CINIT(ISSUERCERT, OBJECTPOINT, 170),
1329
1330   /* (IPv6) Address scope */
1331   CINIT(ADDRESS_SCOPE, LONG, 171),
1332
1333   /* Collect certificate chain info and allow it to get retrievable with
1334      CURLINFO_CERTINFO after the transfer is complete. (Unfortunately) only
1335      working with OpenSSL-powered builds. */
1336   CINIT(CERTINFO, LONG, 172),
1337
1338   /* "name" and "pwd" to use when fetching. */
1339   CINIT(USERNAME, OBJECTPOINT, 173),
1340   CINIT(PASSWORD, OBJECTPOINT, 174),
1341
1342     /* "name" and "pwd" to use with Proxy when fetching. */
1343   CINIT(PROXYUSERNAME, OBJECTPOINT, 175),
1344   CINIT(PROXYPASSWORD, OBJECTPOINT, 176),
1345
1346   /* Comma separated list of hostnames defining no-proxy zones. These should
1347      match both hostnames directly, and hostnames within a domain. For
1348      example, local.com will match local.com and www.local.com, but NOT
1349      notlocal.com or www.notlocal.com. For compatibility with other
1350      implementations of this, .local.com will be considered to be the same as
1351      local.com. A single * is the only valid wildcard, and effectively
1352      disables the use of proxy. */
1353   CINIT(NOPROXY, OBJECTPOINT, 177),
1354
1355   /* block size for TFTP transfers */
1356   CINIT(TFTP_BLKSIZE, LONG, 178),
1357
1358   /* Socks Service */
1359   CINIT(SOCKS5_GSSAPI_SERVICE, OBJECTPOINT, 179),
1360
1361   /* Socks Service */
1362   CINIT(SOCKS5_GSSAPI_NEC, LONG, 180),
1363
1364   /* set the bitmask for the protocols that are allowed to be used for the
1365      transfer, which thus helps the app which takes URLs from users or other
1366      external inputs and want to restrict what protocol(s) to deal
1367      with. Defaults to CURLPROTO_ALL. */
1368   CINIT(PROTOCOLS, LONG, 181),
1369
1370   /* set the bitmask for the protocols that libcurl is allowed to follow to,
1371      as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs
1372      to be set in both bitmasks to be allowed to get redirected to. Defaults
1373      to all protocols except FILE and SCP. */
1374   CINIT(REDIR_PROTOCOLS, LONG, 182),
1375
1376   /* set the SSH knownhost file name to use */
1377   CINIT(SSH_KNOWNHOSTS, OBJECTPOINT, 183),
1378
1379   /* set the SSH host key callback, must point to a curl_sshkeycallback
1380      function */
1381   CINIT(SSH_KEYFUNCTION, FUNCTIONPOINT, 184),
1382
1383   /* set the SSH host key callback custom pointer */
1384   CINIT(SSH_KEYDATA, OBJECTPOINT, 185),
1385
1386   /* set the SMTP mail originator */
1387   CINIT(MAIL_FROM, OBJECTPOINT, 186),
1388
1389   /* set the SMTP mail receiver(s) */
1390   CINIT(MAIL_RCPT, OBJECTPOINT, 187),
1391
1392   /* FTP: send PRET before PASV */
1393   CINIT(FTP_USE_PRET, LONG, 188),
1394
1395   /* RTSP request method (OPTIONS, SETUP, PLAY, etc...) */
1396   CINIT(RTSP_REQUEST, LONG, 189),
1397
1398   /* The RTSP session identifier */
1399   CINIT(RTSP_SESSION_ID, OBJECTPOINT, 190),
1400
1401   /* The RTSP stream URI */
1402   CINIT(RTSP_STREAM_URI, OBJECTPOINT, 191),
1403
1404   /* The Transport: header to use in RTSP requests */
1405   CINIT(RTSP_TRANSPORT, OBJECTPOINT, 192),
1406
1407   /* Manually initialize the client RTSP CSeq for this handle */
1408   CINIT(RTSP_CLIENT_CSEQ, LONG, 193),
1409
1410   /* Manually initialize the server RTSP CSeq for this handle */
1411   CINIT(RTSP_SERVER_CSEQ, LONG, 194),
1412
1413   /* The stream to pass to INTERLEAVEFUNCTION. */
1414   CINIT(INTERLEAVEDATA, OBJECTPOINT, 195),
1415
1416   /* Let the application define a custom write method for RTP data */
1417   CINIT(INTERLEAVEFUNCTION, FUNCTIONPOINT, 196),
1418
1419   /* Turn on wildcard matching */
1420   CINIT(WILDCARDMATCH, LONG, 197),
1421
1422   /* Directory matching callback called before downloading of an
1423      individual file (chunk) started */
1424   CINIT(CHUNK_BGN_FUNCTION, FUNCTIONPOINT, 198),
1425
1426   /* Directory matching callback called after the file (chunk)
1427      was downloaded, or skipped */
1428   CINIT(CHUNK_END_FUNCTION, FUNCTIONPOINT, 199),
1429
1430   /* Change match (fnmatch-like) callback for wildcard matching */
1431   CINIT(FNMATCH_FUNCTION, FUNCTIONPOINT, 200),
1432
1433   /* Let the application define custom chunk data pointer */
1434   CINIT(CHUNK_DATA, OBJECTPOINT, 201),
1435
1436   /* FNMATCH_FUNCTION user pointer */
1437   CINIT(FNMATCH_DATA, OBJECTPOINT, 202),
1438
1439   CURLOPT_LASTENTRY /* the last unused */
1440 } CURLoption;
1441
1442 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all
1443                           the obsolete stuff removed! */
1444
1445 /* Backwards compatibility with older names */
1446 /* These are scheduled to disappear by 2011 */
1447
1448 /* This was added in version 7.19.1 */
1449 #define CURLOPT_POST301 CURLOPT_POSTREDIR
1450
1451 /* These are scheduled to disappear by 2009 */
1452
1453 /* The following were added in 7.17.0 */
1454 #define CURLOPT_SSLKEYPASSWD CURLOPT_KEYPASSWD
1455 #define CURLOPT_FTPAPPEND CURLOPT_APPEND
1456 #define CURLOPT_FTPLISTONLY CURLOPT_DIRLISTONLY
1457 #define CURLOPT_FTP_SSL CURLOPT_USE_SSL
1458
1459 /* The following were added earlier */
1460
1461 #define CURLOPT_SSLCERTPASSWD CURLOPT_KEYPASSWD
1462 #define CURLOPT_KRB4LEVEL CURLOPT_KRBLEVEL
1463
1464 #else
1465 /* This is set if CURL_NO_OLDIES is defined at compile-time */
1466 #undef CURLOPT_DNS_USE_GLOBAL_CACHE /* soon obsolete */
1467 #endif
1468
1469
1470   /* Below here follows defines for the CURLOPT_IPRESOLVE option. If a host
1471      name resolves addresses using more than one IP protocol version, this
1472      option might be handy to force libcurl to use a specific IP version. */
1473 #define CURL_IPRESOLVE_WHATEVER 0 /* default, resolves addresses to all IP
1474                                      versions that your system allows */
1475 #define CURL_IPRESOLVE_V4       1 /* resolve to ipv4 addresses */
1476 #define CURL_IPRESOLVE_V6       2 /* resolve to ipv6 addresses */
1477
1478   /* three convenient "aliases" that follow the name scheme better */
1479 #define CURLOPT_WRITEDATA CURLOPT_FILE
1480 #define CURLOPT_READDATA  CURLOPT_INFILE
1481 #define CURLOPT_HEADERDATA CURLOPT_WRITEHEADER
1482 #define CURLOPT_RTSPHEADER CURLOPT_HTTPHEADER
1483
1484   /* These enums are for use with the CURLOPT_HTTP_VERSION option. */
1485 enum {
1486   CURL_HTTP_VERSION_NONE, /* setting this means we don't care, and that we'd
1487                              like the library to choose the best possible
1488                              for us! */
1489   CURL_HTTP_VERSION_1_0,  /* please use HTTP 1.0 in the request */
1490   CURL_HTTP_VERSION_1_1,  /* please use HTTP 1.1 in the request */
1491
1492   CURL_HTTP_VERSION_LAST /* *ILLEGAL* http version */
1493 };
1494
1495 /*
1496  * Public API enums for RTSP requests
1497  */
1498 enum {
1499     CURL_RTSPREQ_NONE, /* first in list */
1500     CURL_RTSPREQ_OPTIONS,
1501     CURL_RTSPREQ_DESCRIBE,
1502     CURL_RTSPREQ_ANNOUNCE,
1503     CURL_RTSPREQ_SETUP,
1504     CURL_RTSPREQ_PLAY,
1505     CURL_RTSPREQ_PAUSE,
1506     CURL_RTSPREQ_TEARDOWN,
1507     CURL_RTSPREQ_GET_PARAMETER,
1508     CURL_RTSPREQ_SET_PARAMETER,
1509     CURL_RTSPREQ_RECORD,
1510     CURL_RTSPREQ_RECEIVE,
1511     CURL_RTSPREQ_LAST /* last in list */
1512 };
1513
1514   /* These enums are for use with the CURLOPT_NETRC option. */
1515 enum CURL_NETRC_OPTION {
1516   CURL_NETRC_IGNORED,     /* The .netrc will never be read.
1517                            * This is the default. */
1518   CURL_NETRC_OPTIONAL,    /* A user:password in the URL will be preferred
1519                            * to one in the .netrc. */
1520   CURL_NETRC_REQUIRED,    /* A user:password in the URL will be ignored.
1521                            * Unless one is set programmatically, the .netrc
1522                            * will be queried. */
1523   CURL_NETRC_LAST
1524 };
1525
1526 enum {
1527   CURL_SSLVERSION_DEFAULT,
1528   CURL_SSLVERSION_TLSv1,
1529   CURL_SSLVERSION_SSLv2,
1530   CURL_SSLVERSION_SSLv3,
1531
1532   CURL_SSLVERSION_LAST /* never use, keep last */
1533 };
1534
1535 /* symbols to use with CURLOPT_POSTREDIR.
1536    CURL_REDIR_POST_301 and CURL_REDIR_POST_302 can be bitwise ORed so that
1537    CURL_REDIR_POST_301 | CURL_REDIR_POST_302 == CURL_REDIR_POST_ALL */
1538
1539 #define CURL_REDIR_GET_ALL  0
1540 #define CURL_REDIR_POST_301 1
1541 #define CURL_REDIR_POST_302 2
1542 #define CURL_REDIR_POST_ALL (CURL_REDIR_POST_301|CURL_REDIR_POST_302)
1543
1544 typedef enum {
1545   CURL_TIMECOND_NONE,
1546
1547   CURL_TIMECOND_IFMODSINCE,
1548   CURL_TIMECOND_IFUNMODSINCE,
1549   CURL_TIMECOND_LASTMOD,
1550
1551   CURL_TIMECOND_LAST
1552 } curl_TimeCond;
1553
1554
1555 /* curl_strequal() and curl_strnequal() are subject for removal in a future
1556    libcurl, see lib/README.curlx for details */
1557 CURL_EXTERN int (curl_strequal)(const char *s1, const char *s2);
1558 CURL_EXTERN int (curl_strnequal)(const char *s1, const char *s2, size_t n);
1559
1560 /* name is uppercase CURLFORM_<name> */
1561 #ifdef CFINIT
1562 #undef CFINIT
1563 #endif
1564
1565 #ifdef CURL_ISOCPP
1566 #define CFINIT(name) CURLFORM_ ## name
1567 #else
1568 /* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */
1569 #define CFINIT(name) CURLFORM_/**/name
1570 #endif
1571
1572 typedef enum {
1573   CFINIT(NOTHING),        /********* the first one is unused ************/
1574
1575   /*  */
1576   CFINIT(COPYNAME),
1577   CFINIT(PTRNAME),
1578   CFINIT(NAMELENGTH),
1579   CFINIT(COPYCONTENTS),
1580   CFINIT(PTRCONTENTS),
1581   CFINIT(CONTENTSLENGTH),
1582   CFINIT(FILECONTENT),
1583   CFINIT(ARRAY),
1584   CFINIT(OBSOLETE),
1585   CFINIT(FILE),
1586
1587   CFINIT(BUFFER),
1588   CFINIT(BUFFERPTR),
1589   CFINIT(BUFFERLENGTH),
1590
1591   CFINIT(CONTENTTYPE),
1592   CFINIT(CONTENTHEADER),
1593   CFINIT(FILENAME),
1594   CFINIT(END),
1595   CFINIT(OBSOLETE2),
1596
1597   CFINIT(STREAM),
1598
1599   CURLFORM_LASTENTRY /* the last unused */
1600 } CURLformoption;
1601
1602 #undef CFINIT /* done */
1603
1604 /* structure to be used as parameter for CURLFORM_ARRAY */
1605 struct curl_forms {
1606   CURLformoption option;
1607   const char     *value;
1608 };
1609
1610 /* use this for multipart formpost building */
1611 /* Returns code for curl_formadd()
1612  *
1613  * Returns:
1614  * CURL_FORMADD_OK             on success
1615  * CURL_FORMADD_MEMORY         if the FormInfo allocation fails
1616  * CURL_FORMADD_OPTION_TWICE   if one option is given twice for one Form
1617  * CURL_FORMADD_NULL           if a null pointer was given for a char
1618  * CURL_FORMADD_MEMORY         if the allocation of a FormInfo struct failed
1619  * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used
1620  * CURL_FORMADD_INCOMPLETE     if the some FormInfo is not complete (or error)
1621  * CURL_FORMADD_MEMORY         if a curl_httppost struct cannot be allocated
1622  * CURL_FORMADD_MEMORY         if some allocation for string copying failed.
1623  * CURL_FORMADD_ILLEGAL_ARRAY  if an illegal option is used in an array
1624  *
1625  ***************************************************************************/
1626 typedef enum {
1627   CURL_FORMADD_OK, /* first, no error */
1628
1629   CURL_FORMADD_MEMORY,
1630   CURL_FORMADD_OPTION_TWICE,
1631   CURL_FORMADD_NULL,
1632   CURL_FORMADD_UNKNOWN_OPTION,
1633   CURL_FORMADD_INCOMPLETE,
1634   CURL_FORMADD_ILLEGAL_ARRAY,
1635   CURL_FORMADD_DISABLED, /* libcurl was built with this disabled */
1636
1637   CURL_FORMADD_LAST /* last */
1638 } CURLFORMcode;
1639
1640 /*
1641  * NAME curl_formadd()
1642  *
1643  * DESCRIPTION
1644  *
1645  * Pretty advanced function for building multi-part formposts. Each invoke
1646  * adds one part that together construct a full post. Then use
1647  * CURLOPT_HTTPPOST to send it off to libcurl.
1648  */
1649 CURL_EXTERN CURLFORMcode curl_formadd(struct curl_httppost **httppost,
1650                                       struct curl_httppost **last_post,
1651                                       ...);
1652
1653 /*
1654  * callback function for curl_formget()
1655  * The void *arg pointer will be the one passed as second argument to
1656  *   curl_formget().
1657  * The character buffer passed to it must not be freed.
1658  * Should return the buffer length passed to it as the argument "len" on
1659  *   success.
1660  */
1661 typedef size_t (*curl_formget_callback)(void *arg, const char *buf, size_t len);
1662
1663 /*
1664  * NAME curl_formget()
1665  *
1666  * DESCRIPTION
1667  *
1668  * Serialize a curl_httppost struct built with curl_formadd().
1669  * Accepts a void pointer as second argument which will be passed to
1670  * the curl_formget_callback function.
1671  * Returns 0 on success.
1672  */
1673 CURL_EXTERN int curl_formget(struct curl_httppost *form, void *arg,
1674                              curl_formget_callback append);
1675 /*
1676  * NAME curl_formfree()
1677  *
1678  * DESCRIPTION
1679  *
1680  * Free a multipart formpost previously built with curl_formadd().
1681  */
1682 CURL_EXTERN void curl_formfree(struct curl_httppost *form);
1683
1684 /*
1685  * NAME curl_getenv()
1686  *
1687  * DESCRIPTION
1688  *
1689  * Returns a malloc()'ed string that MUST be curl_free()ed after usage is
1690  * complete. DEPRECATED - see lib/README.curlx
1691  */
1692 CURL_EXTERN char *curl_getenv(const char *variable);
1693
1694 /*
1695  * NAME curl_version()
1696  *
1697  * DESCRIPTION
1698  *
1699  * Returns a static ascii string of the libcurl version.
1700  */
1701 CURL_EXTERN char *curl_version(void);
1702
1703 /*
1704  * NAME curl_easy_escape()
1705  *
1706  * DESCRIPTION
1707  *
1708  * Escapes URL strings (converts all letters consider illegal in URLs to their
1709  * %XX versions). This function returns a new allocated string or NULL if an
1710  * error occurred.
1711  */
1712 CURL_EXTERN char *curl_easy_escape(CURL *handle,
1713                                    const char *string,
1714                                    int length);
1715
1716 /* the previous version: */
1717 CURL_EXTERN char *curl_escape(const char *string,
1718                               int length);
1719
1720
1721 /*
1722  * NAME curl_easy_unescape()
1723  *
1724  * DESCRIPTION
1725  *
1726  * Unescapes URL encoding in strings (converts all %XX codes to their 8bit
1727  * versions). This function returns a new allocated string or NULL if an error
1728  * occurred.
1729  * Conversion Note: On non-ASCII platforms the ASCII %XX codes are
1730  * converted into the host encoding.
1731  */
1732 CURL_EXTERN char *curl_easy_unescape(CURL *handle,
1733                                      const char *string,
1734                                      int length,
1735                                      int *outlength);
1736
1737 /* the previous version */
1738 CURL_EXTERN char *curl_unescape(const char *string,
1739                                 int length);
1740
1741 /*
1742  * NAME curl_free()
1743  *
1744  * DESCRIPTION
1745  *
1746  * Provided for de-allocation in the same translation unit that did the
1747  * allocation. Added in libcurl 7.10
1748  */
1749 CURL_EXTERN void curl_free(void *p);
1750
1751 /*
1752  * NAME curl_global_init()
1753  *
1754  * DESCRIPTION
1755  *
1756  * curl_global_init() should be invoked exactly once for each application that
1757  * uses libcurl and before any call of other libcurl functions.
1758  *
1759  * This function is not thread-safe!
1760  */
1761 CURL_EXTERN CURLcode curl_global_init(long flags);
1762
1763 /*
1764  * NAME curl_global_init_mem()
1765  *
1766  * DESCRIPTION
1767  *
1768  * curl_global_init() or curl_global_init_mem() should be invoked exactly once
1769  * for each application that uses libcurl.  This function can be used to
1770  * initialize libcurl and set user defined memory management callback
1771  * functions.  Users can implement memory management routines to check for
1772  * memory leaks, check for mis-use of the curl library etc.  User registered
1773  * callback routines with be invoked by this library instead of the system
1774  * memory management routines like malloc, free etc.
1775  */
1776 CURL_EXTERN CURLcode curl_global_init_mem(long flags,
1777                                           curl_malloc_callback m,
1778                                           curl_free_callback f,
1779                                           curl_realloc_callback r,
1780                                           curl_strdup_callback s,
1781                                           curl_calloc_callback c);
1782
1783 /*
1784  * NAME curl_global_cleanup()
1785  *
1786  * DESCRIPTION
1787  *
1788  * curl_global_cleanup() should be invoked exactly once for each application
1789  * that uses libcurl
1790  */
1791 CURL_EXTERN void curl_global_cleanup(void);
1792
1793 /* linked-list structure for the CURLOPT_QUOTE option (and other) */
1794 struct curl_slist {
1795   char *data;
1796   struct curl_slist *next;
1797 };
1798
1799 /*
1800  * NAME curl_slist_append()
1801  *
1802  * DESCRIPTION
1803  *
1804  * Appends a string to a linked list. If no list exists, it will be created
1805  * first. Returns the new list, after appending.
1806  */
1807 CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *,
1808                                                  const char *);
1809
1810 /*
1811  * NAME curl_slist_free_all()
1812  *
1813  * DESCRIPTION
1814  *
1815  * free a previously built curl_slist.
1816  */
1817 CURL_EXTERN void curl_slist_free_all(struct curl_slist *);
1818
1819 /*
1820  * NAME curl_getdate()
1821  *
1822  * DESCRIPTION
1823  *
1824  * Returns the time, in seconds since 1 Jan 1970 of the time string given in
1825  * the first argument. The time argument in the second parameter is unused
1826  * and should be set to NULL.
1827  */
1828 CURL_EXTERN time_t curl_getdate(const char *p, const time_t *unused);
1829
1830 /* info about the certificate chain, only for OpenSSL builds. Asked
1831    for with CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1832 struct curl_certinfo {
1833   int num_of_certs;             /* number of certificates with information */
1834   struct curl_slist **certinfo; /* for each index in this array, there's a
1835                                    linked list with textual information in the
1836                                    format "name: value" */
1837 };
1838
1839 #define CURLINFO_STRING   0x100000
1840 #define CURLINFO_LONG     0x200000
1841 #define CURLINFO_DOUBLE   0x300000
1842 #define CURLINFO_SLIST    0x400000
1843 #define CURLINFO_MASK     0x0fffff
1844 #define CURLINFO_TYPEMASK 0xf00000
1845
1846 typedef enum {
1847   CURLINFO_NONE, /* first, never use this */
1848   CURLINFO_EFFECTIVE_URL    = CURLINFO_STRING + 1,
1849   CURLINFO_RESPONSE_CODE    = CURLINFO_LONG   + 2,
1850   CURLINFO_TOTAL_TIME       = CURLINFO_DOUBLE + 3,
1851   CURLINFO_NAMELOOKUP_TIME  = CURLINFO_DOUBLE + 4,
1852   CURLINFO_CONNECT_TIME     = CURLINFO_DOUBLE + 5,
1853   CURLINFO_PRETRANSFER_TIME = CURLINFO_DOUBLE + 6,
1854   CURLINFO_SIZE_UPLOAD      = CURLINFO_DOUBLE + 7,
1855   CURLINFO_SIZE_DOWNLOAD    = CURLINFO_DOUBLE + 8,
1856   CURLINFO_SPEED_DOWNLOAD   = CURLINFO_DOUBLE + 9,
1857   CURLINFO_SPEED_UPLOAD     = CURLINFO_DOUBLE + 10,
1858   CURLINFO_HEADER_SIZE      = CURLINFO_LONG   + 11,
1859   CURLINFO_REQUEST_SIZE     = CURLINFO_LONG   + 12,
1860   CURLINFO_SSL_VERIFYRESULT = CURLINFO_LONG   + 13,
1861   CURLINFO_FILETIME         = CURLINFO_LONG   + 14,
1862   CURLINFO_CONTENT_LENGTH_DOWNLOAD   = CURLINFO_DOUBLE + 15,
1863   CURLINFO_CONTENT_LENGTH_UPLOAD     = CURLINFO_DOUBLE + 16,
1864   CURLINFO_STARTTRANSFER_TIME = CURLINFO_DOUBLE + 17,
1865   CURLINFO_CONTENT_TYPE     = CURLINFO_STRING + 18,
1866   CURLINFO_REDIRECT_TIME    = CURLINFO_DOUBLE + 19,
1867   CURLINFO_REDIRECT_COUNT   = CURLINFO_LONG   + 20,
1868   CURLINFO_PRIVATE          = CURLINFO_STRING + 21,
1869   CURLINFO_HTTP_CONNECTCODE = CURLINFO_LONG   + 22,
1870   CURLINFO_HTTPAUTH_AVAIL   = CURLINFO_LONG   + 23,
1871   CURLINFO_PROXYAUTH_AVAIL  = CURLINFO_LONG   + 24,
1872   CURLINFO_OS_ERRNO         = CURLINFO_LONG   + 25,
1873   CURLINFO_NUM_CONNECTS     = CURLINFO_LONG   + 26,
1874   CURLINFO_SSL_ENGINES      = CURLINFO_SLIST  + 27,
1875   CURLINFO_COOKIELIST       = CURLINFO_SLIST  + 28,
1876   CURLINFO_LASTSOCKET       = CURLINFO_LONG   + 29,
1877   CURLINFO_FTP_ENTRY_PATH   = CURLINFO_STRING + 30,
1878   CURLINFO_REDIRECT_URL     = CURLINFO_STRING + 31,
1879   CURLINFO_PRIMARY_IP       = CURLINFO_STRING + 32,
1880   CURLINFO_APPCONNECT_TIME  = CURLINFO_DOUBLE + 33,
1881   CURLINFO_CERTINFO         = CURLINFO_SLIST  + 34,
1882   CURLINFO_CONDITION_UNMET  = CURLINFO_LONG   + 35,
1883   CURLINFO_RTSP_SESSION_ID  = CURLINFO_STRING + 36,
1884   CURLINFO_RTSP_CLIENT_CSEQ = CURLINFO_LONG   + 37,
1885   CURLINFO_RTSP_SERVER_CSEQ = CURLINFO_LONG   + 38,
1886   CURLINFO_RTSP_CSEQ_RECV   = CURLINFO_LONG   + 39,
1887   CURLINFO_PRIMARY_PORT     = CURLINFO_LONG   + 40,
1888   CURLINFO_LOCAL_IP         = CURLINFO_STRING + 41,
1889   CURLINFO_LOCAL_PORT       = CURLINFO_LONG   + 42,
1890   /* Fill in new entries below here! */
1891
1892   CURLINFO_LASTONE          = 42
1893 } CURLINFO;
1894
1895 /* CURLINFO_RESPONSE_CODE is the new name for the option previously known as
1896    CURLINFO_HTTP_CODE */
1897 #define CURLINFO_HTTP_CODE CURLINFO_RESPONSE_CODE
1898
1899 typedef enum {
1900   CURLCLOSEPOLICY_NONE, /* first, never use this */
1901
1902   CURLCLOSEPOLICY_OLDEST,
1903   CURLCLOSEPOLICY_LEAST_RECENTLY_USED,
1904   CURLCLOSEPOLICY_LEAST_TRAFFIC,
1905   CURLCLOSEPOLICY_SLOWEST,
1906   CURLCLOSEPOLICY_CALLBACK,
1907
1908   CURLCLOSEPOLICY_LAST /* last, never use this */
1909 } curl_closepolicy;
1910
1911 #define CURL_GLOBAL_SSL (1<<0)
1912 #define CURL_GLOBAL_WIN32 (1<<1)
1913 #define CURL_GLOBAL_ALL (CURL_GLOBAL_SSL|CURL_GLOBAL_WIN32)
1914 #define CURL_GLOBAL_NOTHING 0
1915 #define CURL_GLOBAL_DEFAULT CURL_GLOBAL_ALL
1916
1917
1918 /*****************************************************************************
1919  * Setup defines, protos etc for the sharing stuff.
1920  */
1921
1922 /* Different data locks for a single share */
1923 typedef enum {
1924   CURL_LOCK_DATA_NONE = 0,
1925   /*  CURL_LOCK_DATA_SHARE is used internally to say that
1926    *  the locking is just made to change the internal state of the share
1927    *  itself.
1928    */
1929   CURL_LOCK_DATA_SHARE,
1930   CURL_LOCK_DATA_COOKIE,
1931   CURL_LOCK_DATA_DNS,
1932   CURL_LOCK_DATA_SSL_SESSION,
1933   CURL_LOCK_DATA_CONNECT,
1934   CURL_LOCK_DATA_LAST
1935 } curl_lock_data;
1936
1937 /* Different lock access types */
1938 typedef enum {
1939   CURL_LOCK_ACCESS_NONE = 0,   /* unspecified action */
1940   CURL_LOCK_ACCESS_SHARED = 1, /* for read perhaps */
1941   CURL_LOCK_ACCESS_SINGLE = 2, /* for write perhaps */
1942   CURL_LOCK_ACCESS_LAST        /* never use */
1943 } curl_lock_access;
1944
1945 typedef void (*curl_lock_function)(CURL *handle,
1946                                    curl_lock_data data,
1947                                    curl_lock_access locktype,
1948                                    void *userptr);
1949 typedef void (*curl_unlock_function)(CURL *handle,
1950                                      curl_lock_data data,
1951                                      void *userptr);
1952
1953 typedef void CURLSH;
1954
1955 typedef enum {
1956   CURLSHE_OK,  /* all is fine */
1957   CURLSHE_BAD_OPTION, /* 1 */
1958   CURLSHE_IN_USE,     /* 2 */
1959   CURLSHE_INVALID,    /* 3 */
1960   CURLSHE_NOMEM,      /* out of memory */
1961   CURLSHE_LAST /* never use */
1962 } CURLSHcode;
1963
1964 typedef enum {
1965   CURLSHOPT_NONE,  /* don't use */
1966   CURLSHOPT_SHARE,   /* specify a data type to share */
1967   CURLSHOPT_UNSHARE, /* specify which data type to stop sharing */
1968   CURLSHOPT_LOCKFUNC,   /* pass in a 'curl_lock_function' pointer */
1969   CURLSHOPT_UNLOCKFUNC, /* pass in a 'curl_unlock_function' pointer */
1970   CURLSHOPT_USERDATA,   /* pass in a user data pointer used in the lock/unlock
1971                            callback functions */
1972   CURLSHOPT_LAST  /* never use */
1973 } CURLSHoption;
1974
1975 CURL_EXTERN CURLSH *curl_share_init(void);
1976 CURL_EXTERN CURLSHcode curl_share_setopt(CURLSH *, CURLSHoption option, ...);
1977 CURL_EXTERN CURLSHcode curl_share_cleanup(CURLSH *);
1978
1979 /****************************************************************************
1980  * Structures for querying information about the curl library at runtime.
1981  */
1982
1983 typedef enum {
1984   CURLVERSION_FIRST,
1985   CURLVERSION_SECOND,
1986   CURLVERSION_THIRD,
1987   CURLVERSION_FOURTH,
1988   CURLVERSION_LAST /* never actually use this */
1989 } CURLversion;
1990
1991 /* The 'CURLVERSION_NOW' is the symbolic name meant to be used by
1992    basically all programs ever that want to get version information. It is
1993    meant to be a built-in version number for what kind of struct the caller
1994    expects. If the struct ever changes, we redefine the NOW to another enum
1995    from above. */
1996 #define CURLVERSION_NOW CURLVERSION_FOURTH
1997
1998 typedef struct {
1999   CURLversion age;          /* age of the returned struct */
2000   const char *version;      /* LIBCURL_VERSION */
2001   unsigned int version_num; /* LIBCURL_VERSION_NUM */
2002   const char *host;         /* OS/host/cpu/machine when configured */
2003   int features;             /* bitmask, see defines below */
2004   const char *ssl_version;  /* human readable string */
2005   long ssl_version_num;     /* not used anymore, always 0 */
2006   const char *libz_version; /* human readable string */
2007   /* protocols is terminated by an entry with a NULL protoname */
2008   const char * const *protocols;
2009
2010   /* The fields below this were added in CURLVERSION_SECOND */
2011   const char *ares;
2012   int ares_num;
2013
2014   /* This field was added in CURLVERSION_THIRD */
2015   const char *libidn;
2016
2017   /* These field were added in CURLVERSION_FOURTH */
2018
2019   /* Same as '_libiconv_version' if built with HAVE_ICONV */
2020   int iconv_ver_num;
2021
2022   const char *libssh_version; /* human readable string */
2023
2024 } curl_version_info_data;
2025
2026 #define CURL_VERSION_IPV6      (1<<0)  /* IPv6-enabled */
2027 #define CURL_VERSION_KERBEROS4 (1<<1)  /* kerberos auth is supported */
2028 #define CURL_VERSION_SSL       (1<<2)  /* SSL options are present */
2029 #define CURL_VERSION_LIBZ      (1<<3)  /* libz features are present */
2030 #define CURL_VERSION_NTLM      (1<<4)  /* NTLM auth is supported */
2031 #define CURL_VERSION_GSSNEGOTIATE (1<<5) /* Negotiate auth support */
2032 #define CURL_VERSION_DEBUG     (1<<6)  /* built with debug capabilities */
2033 #define CURL_VERSION_ASYNCHDNS (1<<7)  /* asynchronous dns resolves */
2034 #define CURL_VERSION_SPNEGO    (1<<8)  /* SPNEGO auth */
2035 #define CURL_VERSION_LARGEFILE (1<<9)  /* supports files bigger than 2GB */
2036 #define CURL_VERSION_IDN       (1<<10) /* International Domain Names support */
2037 #define CURL_VERSION_SSPI      (1<<11) /* SSPI is supported */
2038 #define CURL_VERSION_CONV      (1<<12) /* character conversions supported */
2039 #define CURL_VERSION_CURLDEBUG (1<<13) /* debug memory tracking supported */
2040
2041 /*
2042  * NAME curl_version_info()
2043  *
2044  * DESCRIPTION
2045  *
2046  * This function returns a pointer to a static copy of the version info
2047  * struct. See above.
2048  */
2049 CURL_EXTERN curl_version_info_data *curl_version_info(CURLversion);
2050
2051 /*
2052  * NAME curl_easy_strerror()
2053  *
2054  * DESCRIPTION
2055  *
2056  * The curl_easy_strerror function may be used to turn a CURLcode value
2057  * into the equivalent human readable error string.  This is useful
2058  * for printing meaningful error messages.
2059  */
2060 CURL_EXTERN const char *curl_easy_strerror(CURLcode);
2061
2062 /*
2063  * NAME curl_share_strerror()
2064  *
2065  * DESCRIPTION
2066  *
2067  * The curl_share_strerror function may be used to turn a CURLSHcode value
2068  * into the equivalent human readable error string.  This is useful
2069  * for printing meaningful error messages.
2070  */
2071 CURL_EXTERN const char *curl_share_strerror(CURLSHcode);
2072
2073 /*
2074  * NAME curl_easy_pause()
2075  *
2076  * DESCRIPTION
2077  *
2078  * The curl_easy_pause function pauses or unpauses transfers. Select the new
2079  * state by setting the bitmask, use the convenience defines below.
2080  *
2081  */
2082 CURL_EXTERN CURLcode curl_easy_pause(CURL *handle, int bitmask);
2083
2084 #define CURLPAUSE_RECV      (1<<0)
2085 #define CURLPAUSE_RECV_CONT (0)
2086
2087 #define CURLPAUSE_SEND      (1<<2)
2088 #define CURLPAUSE_SEND_CONT (0)
2089
2090 #define CURLPAUSE_ALL       (CURLPAUSE_RECV|CURLPAUSE_SEND)
2091 #define CURLPAUSE_CONT      (CURLPAUSE_RECV_CONT|CURLPAUSE_SEND_CONT)
2092
2093 #ifdef  __cplusplus
2094 }
2095 #endif
2096
2097 /* unfortunately, the easy.h and multi.h include files need options and info
2098   stuff before they can be included! */
2099 #include "easy.h" /* nothing in curl is fun without the easy stuff */
2100 #include "multi.h"
2101
2102 /* the typechecker doesn't work in C++ (yet) */
2103 #if defined(__GNUC__) && defined(__GNUC_MINOR__) && \
2104     ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && \
2105     !defined(__cplusplus) && !defined(CURL_DISABLE_TYPECHECK)
2106 #include "typecheck-gcc.h"
2107 #else
2108 #if defined(__STDC__) && (__STDC__ >= 1)
2109 /* This preprocessor magic that replaces a call with the exact same call is
2110    only done to make sure application authors pass exactly three arguments
2111    to these functions. */
2112 #define curl_easy_setopt(handle,opt,param) curl_easy_setopt(handle,opt,param)
2113 #define curl_easy_getinfo(handle,info,arg) curl_easy_getinfo(handle,info,arg)
2114 #define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param)
2115 #define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param)
2116 #endif /* __STDC__ >= 1 */
2117 #endif /* gcc >= 4.3 && !__cplusplus */
2118
2119 #endif /* __CURL_CURL_H */