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