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