4 * Copyright (c) 2003-2008, Lars Nilsson, <lars@quantumchamaeleon.com>
5 * Copyright (c) 2009, ygrek, <ygrek@autistici.org>
16 | CURLE_UNSUPPORTED_PROTOCOL
19 | CURLE_URL_MALFORMAT_USER
20 | CURLE_COULDNT_RESOLVE_PROXY
21 | CURLE_COULDNT_RESOLVE_HOST
22 | CURLE_COULDNT_CONNECT
23 | CURLE_FTP_WEIRD_SERVER_REPLY
24 | CURLE_FTP_ACCESS_DENIED
25 | CURLE_FTP_USER_PASSWORD_INCORRECT
26 | CURLE_FTP_WEIRD_PASS_REPLY
27 | CURLE_FTP_WEIRD_USER_REPLY
28 | CURLE_FTP_WEIRD_PASV_REPLY
29 | CURLE_FTP_WEIRD_227_FORMAT
30 | CURLE_FTP_CANT_GET_HOST
31 | CURLE_FTP_CANT_RECONNECT
32 | CURLE_FTP_COULDNT_SET_BINARY
34 | CURLE_FTP_COULDNT_RETR_FILE
35 | CURLE_FTP_WRITE_ERROR
36 | CURLE_FTP_QUOTE_ERROR
37 | CURLE_HTTP_NOT_FOUND
39 | CURLE_MALFORMAT_USER
40 | CURLE_FTP_COULDNT_STOR_FILE
43 | CURLE_OPERATION_TIMEOUTED
44 | CURLE_FTP_COULDNT_SET_ASCII
45 | CURLE_FTP_PORT_FAILED
46 | CURLE_FTP_COULDNT_USE_REST
47 | CURLE_FTP_COULDNT_GET_SIZE
48 | CURLE_HTTP_RANGE_ERROR
49 | CURLE_HTTP_POST_ERROR
50 | CURLE_SSL_CONNECT_ERROR
51 | CURLE_FTP_BAD_DOWNLOAD_RESUME
52 | CURLE_FILE_COULDNT_READ_FILE
53 | CURLE_LDAP_CANNOT_BIND
54 | CURLE_LDAP_SEARCH_FAILED
55 | CURLE_LIBRARY_NOT_FOUND
56 | CURLE_FUNCTION_NOT_FOUND
57 | CURLE_ABORTED_BY_CALLBACK
58 | CURLE_BAD_FUNCTION_ARGUMENT
59 | CURLE_BAD_CALLING_ORDER
60 | CURLE_HTTP_PORT_FAILED
61 | CURLE_BAD_PASSWORD_ENTERED
62 | CURLE_TOO_MANY_REDIRECTS
63 | CURLE_UNKNOWN_TELNET_OPTION
64 | CURLE_TELNET_OPTION_SYNTAX
66 | CURLE_SSL_PEER_CERTIFICATE
68 | CURLE_SSL_ENGINE_NOTFOUND
69 | CURLE_SSL_ENGINE_SETFAILED
73 | CURLE_SSL_CERTPROBLEM
76 | CURLE_BAD_CONTENT_ENCODING
77 | CURLE_LDAP_INVALID_URL
78 | CURLE_FILESIZE_EXCEEDED
79 | CURLE_USE_SSL_FAILED
80 | CURLE_SEND_FAIL_REWIND
81 | CURLE_SSL_ENGINE_INITFAILED
85 | CURLE_REMOTE_DISK_FULL
87 | CURLE_TFTP_UNKNOWNID
88 | CURLE_REMOTE_FILE_EXISTS
89 | CURLE_TFTP_NOSUCHUSER
92 | CURLE_SSL_CACERT_BADFILE
93 | CURLE_REMOTE_FILE_NOT_FOUND
95 | CURLE_SSL_SHUTDOWN_FAILED
98 exception CurlException
of (curlCode
* int * string)
100 (** exception raised when trying to use options missing from libcurl headers,
101 argument is the option name *)
102 exception NotImplemented
of string
104 type curlNETRCOption
=
105 | CURL_NETRC_OPTIONAL
107 | CURL_NETRC_REQUIRED
110 | CURL_ENCODING_NONE
(* identity *)
111 | CURL_ENCODING_DEFLATE
(* deflate *)
112 | CURL_ENCODING_GZIP
(* gzip *)
113 | CURL_ENCODING_ANY
(* all supported encodings *)
115 type curlContentType
=
117 | CONTENTTYPE
of string
120 | CURLFORM_CONTENT
of string * string * curlContentType
121 | CURLFORM_FILECONTENT
of string * string * curlContentType
122 | CURLFORM_FILE
of string * string * curlContentType
123 | CURLFORM_BUFFER
of string * string * string * curlContentType
127 | CURLFORM_COPYNAME of string
128 | CURLFORM_PTRNAME of string
129 | CURLFORM_NAMELENGTH of int
130 | CURLFORM_COPYCONTENTS of string
131 | CURLFORM_PTRCONTENTS of string
132 | CURLFORM_FILE of string
133 | CURLFORM_FILECONTENT of string
134 | CURLFORM_CONTENTSLENGTH of int
135 | CURLFORM_CONTENTTYPE of string
138 type curlSSLVersion
=
139 | SSLVERSION_DEFAULT
(** attempt to figure out the remote SSL protocol version *)
140 | SSLVERSION_TLSv1
(** TLSv1.x *)
141 | SSLVERSION_SSLv2
(** SSLv2 *)
142 | SSLVERSION_SSLv3
(** SSLv3 *)
143 | SSLVERSION_TLSv1_0
(** Added in libcurl 7.34.0, will request TLSv1.x in previous versions *)
144 | SSLVERSION_TLSv1_1
(** Added in libcurl 7.34.0, will request TLSv1.x in previous versions *)
145 | SSLVERSION_TLSv1_2
(** Added in libcurl 7.34.0, will request TLSv1.x in previous versions *)
146 | SSLVERSION_TLSv1_3
(** Added in libcurl 7.52.0, will request TLSv1.x in previous versions *)
148 type curlTimeCondition
=
149 | TIMECOND_NONE
(** since 0.6.1 *)
150 | TIMECOND_IFMODSINCE
151 | TIMECOND_IFUNMODSINCE
152 | TIMECOND_LASTMOD
(** since 0.6.1 *)
161 type curlClosePolicy
=
163 | CLOSEPOLICY_LEAST_RECENTLY_USED
165 type curlSSLVerifyHost
=
166 | SSLVERIFYHOST_NONE
(** connection succeeds regardless of the names in the certificate *)
167 | SSLVERIFYHOST_EXISTENCE
(** deprecated, equivalent to SSLVERIFYHOST_HOSTNAME *)
168 | SSLVERIFYHOST_HOSTNAME
(** certificate must indicate the matching hostname, or the connection fails *)
170 type curlHTTPVersion
=
171 | HTTP_VERSION_NONE
(** libcurl will make the best choice *)
172 | HTTP_VERSION_1_0
(** please use HTTP 1.0 *)
173 | HTTP_VERSION_1_1
(** please use HTTP 1.1 *)
174 | HTTP_VERSION_2
(** please use HTTP 2 (requires libcurl >= 7.33.0, otherwise will fallback to libcurl choice) *)
175 | HTTP_VERSION_2TLS
(** use version 2 for HTTPS, version 1.1 for HTTP (requires libcurl >= 7.47.0) *)
176 | HTTP_VERSION_2_PRIOR_KNOWLEDGE
(** Issue non-TLS HTTP requests using HTTP/2 without HTTP/1 (requires libcurl >= 7.49.0) *)
180 | DEBUGTYPE_HEADER_IN
181 | DEBUGTYPE_HEADER_OUT
184 | DEBUGTYPE_SSL_DATA_IN
185 | DEBUGTYPE_SSL_DATA_OUT
191 | CURLAUTH_GSSNEGOTIATE
207 type curlFTPSSLAuth
=
221 type curlSeekResult
=
230 | FTPMETHOD_SINGLECWD
232 type curlSSHAuthTypes
=
251 | CURLPROXY_HTTP_1_0
(** since libcurl 7.19.4 *)
252 | CURLPROXY_SOCKS4
(** since libcurl 7.15.2 *)
254 | CURLPROXY_SOCKS4A
(** since libcurl 7.18.0 *)
255 | CURLPROXY_SOCKS5_HOSTNAME
(** since libcurl 7.18.0 *)
257 type curlMIMEPartData
=
258 | CURLMIME_DATA
of string
259 | CURLMIME_FILEDATA
of string
261 type curlMIMEEncoding
=
265 | CURLMIME_QUOTEDPRINTABLE
271 encoding
: curlMIMEEncoding
;
272 headers
: string list
;
273 subparts
: curlMIMEPart list
;
274 data
: curlMIMEPartData
;
279 | CURLKHMATCH_MISMATCH
of string
280 (** Argument consists of the base64-encoded public key of the remote host as
281 as found in the "known hosts" file **)
282 | CURLKHMATCH_MISSING
285 | CURLKHSTAT_FINE_ADD_TO_FILE
290 (** Protocols to enable (via CURLOPT_PROTOCOLS and CURLOPT_REDIR_PROTOCOLS) *)
292 | CURLPROTO_ALL
(** enable everything *)
320 (** if flag is not supported by libcurl - enabling it does nothing *)
325 | REDIR_POST_303
(** added in libcurl 7.26.0 *)
328 | CURLOPT_WRITEFUNCTION
of (string -> int)
329 | CURLOPT_READFUNCTION
of (int -> string)
330 | CURLOPT_INFILESIZE
of int
331 | CURLOPT_URL
of string
332 | CURLOPT_PROXY
of string
333 | CURLOPT_PROXYPORT
of int
334 | CURLOPT_HTTPPROXYTUNNEL
of bool
335 | CURLOPT_VERBOSE
of bool
336 | CURLOPT_HEADER
of bool
337 | CURLOPT_NOPROGRESS
of bool
338 | CURLOPT_NOSIGNAL
of bool
339 | CURLOPT_NOBODY
of bool
340 | CURLOPT_FAILONERROR
of bool
341 | CURLOPT_UPLOAD
of bool
342 | CURLOPT_POST
of bool
343 | CURLOPT_FTPLISTONLY
of bool
344 | CURLOPT_FTPAPPEND
of bool
345 | CURLOPT_NETRC
of curlNETRCOption
346 | CURLOPT_ENCODING
of curlEncoding
347 | CURLOPT_FOLLOWLOCATION
of bool
348 | CURLOPT_TRANSFERTEXT
of bool
349 | CURLOPT_PUT
of bool
350 | CURLOPT_USERPWD
of string
351 | CURLOPT_PROXYUSERPWD
of string
352 | CURLOPT_RANGE
of string
353 | CURLOPT_ERRORBUFFER
of string ref
354 | CURLOPT_TIMEOUT
of int
355 | CURLOPT_POSTFIELDS
of string
356 | CURLOPT_POSTFIELDSIZE
of int
357 | CURLOPT_REFERER
of string
358 | CURLOPT_USERAGENT
of string
359 | CURLOPT_FTPPORT
of string
360 | CURLOPT_LOWSPEEDLIMIT
of int
361 | CURLOPT_LOWSPEEDTIME
of int
362 | CURLOPT_RESUMEFROM
of int
363 | CURLOPT_COOKIE
of string
364 | CURLOPT_HTTPHEADER
of string list
365 | CURLOPT_HTTPPOST
of curlHTTPPost list
366 | CURLOPT_SSLCERT
of string
367 | CURLOPT_SSLCERTTYPE
of string
368 | CURLOPT_SSLCERTPASSWD
of string
369 | CURLOPT_SSLKEY
of string
370 | CURLOPT_SSLKEYTYPE
of string
371 | CURLOPT_SSLKEYPASSWD
of string
372 | CURLOPT_SSLENGINE
of string
373 | CURLOPT_SSLENGINEDEFAULT
of bool
374 | CURLOPT_CRLF
of bool
375 | CURLOPT_QUOTE
of string list
376 | CURLOPT_POSTQUOTE
of string list
377 | CURLOPT_HEADERFUNCTION
of (string -> int)
378 | CURLOPT_COOKIEFILE
of string
379 | CURLOPT_SSLVERSION
of curlSSLVersion
380 | CURLOPT_TIMECONDITION
of curlTimeCondition
381 | CURLOPT_TIMEVALUE
of int32
382 | CURLOPT_CUSTOMREQUEST
of string
383 | CURLOPT_INTERFACE
of string
384 | CURLOPT_KRB4LEVEL
of curlKRB4Level
385 | CURLOPT_PROGRESSFUNCTION
of (float -> float -> float -> float -> bool)
386 | CURLOPT_SSLVERIFYPEER
of bool
387 | CURLOPT_CAINFO
of string
388 | CURLOPT_CAPATH
of string
389 | CURLOPT_FILETIME
of bool
390 | CURLOPT_MAXREDIRS
of int
391 | CURLOPT_MAXCONNECTS
of int
392 | CURLOPT_CLOSEPOLICY
of curlClosePolicy
393 | CURLOPT_FRESHCONNECT
of bool
394 | CURLOPT_FORBIDREUSE
of bool
395 | CURLOPT_RANDOMFILE
of string
396 | CURLOPT_EGDSOCKET
of string
397 | CURLOPT_CONNECTTIMEOUT
of int
398 | CURLOPT_HTTPGET
of bool
399 | CURLOPT_SSLVERIFYHOST
of curlSSLVerifyHost
400 | CURLOPT_COOKIEJAR
of string
401 | CURLOPT_SSLCIPHERLIST
of string
402 | CURLOPT_HTTPVERSION
of curlHTTPVersion
403 | CURLOPT_FTPUSEEPSV
of bool
404 | CURLOPT_DNSCACHETIMEOUT
of int
405 | CURLOPT_DNSUSEGLOBALCACHE
of bool
406 | CURLOPT_DEBUGFUNCTION
of (t
-> curlDebugType
-> string -> unit)
407 | CURLOPT_PRIVATE
of string (** doesn't employ libcurl's CURLOPT_PRIVATE *)
408 | CURLOPT_HTTP200ALIASES
of string list
409 | CURLOPT_UNRESTRICTEDAUTH
of bool
410 | CURLOPT_FTPUSEEPRT
of bool
411 | CURLOPT_HTTPAUTH
of curlAuth list
412 | CURLOPT_FTPCREATEMISSINGDIRS
of bool
413 | CURLOPT_PROXYAUTH
of curlAuth list
414 | CURLOPT_FTPRESPONSETIMEOUT
of int
415 | CURLOPT_IPRESOLVE
of curlIPResolve
416 | CURLOPT_MAXFILESIZE
of int32
417 | CURLOPT_INFILESIZELARGE
of int64
418 | CURLOPT_RESUMEFROMLARGE
of int64
419 | CURLOPT_MAXFILESIZELARGE
of int64
420 | CURLOPT_NETRCFILE
of string
421 | CURLOPT_FTPSSL
of curlFTPSSL
422 | CURLOPT_POSTFIELDSIZELARGE
of int64
423 | CURLOPT_TCPNODELAY
of bool
424 | CURLOPT_FTPSSLAUTH
of curlFTPSSLAuth
425 | CURLOPT_IOCTLFUNCTION
of (t
-> curlIOCmd
-> curlIOErr
)
426 | CURLOPT_FTPACCOUNT
of string
427 | CURLOPT_COOKIELIST
of string
428 | CURLOPT_IGNORECONTENTLENGTH
of bool
429 | CURLOPT_FTPSKIPPASVIP
of bool
430 | CURLOPT_FTPFILEMETHOD
of curlFTPMethod
431 | CURLOPT_LOCALPORT
of int
432 | CURLOPT_LOCALPORTRANGE
of int
433 | CURLOPT_CONNECTONLY
of bool
434 | CURLOPT_MAXSENDSPEEDLARGE
of int64
435 | CURLOPT_MAXRECVSPEEDLARGE
of int64
436 | CURLOPT_FTPALTERNATIVETOUSER
of string
437 | CURLOPT_SSLSESSIONIDCACHE
of bool
438 | CURLOPT_SSHAUTHTYPES
of curlSSHAuthTypes list
439 | CURLOPT_SSHPUBLICKEYFILE
of string
440 | CURLOPT_SSHPRIVATEKEYFILE
of string
441 | CURLOPT_FTPSSLCCC
of curlFTPSSLCCC
442 | CURLOPT_TIMEOUTMS
of int
443 | CURLOPT_CONNECTTIMEOUTMS
of int
444 | CURLOPT_HTTPTRANSFERDECODING
of bool
445 | CURLOPT_HTTPCONTENTDECODING
of bool
446 | CURLOPT_NEWFILEPERMS
of int
447 | CURLOPT_NEWDIRECTORYPERMS
of int
448 | CURLOPT_POST301
of bool
449 | CURLOPT_SSHHOSTPUBLICKEYMD5
of string
450 | CURLOPT_COPYPOSTFIELDS
of string
451 | CURLOPT_PROXYTRANSFERMODE
of bool
452 | CURLOPT_SEEKFUNCTION
of (int64
-> curlSeek
-> curlSeekResult
)
453 | CURLOPT_AUTOREFERER
of bool
454 | CURLOPT_OPENSOCKETFUNCTION
of (Unix.file_descr
-> unit)
455 | CURLOPT_PROXYTYPE
of curlProxyType
456 | CURLOPT_PROTOCOLS
of curlProto list
457 | CURLOPT_REDIR_PROTOCOLS
of curlProto list
458 | CURLOPT_RESOLVE
of string list
459 | CURLOPT_DNS_SERVERS
of string
460 | CURLOPT_MAIL_FROM
of string
461 | CURLOPT_MAIL_RCPT
of string list
462 | CURLOPT_PIPEWAIT
of bool
463 | CURLOPT_CERTINFO
of bool
464 | CURLOPT_USERNAME
of string
465 | CURLOPT_PASSWORD
of string
466 | CURLOPT_LOGIN_OPTIONS
of string
467 | CURLOPT_CONNECT_TO
of string list
468 | CURLOPT_POSTREDIR
of curlPostRedir list
469 | CURLOPT_MIMEPOST
of curlMIMEPart list
(* @since libcurl 7.56.0 *)
470 | CURLOPT_SSHKNOWNHOSTS
of string
471 | CURLOPT_SSHKEYFUNCTION
of (curlKHMatch
-> string -> curlKHStat
)
472 (** The second argument to the passed function consists of the raw bytes of
473 the public key sent by the remote host. If the function raises an
474 exception the key will be rejected, and the connection will fail.**)
479 | CURLINIT_GLOBALWIN32
480 | CURLINIT_GLOBALNOTHING
483 | CURLINFO_EFFECTIVE_URL
485 | CURLINFO_RESPONSE_CODE
486 | CURLINFO_TOTAL_TIME
487 | CURLINFO_NAMELOOKUP_TIME
488 | CURLINFO_CONNECT_TIME
489 | CURLINFO_PRETRANSFER_TIME
490 | CURLINFO_SIZE_UPLOAD
491 | CURLINFO_SIZE_DOWNLOAD
492 | CURLINFO_SPEED_DOWNLOAD
493 | CURLINFO_SPEED_UPLOAD
494 | CURLINFO_HEADER_SIZE
495 | CURLINFO_REQUEST_SIZE
496 | CURLINFO_SSL_VERIFYRESULT
498 | CURLINFO_CONTENT_LENGTH_DOWNLOAD
499 | CURLINFO_CONTENT_LENGTH_UPLOAD
500 | CURLINFO_STARTTRANSFER_TIME
501 | CURLINFO_CONTENT_TYPE
502 | CURLINFO_REDIRECT_TIME
503 | CURLINFO_REDIRECT_COUNT
504 | CURLINFO_PRIVATE
(** returns value previously set with CURLOPT_PRIVATE, doesn't employ libcurl's CURLINFO_PRIVATE *)
505 | CURLINFO_HTTP_CONNECTCODE
506 | CURLINFO_HTTPAUTH_AVAIL
507 | CURLINFO_PROXYAUTH_AVAIL
509 | CURLINFO_NUM_CONNECTS
510 | CURLINFO_SSL_ENGINES
511 | CURLINFO_COOKIELIST
512 | CURLINFO_LASTSOCKET
513 | CURLINFO_FTP_ENTRY_PATH
514 | CURLINFO_REDIRECT_URL
515 | CURLINFO_PRIMARY_IP
517 | CURLINFO_LOCAL_PORT
518 | CURLINFO_CONDITION_UNMET
521 type curlInfoResult
=
522 | CURLINFO_String
of string
523 | CURLINFO_Long
of int
524 | CURLINFO_Double
of float
525 | CURLINFO_StringList
of string list
526 | CURLINFO_StringListList
of string list list
528 type version_info
= {
530 number
: int * int * int;
532 features
: string list
;
533 ssl_version
: string option;
534 libz_version
: string option;
535 protocols
: string list
;
536 ares
: string; (** starting from this field are optional features - may be empty/zero *)
540 libssh_version
: string;
543 type pauseOption
= PAUSE_SEND
| PAUSE_RECV
| PAUSE_ALL
545 (** {2 curl_easy API} *)
547 val global_init
: initOption
-> unit
548 val global_cleanup
: unit -> unit
550 val reset
: t
-> unit
551 (** Reset [t] to the default state *)
552 val setopt
: t
-> curlOption
-> unit
553 (** @raise NotImplemented for not implemented option *)
554 val perform
: t
-> unit
555 val cleanup
: t
-> unit
556 val getinfo
: t
-> curlInfo
-> curlInfoResult
557 val escape
: string -> string
558 val unescape
: string -> string
559 val getdate
: string -> float -> float
560 val version
: unit -> string
561 val strerror
: curlCode
-> string
562 val int_of_curlCode
: curlCode
-> int
563 val curlCode_of_int
: int -> curlCode
option
564 (** same as [int_of_curlCode] *)
565 val errno
: curlCode
-> int
566 val version_info
: unit -> version_info
567 val pause
: t
-> pauseOption list
-> unit
569 (** {2 Set transfer options}
571 All callback functions shouldn't raise exceptions.
572 Any exception raised in callback function will be silently caught and discared,
573 and transfer will be aborted. *)
575 val set_writefunction
: t
-> (string -> int) -> unit
576 val set_readfunction
: t
-> (int -> string) -> unit
577 (** [readfunction n] should return string of length at most [n], otherwise
578 transfer will be aborted (as if with exception) *)
579 val set_infilesize
: t
-> int -> unit
580 val set_url
: t
-> string -> unit
581 val set_proxy
: t
-> string -> unit
582 val set_proxyport
: t
-> int -> unit
583 val set_httpproxytunnel
: t
-> bool -> unit
584 val set_verbose
: t
-> bool -> unit
585 val set_header
: t
-> bool -> unit
586 val set_noprogress
: t
-> bool -> unit
587 val set_nosignal
: t
-> bool -> unit
588 val set_nobody
: t
-> bool -> unit
589 val set_failonerror
: t
-> bool -> unit
590 val set_upload
: t
-> bool -> unit
591 val set_post
: t
-> bool -> unit
592 val set_ftplistonly
: t
-> bool -> unit
593 val set_ftpappend
: t
-> bool -> unit
594 val set_netrc
: t
-> curlNETRCOption
-> unit
595 val set_encoding
: t
-> curlEncoding
-> unit
596 val set_followlocation
: t
-> bool -> unit
597 val set_transfertext
: t
-> bool -> unit
598 val set_put
: t
-> bool -> unit
599 val set_userpwd
: t
-> string -> unit
600 val set_proxyuserpwd
: t
-> string -> unit
601 val set_range
: t
-> string -> unit
602 val set_errorbuffer
: t
-> string ref -> unit
603 val set_timeout
: t
-> int -> unit
604 val set_postfields
: t
-> string -> unit
605 val set_postfieldsize
: t
-> int -> unit
606 val set_referer
: t
-> string -> unit
607 val set_useragent
: t
-> string -> unit
608 val set_ftpport
: t
-> string -> unit
609 val set_lowspeedlimit
: t
-> int -> unit
610 val set_lowspeedtime
: t
-> int -> unit
611 val set_resumefrom
: t
-> int -> unit
612 val set_cookie
: t
-> string -> unit
613 val set_httpheader
: t
-> string list
-> unit
614 val set_httppost
: t
-> curlHTTPPost list
-> unit
615 val set_sslcert
: t
-> string -> unit
616 val set_sslcerttype
: t
-> string -> unit
617 val set_sslcertpasswd
: t
-> string -> unit
618 val set_sslkey
: t
-> string -> unit
619 val set_sslkeytype
: t
-> string -> unit
620 val set_sslkeypasswd
: t
-> string -> unit
621 val set_sslengine
: t
-> string -> unit
622 val set_sslenginedefault
: t
-> bool -> unit
623 val set_certinfo
: t
-> bool -> unit
624 val set_crlf
: t
-> bool -> unit
625 val set_quote
: t
-> string list
-> unit
626 val set_postquote
: t
-> string list
-> unit
627 val set_headerfunction
: t
-> (string -> int) -> unit
628 val set_cookiefile
: t
-> string -> unit
629 val set_sslversion
: t
-> curlSSLVersion
-> unit
630 val set_timecondition
: t
-> curlTimeCondition
-> unit
631 val set_timevalue
: t
-> int32
-> unit
632 val set_customrequest
: t
-> string -> unit
633 val set_interface
: t
-> string -> unit
634 val set_krb4level
: t
-> curlKRB4Level
-> unit
635 val set_progressfunction
: t
-> (float -> float -> float -> float -> bool) -> unit
636 val set_sslverifypeer
: t
-> bool -> unit
637 val set_cainfo
: t
-> string -> unit
638 val set_capath
: t
-> string -> unit
639 val set_filetime
: t
-> bool -> unit
640 val set_maxredirs
: t
-> int -> unit
641 val set_maxconnects
: t
-> int -> unit
642 val set_closepolicy
: t
-> curlClosePolicy
-> unit
643 val set_freshconnect
: t
-> bool -> unit
644 val set_forbidreuse
: t
-> bool -> unit
645 val set_randomfile
: t
-> string -> unit
646 val set_egdsocket
: t
-> string -> unit
647 val set_connecttimeout
: t
-> int -> unit
648 val set_httpget
: t
-> bool -> unit
649 val set_sslverifyhost
: t
-> curlSSLVerifyHost
-> unit
650 val set_cookiejar
: t
-> string -> unit
651 val set_sslcipherlist
: t
-> string -> unit
652 val set_httpversion
: t
-> curlHTTPVersion
-> unit
653 val set_ftpuseepsv
: t
-> bool -> unit
654 val set_dnscachetimeout
: t
-> int -> unit
655 val set_dnsuseglobalcache
: t
-> bool -> unit
656 val set_debugfunction
: t
-> (t
-> curlDebugType
-> string -> unit) -> unit
657 val set_private
: t
-> string -> unit
658 val set_http200aliases
: t
-> string list
-> unit
659 val set_unrestrictedauth
: t
-> bool -> unit
660 val set_ftpuseeprt
: t
-> bool -> unit
661 val set_httpauth
: t
-> curlAuth list
-> unit
662 val set_ftpcreatemissingdirs
: t
-> bool -> unit
663 val set_proxyauth
: t
-> curlAuth list
-> unit
664 val set_ftpresponsetimeout
: t
-> int -> unit
665 val set_ipresolve
: t
-> curlIPResolve
-> unit
666 val set_maxfilesize
: t
-> int32
-> unit
667 val set_infilesizelarge
: t
-> int64
-> unit
668 val set_resumefromlarge
: t
-> int64
-> unit
669 val set_maxfilesizelarge
: t
-> int64
-> unit
670 val set_netrcfile
: t
-> string -> unit
671 val set_ftpssl
: t
-> curlFTPSSL
-> unit
672 val set_postfieldsizelarge
: t
-> int64
-> unit
673 val set_tcpnodelay
: t
-> bool -> unit
674 val set_ftpsslauth
: t
-> curlFTPSSLAuth
-> unit
675 val set_ioctlfunction
: t
-> (t
-> curlIOCmd
-> curlIOErr
) -> unit
676 val set_ftpaccount
: t
-> string -> unit
677 val set_cookielist
: t
-> string -> unit
678 val set_ignorecontentlength
: t
-> bool -> unit
679 val set_ftpskippasvip
: t
-> bool -> unit
680 val set_ftpfilemethod
: t
-> curlFTPMethod
-> unit
681 val set_localport
: t
-> int -> unit
682 val set_localportrange
: t
-> int -> unit
683 val set_connectonly
: t
-> bool -> unit
684 val set_maxsendspeedlarge
: t
-> int64
-> unit
685 val set_maxrecvspeedlarge
: t
-> int64
-> unit
686 val set_ftpalternativetouser
: t
-> string -> unit
687 val set_sslsessionidcache
: t
-> bool -> unit
688 val set_sshauthtypes
: t
-> curlSSHAuthTypes list
-> unit
689 val set_sshpublickeyfile
: t
-> string -> unit
690 val set_sshprivatekeyfile
: t
-> string -> unit
691 val set_ftpsslccc
: t
-> curlFTPSSLCCC
-> unit
692 val set_timeoutms
: t
-> int -> unit
693 val set_connecttimeoutms
: t
-> int -> unit
694 val set_httptransferdecoding
: t
-> bool -> unit
695 val set_httpcontentdecoding
: t
-> bool -> unit
696 val set_newfileperms
: t
-> int -> unit
697 val set_newdirectoryperms
: t
-> int -> unit
698 val set_post301
: t
-> bool -> unit
699 val set_sshhostpublickeymd5
: t
-> string -> unit
700 val set_copypostfields
: t
-> string -> unit
701 val set_proxytransfermode
: t
-> bool -> unit
702 val set_seekfunction
: t
-> (int64
-> curlSeek
-> curlSeekResult
) -> unit
703 val set_autoreferer
: t
-> bool -> unit
704 val set_opensocketfunction
: t
-> (Unix.file_descr
-> unit) -> unit
705 val set_proxytype
: t
-> curlProxyType
-> unit
706 val set_protocols
: t
-> curlProto list
-> unit
707 val set_redirprotocols
: t
-> curlProto list
-> unit
709 (** [set_resolve t add del] adjusts builtin dns mapping
711 @param add is the (host,port,address) list to add to dns mapping
712 @param del is the (host,port) list to remove from mapping
714 val set_resolve
: t
-> (string * int * string) list
-> (string * int) list
-> unit
715 val set_dns_servers
: t
-> string list
-> unit
716 val set_mailfrom
: t
-> string -> unit
717 val set_mailrcpt
: t
-> string list
-> unit
718 val set_pipewait
: t
-> bool -> unit
719 val set_username
: t
-> string -> unit
721 val set_password
: t
-> string -> unit
723 val set_login_options
: t
-> string -> unit
725 val set_connect_to
: t
-> string list
-> unit
727 val set_postredir
: t
-> curlPostRedir list
-> unit
729 val set_mimepost
: t
-> curlMIMEPart list
-> unit
732 val set_sshknownhosts
: t
-> string -> unit
733 val set_sshkeyfunction
: t
-> (curlKHMatch
-> string -> curlKHStat
) -> unit
735 (** {2 Get transfer properties} *)
737 val get_effectiveurl
: t
-> string
738 val get_redirecturl
: t
-> string
739 val get_httpcode
: t
-> int
740 val get_responsecode
: t
-> int
741 val get_totaltime
: t
-> float
742 val get_namelookuptime
: t
-> float
743 val get_connecttime
: t
-> float
744 val get_pretransfertime
: t
-> float
745 val get_sizeupload
: t
-> float
746 val get_sizedownload
: t
-> float
747 val get_speeddownload
: t
-> float
748 val get_speedupload
: t
-> float
749 val get_headersize
: t
-> int
750 val get_requestsize
: t
-> int
751 val get_sslverifyresult
: t
-> int
752 val get_filetime
: t
-> float
753 val get_contentlengthdownload
: t
-> float
754 val get_contentlengthupload
: t
-> float
755 val get_starttransfertime
: t
-> float
756 val get_contenttype
: t
-> string
757 val get_redirecttime
: t
-> float
758 val get_redirectcount
: t
-> int
759 val get_private
: t
-> string
760 val get_httpconnectcode
: t
-> int
761 val get_httpauthavail
: t
-> curlAuth list
762 val get_proxyauthavail
: t
-> curlAuth list
763 val get_oserrno
: t
-> int
764 val get_numconnects
: t
-> int
765 val get_sslengines
: t
-> string list
766 val get_cookielist
: t
-> string list
767 val get_lastsocket
: t
-> int
768 val get_ftpentrypath
: t
-> string
769 val get_primaryip
: t
-> string
770 val get_localip
: t
-> string
771 (** @since 0.5.5 (libcurl 7.21.0) *)
772 val get_localport
: t
-> int
773 (** @since 0.5.5 (libcurl 7.21.0) *)
774 val get_conditionunmet
: t
-> bool
775 (** @since 0.6.1 (libcurl 7.19.4) *)
776 val get_certinfo
: t
-> string list list
778 (** {2 Object interface} *)
784 method cleanup
: unit
785 method perform
: unit
787 method set_writefunction
: (string -> int) -> unit
788 method set_readfunction
: (int -> string) -> unit
789 method set_infilesize
: int -> unit
790 method set_url
: string -> unit
791 method set_proxy
: string -> unit
792 method set_proxyport
: int -> unit
793 method set_httpproxytunnel
: bool -> unit
794 method set_verbose
: bool -> unit
795 method set_header
: bool -> unit
796 method set_noprogress
: bool -> unit
797 method set_nosignal
: bool -> unit
798 method set_nobody
: bool -> unit
799 method set_failonerror
: bool -> unit
800 method set_upload
: bool -> unit
801 method set_post
: bool -> unit
802 method set_ftplistonly
: bool -> unit
803 method set_ftpappend
: bool -> unit
804 method set_netrc
: curlNETRCOption
-> unit
805 method set_encoding
: curlEncoding
-> unit
806 method set_followlocation
: bool -> unit
807 method set_transfertext
: bool -> unit
808 method set_put
: bool -> unit
809 method set_userpwd
: string -> unit
810 method set_proxyuserpwd
: string -> unit
811 method set_range
: string -> unit
812 method set_errorbuffer
: string ref -> unit
813 method set_timeout
: int -> unit
814 method set_postfields
: string -> unit
815 method set_postfieldsize
: int -> unit
816 method set_referer
: string -> unit
817 method set_useragent
: string -> unit
818 method set_ftpport
: string -> unit
819 method set_lowspeedlimit
: int -> unit
820 method set_lowspeedtime
: int -> unit
821 method set_resumefrom
: int -> unit
822 method set_cookie
: string -> unit
823 method set_httpheader
: string list
-> unit
824 method set_httppost
: curlHTTPPost list
-> unit
825 method set_sslcert
: string -> unit
826 method set_sslcerttype
: string -> unit
827 method set_sslcertpasswd
: string -> unit
828 method set_sslkey
: string -> unit
829 method set_sslkeytype
: string -> unit
830 method set_sslkeypasswd
: string -> unit
831 method set_sslengine
: string -> unit
832 method set_sslenginedefault
: bool -> unit
833 method set_certinfo
: bool -> unit
834 method set_crlf
: bool -> unit
835 method set_quote
: string list
-> unit
836 method set_postquote
: string list
-> unit
837 method set_headerfunction
: (string -> int) -> unit
838 method set_cookiefile
: string -> unit
839 method set_sslversion
: curlSSLVersion
-> unit
840 method set_timecondition
: curlTimeCondition
-> unit
841 method set_timevalue
: int32
-> unit
842 method set_customrequest
: string -> unit
843 method set_interface
: string -> unit
844 method set_krb4level
: curlKRB4Level
-> unit
845 method set_progressfunction
:
846 (float -> float -> float -> float -> bool) -> unit
847 method set_sslverifypeer
: bool -> unit
848 method set_cainfo
: string -> unit
849 method set_capath
: string -> unit
850 method set_filetime
: bool -> unit
851 method set_maxredirs
: int -> unit
852 method set_maxconnects
: int -> unit
853 method set_closepolicy
: curlClosePolicy
-> unit
854 method set_freshconnect
: bool -> unit
855 method set_forbidreuse
: bool -> unit
856 method set_randomfile
: string -> unit
857 method set_egdsocket
: string -> unit
858 method set_connecttimeout
: int -> unit
859 method set_httpget
: bool -> unit
860 method set_sslverifyhost
: curlSSLVerifyHost
-> unit
861 method set_cookiejar
: string -> unit
862 method set_sslcipherlist
: string -> unit
863 method set_httpversion
: curlHTTPVersion
-> unit
864 method set_ftpuseepsv
: bool -> unit
865 method set_dnscachetimeout
: int -> unit
866 method set_dnsuseglobalcache
: bool -> unit
867 method set_debugfunction
: (t
-> curlDebugType
-> string -> unit) -> unit
868 method set_private
: string -> unit
869 method set_http200aliases
: string list
-> unit
870 method set_unrestrictedauth
: bool -> unit
871 method set_ftpuseeprt
: bool -> unit
872 method set_httpauth
: curlAuth list
-> unit
873 method set_ftpcreatemissingdirs
: bool -> unit
874 method set_proxyauth
: curlAuth list
-> unit
875 method set_ftpresponsetimeout
: int -> unit
876 method set_ipresolve
: curlIPResolve
-> unit
877 method set_maxfilesize
: int32
-> unit
878 method set_infilesizelarge
: int64
-> unit
879 method set_resumefromlarge
: int64
-> unit
880 method set_maxfilesizelarge
: int64
-> unit
881 method set_netrcfile
: string -> unit
882 method set_ftpssl
: curlFTPSSL
-> unit
883 method set_postfieldsizelarge
: int64
-> unit
884 method set_tcpnodelay
: bool -> unit
885 method set_ftpsslauth
: curlFTPSSLAuth
-> unit
886 method set_ioctlfunction
: (t
-> curlIOCmd
-> curlIOErr
) -> unit
887 method set_ftpaccount
: string -> unit
888 method set_cookielist
: string -> unit
889 method set_ignorecontentlength
: bool -> unit
890 method set_ftpskippasvip
: bool -> unit
891 method set_ftpfilemethod
: curlFTPMethod
-> unit
892 method set_localport
: int -> unit
893 method set_localportrange
: int -> unit
894 method set_connectonly
: bool -> unit
895 method set_maxsendspeedlarge
: int64
-> unit
896 method set_maxrecvspeedlarge
: int64
-> unit
897 method set_ftpalternativetouser
: string -> unit
898 method set_sslsessionidcache
: bool -> unit
899 method set_sshauthtypes
: curlSSHAuthTypes list
-> unit
900 method set_sshpublickeyfile
: string -> unit
901 method set_sshprivatekeyfile
: string -> unit
902 method set_ftpsslccc
: curlFTPSSLCCC
-> unit
903 method set_timeoutms
: int -> unit
904 method set_connecttimeoutms
: int -> unit
905 method set_httptransferdecoding
: bool -> unit
906 method set_httpcontentdecoding
: bool -> unit
907 method set_newfileperms
: int -> unit
908 method set_newdirectoryperms
: int -> unit
909 method set_post301
: bool -> unit
910 method set_sshhostpublickeymd5
: string -> unit
911 method set_copypostfields
: string -> unit
912 method set_proxytransfermode
: bool -> unit
913 method set_seekfunction
: (int64
-> curlSeek
-> curlSeekResult
) -> unit
914 method set_autoreferer
: bool -> unit
915 method set_opensocketfunction
: (Unix.file_descr
-> unit) -> unit
916 method set_proxytype
: curlProxyType
-> unit
917 method set_resolve
: (string * int * string) list
-> (string * int) list
-> unit
918 method set_dns_servers
: string list
-> unit
919 method set_mimepost
: curlMIMEPart list
-> unit
920 method set_sshknownhosts
: string -> unit
921 method set_sshkeyfunction
: (curlKHMatch
-> string -> curlKHStat
) -> unit
923 method get_effectiveurl
: string
924 method get_redirecturl
: string
925 method get_httpcode
: int
926 method get_responsecode
: int
927 method get_totaltime
: float
928 method get_namelookuptime
: float
929 method get_connecttime
: float
930 method get_pretransfertime
: float
931 method get_sizeupload
: float
932 method get_sizedownload
: float
933 method get_speeddownload
: float
934 method get_speedupload
: float
935 method get_headersize
: int
936 method get_requestsize
: int
937 method get_sslverifyresult
: int
938 method get_filetime
: float
939 method get_contentlengthdownload
: float
940 method get_contentlengthupload
: float
941 method get_starttransfertime
: float
942 method get_contenttype
: string
943 method get_redirecttime
: float
944 method get_redirectcount
: int
945 method get_private
: string
946 method get_httpconnectcode
: int
947 method get_httpauthavail
: curlAuth list
948 method get_proxyauthavail
: curlAuth list
949 method get_oserrno
: int
950 method get_numconnects
: int
951 method get_sslengines
: string list
952 method get_cookielist
: string list
953 method get_lastsocket
: int
954 method get_ftpentrypath
: string
955 method get_primaryip
: string
956 method get_localip
: string
957 method get_localport
: int
958 method get_conditionunmet
: bool
959 method get_certinfo
: string list list
962 (** {2 curl_multi API} *)
964 (** Curl multi stack. Functions may raise [Failure] on critical errors *)
967 (** type of Curl multi stack *)
970 type curlPipelining
= PIPE_NOTHING
| PIPE_HTTP1
| PIPE_MULTIPLEX
972 type curlMultiOption
=
973 | CURLMOPT_PIPELINING
of curlPipelining list
974 | CURLMOPT_MAXCONNECTS
of int
975 | CURLMOPT_MAX_PIPELINE_LENGTH
of int
976 | CURLMOPT_MAX_HOST_CONNECTIONS
of int
978 (** exception raised on internal errors *)
979 exception Error
of string
981 (** create new multi stack *)
982 val create
: unit -> mt
984 (** add handle to multi stack *)
985 val add
: mt
-> t
-> unit
987 (** remove handle from multi stack (effectively halting the transfer) *)
988 val remove
: mt
-> t
-> unit
990 (** perform pending data transfers (if any) on all handles currently in multi stack
991 @return the number of handles that still transfer data *)
992 val perform
: mt
-> int
994 (** wait till there are some active data transfers on multi stack
995 @return whether [perform] should be called *)
996 val wait
: ?timeout_ms
:int -> mt
-> bool
998 (** remove finished handle from the multi stack if any. The returned handle may be reused *)
999 val remove_finished
: mt
-> (t
* curlCode
) option
1001 (** destroy multi handle (all transfers are stopped, but individual {!type: Curl.t} handles can be reused) *)
1002 val cleanup
: mt
-> unit
1004 (** events that should be reported for the socket *)
1006 | POLL_NONE
(** none *)
1007 | POLL_IN
(** available for reading *)
1008 | POLL_OUT
(** available for writing *)
1009 | POLL_INOUT
(** both *)
1010 | POLL_REMOVE
(** socket not needed anymore *)
1012 (** socket status *)
1014 | EV_AUTO
(** determine socket status automatically (with extra system call) *)
1015 | EV_IN
(** socket has incoming data *)
1016 | EV_OUT
(** socket is available for writing *)
1017 | EV_INOUT
(** both *)
1019 (** set the function to receive notifications on what socket events
1020 are currently interesting for libcurl on the specified socket handle *)
1021 val set_socket_function
: mt
-> (Unix.file_descr
-> poll
-> unit) -> unit
1023 (** set the function to receive notification when libcurl internal timeout changes,
1024 timeout value is in milliseconds
1026 NB {!action_timeout} should be called when timeout occurs *)
1027 val set_timer_function
: mt
-> (int -> unit) -> unit
1029 (** perform pending data transfers (if any) on all handles currently in multi stack
1030 (not recommended, {!action} should be used instead)
1031 @return the number of handles that still transfer data
1032 @raise Error on errors
1034 val action_all
: mt
-> int
1036 (** inform libcurl that timeout occured
1037 @raise Error on errors
1039 val action_timeout
: mt
-> unit
1041 (** [action mt fd status] informs libcurl about event on the specified socket.
1042 [status] specifies socket status. Perform pending data transfers.
1043 @return the number of handles still active
1044 @raise Error on errors
1046 val action
: mt
-> Unix.file_descr
-> fd_status
-> int
1048 (** [timeout mt] polls multi handle for timeout (not recommended, use {!set_timer_function} instead).
1049 @return maximum allowed number of milliseconds to wait before calling libcurl to perform actions
1050 @raise Error on errors
1052 external timeout
: mt
-> int = "caml_curl_multi_timeout"
1054 (** @raise NotImplemented for not implemented option *)
1055 val setopt
: mt
-> curlMultiOption
-> unit
