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