This document describes version 0.4d1 of Vicare/cURL, a distribution of C and Scheme libraries for Vicare Scheme, a Scheme language implementation; it provides bindings for the Libcurl C language library.
cURL is a tool to transfer data from or to a server, using one of the supported protocols (HTTP, HTTPS, FTP, FTPS, TFTP, DICT, TELNET, LDAP or FILE).
The package is distributed under the terms of the GNU General Public License (GPL) and can be downloaded from:
development takes place at:
Libcurl is available at:
Copyright © 2012, 2013, 2015, 2017 by Marco Maggi marco.maggi.ipsu@poste.it
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with Invariant Sections being “GNU Free Documentation License” and “GNU General Public License”, no Front–Cover Texts, and no Back–Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.
| • overview: | Overview of the package. | |
| • version: | cURL version informations. | |
| • init: | Global initialisation and finalisation. | |
| • easy: | Easy operations. | |
| • multi: | Multi operations. | |
| • callbacks: | Callback makers. | |
| • slists: | String lists. | |
| • forms: | Multipart/formdata composition. | |
| • shares: | Shared configuration option sets. | |
| • cstructs: | Accessing C language data structures. | |
| • misc: | Miscellaneous functions. | |
| • symbols: | Constant to symbol conversions. | |
Appendices | ||
|---|---|---|
| • Package License: | GNU General Public License. | |
| • Documentation License: | GNU Free Documentation License. | |
| • references: | Bibliography and references. | |
Indexes | ||
| • concept index: | An entry for each concept. | |
| • function index: | An entry for each function. | |
| • variable index: | An entry for each variable. | |
| • type index: | An entry for each type. | |
Vicare Scheme is Scheme language implementation in the form of a native compiler for x86 architectures, officially supporting GNU+Linux systems. Vicare/cURL is a distribution of C language and Scheme language libraries for Vicare Scheme; it provides bindings for the Libcurl C language library.
cURL is a tool to transfer data from or to a server, using one of the supported protocols (HTTP, HTTPS, FTP, FTPS, TFTP, DICT, TELNET, LDAP or FILE).
The last time the author bothered to update this paragraph, he had tested Libcurl version 7.52.1; however, Vicare/cURL is written to be used with previous versions of Libcurl, too. The Libcurl library is available at:
The package installs a C language library implementing wrapper C
functions for the C language Libcurl library; on top of
this, the Scheme library (vicare net curl) exports one binding
for each Libcurl public function; additionally the
library (vicare net curl constants) exports one binding for each
constant value defined in the C language header curl/curl.h.
The Scheme libraries are implemented using Vicare’s typed language. The following Scheme libraries are installed:
(vicare net curl)It exports one binding for each cURL public function. All the Scheme
function names are directly derived from the C function names by
replacing underscore characters ‘_’ with dash characters ‘-’;
so curl_global_init() becomes curl-global-init.
(vicare net curl unsafe-capi)It exports one keyword syntactic binding for each cURL public
function. All the Scheme syntax names are directly derived from the C
function names by replacing underscore characters ‘_’ with dash
characters ‘-’; so curl_global_init() becomes
curl-global-init.
These syntaxes expand to a direct call to the C language wrapper functions in the Vicare/cURL library; they are not meant to be called in normal usage of the package.
(vicare net curl constants)It exports one binding for each constant value defined in the C language headers curl/curl.h.
(vicare net curl features)It exports one identifier syntax binding for each HAVE_ constant
defined by the configure script, expanding to #t or
#f.
Scheme libraries are installed under the directory:
This document contains only a brief description of the functions: refer to the Libcurl’s documentation for details.
The installed C library follows version numbering as established by the GNU Autotools. For an explanation of interface numbers as managed by GNU Libtool See Libtool’s versioning system in Shared library support for GNU.
The following bindings are exported by the library
(vicare net curl).
Return a fixnum representing a version number.
Return a Scheme string representing the version number.
Return a string representing the version of cURL; See (*manpages*)curl_version.
(import (vicare) (vicare net curl)) (curl-version) ⇒ "libcurl/7.27.0 OpenSSL/0.9.8n zlib/1.2.5 libidn/1.12"
Data structure mirroring the C language type
curl_version_info_data. It has the following fields:
ageExact integer, age of the returned struct.
versionAn exact integer representing a LIBCURL_VERSION constant.
version-numAn exact integer representing the LIBCURL_VERSION_NUM constant.
host#f or a string representing OS/host/cpu/machine when the package
was configured.
featuresAn exact integer representing a bitmask of CURL_VERSION_
constants.
ssl-version#f or a human readable string.
ssl-version-numNot used anymore, always 0.
libz-version#f or a human readable string.
protocolsA list of protocol strings.
ares#f or a string.
ares-numAn exact integer.
libidn#f or a string.
iconv-ver-numAn exact integer, same as _libiconv_version if cURL was built
with HAVE_ICONV.
libssh-version#f or a human readable string.
Return #t if obj is an instance of
curl-version-info-data.
Accessors for the fields of curl-version-info-data instances.
Return an instance of curl-version-info-data representing the
version number of the features with which cURL was built.
See (*manpages*)curl_version_info.
version-code must be a non–negative fixnum representing one of
the CURLVERSION_ constants, with CURLVERSION_NOW
representing the current version.
(import (vicare)
(vicare net curl)
(vicare net curl constants))
(curl-version-info CURLVERSION_NOW)
⇒ #[curl-version-info-data
age=3
version="7.27.0"
version-num=465664
host="i686-pc-linux-gnu"
features=(CURL_VERSION_NTLM_WB
CURL_VERSION_IDN
CURL_VERSION_LARGEFILE
CURL_VERSION_NTLM
CURL_VERSION_LIBZ
CURL_VERSION_SSL
CURL_VERSION_IPV6)
ssl-version="OpenSSL/0.9.8n"
ssl-version-num=0
libz-version="1.2.5"
protocols=("tftp" "telnet" "smtps"
"smtp" "rtsp" "pop3s"
"pop3" "ldaps" "ldap"
"imaps" "imap" "https"
"http" "gopher" "ftps"
"ftp" "file" "dict")
ares=#f
ares-num=0
libidn="1.12"
iconv-ver-num=0
libssh-version=#f]
Given an instance of curl-version-info-data, extract the
features field and convert it into a list of symbols representing
the CURL_VERSION_ constants.
(import (vicare)
(vicare net curl)
(vicare net curl constants))
(curl-version-info-features->symbols
(curl-version-info CURLVERSION_NOW))
⇒ (CURL_VERSION_NTLM_WB
CURL_VERSION_IDN
CURL_VERSION_LARGEFILE
CURL_VERSION_NTLM
CURL_VERSION_LIBZ
CURL_VERSION_SSL
CURL_VERSION_IPV6)
Given an instance of curl-version-info-data, extract the
features field and bitwise AND the value feature to it;
feature must be an exact integer representing a
CURL_VERSION_ constant; return #t if the feature bit
is set.
(import (vicare)
(vicare net curl)
(vicare net curl constants))
(curl-version-feature? (curl-version-info CURLVERSION_NOW)
CURL_VERSION_LIBZ)
⇒ #t
The following bindings are exported by the library (vicare net
curl).
Perform global initialisation for the cURL library; if successful
return CURLE_OK, else return a CURLE_ error code.
See (*manpages*)curl_global_init.
flags must be an exact integer representing CURL_GLOBAL_ALL
or the bitwise inclusive OR combination of: CURL_GLOBAL_SSL,
CURL_GLOBAL_WIN32, CURL_GLOBAL_NOTHING.
Like curl-global-init, but allows the application to replace the
functions used by cURL to manage raw memory with supplied callbacks.
See (*manpages*)curl_global_init_mem.
flags has the same meaning of the argument to
curl-global-init-mem. The other arguments must be pointer
objects referencing C language functions or #f when the callback
must be reset to NULL.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as argument in calls
to curl-global-init-mem; the returned pointer must be released
with a call to free-c-callback from (vicare ffi).
Each supplied Scheme function must adhere to the appropriate prototype among the following:
void * curl_malloc_callback (size_t size); void curl_free_callback (void *ptr); void * curl_realloc_callback (void *ptr, size_t size); char * curl_strdup_callback (const char *str); void * curl_calloc_callback (size_t nmemb, size_t size);
The supplied Scheme function is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); the supplied Scheme function should take care of
handling its own exceptions.
null-pointer.
void.
Release the resources allocated by curl-global-init or
curl-global-init-mem; return unspecified values.
See (*manpages*)curl_global_cleanup.
The following is a meaningless example of selecting custom functions to handle raw memory allocation:
#!r6rs (import (vicare) (vicare net curl) (vicare net curl constants) (prefix (vicare ffi) ffi.)) (curl-global-init-mem CURL_GLOBAL_ALL (make-curl-malloc-callback ffi.malloc) (make-curl-free-callback ffi.free) (make-curl-realloc-callback ffi.realloc) (make-curl-strdup-callback ffi.strdup) (make-curl-calloc-callback ffi.calloc)) ⇒ CURLE_OK
| • easy struct: | Easy operations handle. | |
| • easy init: | Easy initialisation and finalisation. | |
| • easy config: | Selecting options for easy operations. | |
| • easy perform: | Performing easy operations. | |
| • easy info: | Retrieving transfer informations. | |
| • easy data: | Sending and receiving raw data. | |
| • easy escape: | Escaping URL strings. | |
| • easy misc: | Miscellaneous functions. |
The following bindings are exported by the library (vicare net
curl).
Opaque structure type referencing an instance of the C language type
CURL.
When instances of this type are used as arguments to functions: this documentation identifies them as easy.
Instances of this type must be finalised with curl-easy-cleanup;
whenever an instance of this type is garbage collected:
curl-easy-cleanup is automatically applied to it and any error
ignored.
In certain contexts, instances of this type own the referenced
CURL value, in other contexts they do not:
curl-easy instance owning the CURL value,
causes finalisation of the CURL value too.
curl-easy instance not owning the
CURL value, leaves the CURL untouched.
this should happen transparently.
Return #t if obj is an instance of curl-easy;
otherwise return #f.
Return #t if obj is an instance of curl-easy and it
has not been finalised; return #f otherwise.
Retrieve or set a destructor function associated to easy.
Whenever easy is finalised, either explicitly with
curl-easy-cleanup or implicitly by the garbage collector,
func is applied to easy before the internal state of
easy is destroyed.
Notice that func can be used to associate some state to easy, for example, by doing:
(define easy ...)
(set-curl-easy-custom-destructor! easy
(let ((state (make-some-data-struct)))
(case-lambda
((easy)
(destroy state))
(()
state))))
(let ((state ((curl-easy-custom-destructor easy))))
(do-something-with easy state))
Next: easy config, Previous: easy struct, Up: easy [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Build a new instance of curl-easy owning the referenced
CURL value; if successful return the new instance, else return
#f. See (*manpages*)curl_easy_init.
Finalise easy; return unspecified values. See (*manpages*)curl_easy_cleanup.
It is fine to apply this function multiple times to the same easy value: the first time the underlying session data is finalised, the subsequent times nothing happens.
If this function is applied to an easy value not owning the
underlying CURL value: easy is finalised, but the
CURL value is left alone.
Reinitialise all the options associated to easy; return unspecified values. See (*manpages*)curl_easy_reset.
Next: easy perform, Previous: easy init, Up: easy [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Set an option for the easy handle; if successful return
CURLE_OK, if option is invalid return #f, else return
a CURLE_ error code. See (*manpages*)curl_easy_setopt.
option must be an exact integer representing one of the
CURLOPT_ constants.
The type of parameter depends upon the selected option value; it can be one among:
long or
off_t. Whenever a long is expected: #t and #f
are also accepted and converted to 1 and 0.
#f is also accepted and converted to a
NULL pointer.
string->utf8. (vicare-scheme)Introduction to generalised C strings. For such
options #f is also accepted and converted to NULL.
CURLOPT_SHARE: parameter must be an
instance of curl-share.
Next: easy info, Previous: easy config, Up: easy [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Perform a file transfer; if successful return CURLE_OK, else
return a CURLE_ error code. See (*manpages*)curl_easy_perform.
Clone a session handle; if successful return a new instance of
curl-easy, else return #f. See (*manpages*)curl_easy_duphandle.
Pause and unpause a session; if successful return CURLE_OK, else
return a CURLE_ error code. See (*manpages*)curl_easy_pause.
bitmask must be the fixnum zero or the bitwise inclusive OR
combination of the CURLPAUSE_ constants: CURLPAUSE_RECV,
CURLPAUSE_SEND, CURLPAUSE_ALL, CURLPAUSE_CONT.
Next: easy data, Previous: easy perform, Up: easy [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Extract informations from an easy handle; return 2 values:
CURLE_OK and a value representing the requested
information.
#f and #f.
CURLE_ error constant and #f.
See (*manpages*)curl_easy_getinfo.
info must be one of the CURLINFO_ constants and it drives
the type of the second returned value:
long or double: the returned value is an exact integer or
a flonum.
#f or a Scheme string; #f is returned when no string is
available from cURL.
#f or a list of Scheme strings; #f is returned if the list
is empty.
CURLINFO_CERTINFOThe returned value is #f or a vector holding one item for each
SSL/TLS certificate; each item is a list of strings representing
informations about the certificate; each string has the format
name:value. #f is returned when no certificate
informations are available.
CURLINFO_PRIVATEThe returned value is #f or a pointer object referencing the data
previously registered in the easy handle with curl-easy-setopt
and CURLOPT_PRIVATE; #f is returned if the data is the
NULL pointer.
CURLINFO_TLS_SESSIONThe returned value is #f or an instance of
curl-tls-session-info.
Scheme representation of the C language struct
curl_tlssessioninfo. It has the following fields:
backendAn exact integer representing the value of the C struct’s field
backend. It one of the constants in the enum
curl_sslbackend, among the valid values are:
CURLSSLBACKEND_AXTLS CURLSSLBACKEND_CYASSL CURLSSLBACKEND_DARWINSSL CURLSSLBACKEND_GNUTLS CURLSSLBACKEND_GSKIT CURLSSLBACKEND_NONE CURLSSLBACKEND_NSS CURLSSLBACKEND_OPENSSL CURLSSLBACKEND_POLARSSL CURLSSLBACKEND_QSOSSL CURLSSLBACKEND_SCHANNEL
internalsA pointer object representing the value of the C struct’s field
internals.
For details: see the documentation of the constant
CURLINFO_TLS_SESSION in the manual page of
See (*manpages*)curl_easy_getinfo.
Build and return a new instance of curl-tls-session-info.
Return #t if obj is an instance of
curl-tls-session-info; otherwise return #f.
Accessors for structs of type curl-tls-session-info.
In the following example we discard the received data and just print the value of some options:
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants)
(prefix (vicare ffi) ffi.))
(define (dummy-write-cb buffer size nitems outstream)
(* size nitems))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(let ((easy (curl-easy-init))
(write-cb (make-curl-write-callback dummy-write-cb)))
(unwind-protect
(begin
(curl-easy-setopt easy CURLOPT_URL
"http://www.google.com/")
;;In a way or the other a WRITEFUNCTION is always
;;there; to discard data we have to register a
;;WRITEFUNCTION that does nothing!!!
(curl-easy-setopt easy CURLOPT_WRITEFUNCTION write-cb)
(curl-easy-setopt easy CURLOPT_WRITEDATA #f)
(assert (= CURLE_OK (curl-easy-perform easy)))
(let-values
(((code info)
(curl-easy-getinfo easy CURLINFO_EFFECTIVE_URL)))
(assert (= code CURLE_OK))
(printf "Effective URL: ~a\n" info))
(let-values
(((code info)
(curl-easy-getinfo easy CURLINFO_RESPONSE_CODE)))
(assert (= code CURLE_OK))
(printf "Response code: ~a\n" info))
(let-values
(((code info)
(curl-easy-getinfo easy CURLINFO_TOTAL_TIME)))
(assert (= code CURLE_OK))
(printf "Total time: ~a\n" info))
(flush-output-port (current-output-port)))
;;Close the connection before releasing the callbacks!!!
(curl-easy-cleanup easy)
(ffi.free-c-callback write-cb)))
-| Effective URL: https://www.google.com/
-| Response code: 302
-| Total time: 0.392977
The following example discards the received data and just prints certificate informations (which is shown with ellipses to make it short):
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants)
(prefix (vicare ffi) ffi.))
(define (dummy-write-cb buffer size nitems outstream)
(* size nitems))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(let ((easy (curl-easy-init))
(write-cb (make-curl-write-callback dummy-write-cb)))
(unwind-protect
(begin
(curl-easy-setopt easy CURLOPT_URL "https://github.com/")
;;In a way or the other a WRITEFUNCTION is always
;;there; to discard data we have to register a
;;WRITEFUNCTION that does nothing!!!
(curl-easy-setopt easy CURLOPT_WRITEFUNCTION write-cb)
(curl-easy-setopt easy CURLOPT_WRITEDATA #f)
(curl-easy-setopt easy CURLOPT_CERTINFO #t)
(assert (= CURLE_OK (curl-easy-perform easy)))
(let-values
(((code info)
(curl-easy-getinfo easy CURLINFO_CERTINFO)))
(assert (= code CURLE_OK))
(printf "Number of certificates: ~a\n"
(vector-length info))
(printf "First certificate data: \n")
(pretty-print (vector-ref info 0)))
(flush-output-port (current-output-port)))
;;Close the connection before releasing the callbacks!!!
(curl-easy-cleanup easy)
(ffi.free-c-callback write-cb)))
-| Number of certificates: 2
-| First certificate data:
("Subject:businessCategory=Private ..."
"Issuer:C=US; O=DigiCert Inc; ..."
"Version:2"
"Signature Algorithm:sha1WithRSAEncryption"
"Start date:2011-05-27 00:00:00 GMT"
"Expire date:2013-07-29 12:00:00 GMT"
"Public Key Algorithm:rsaEncryption"
"RSA Public Key:2048"
"rsa(n):ed:d3:89:c3:5d:70:72:09:..."
"rsa(e):01:00:01:"
"X509v3 Authority Key Identifier:..."
"X509v3 Subject Key Identifier:87:D1..."
"X509v3 Subject Alternative Name:..."
"Authority Information Access:OCSP-URI:..."
"X509v3 Basic Constraints:CA:FALSE"
"X509v3 CRL Distribution Points:URI:..."
"X509v3 Certificate Policies:Policy:..."
"X509v3 Extended Key Usage:..."
"Netscape Cert Type:SSLClient,SSLServer"
"X509v3 Key Usage:DigitalSignature,KeyEncipherment"
"Signature:14:52:71:1f:86:9d:6d:35:3e:..."
"Cert:-----BEGIN CERTIFICATE-----\nMIIHKjC...")
Next: easy escape, Previous: easy info, Up: easy [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Receive raw data from an easy handle; return 2 values:
CURLE_OK and an exact integer representing the
number of bytes received in the output buffer.
CURLE_ error code and #f.
See (*manpages*)curl_easy_recv.
buffer.data and buffer.len must represent a generalised C buffer, (vicare-scheme)Introduction to generalised C buffers. Received data is written in such buffer.
Send raw data to an easy handle; return 2 values:
CURLE_OK and an exact integer representing the
number of bytes sent from the input buffer.
CURLE_ error code and #f.
See (*manpages*)curl_easy_send.
buffer.data and buffer.len must represent a generalised C
string, (vicare-scheme)Introduction to generalised C strings. When buffer.data is a Scheme string: it
is converted to a bytevector with string->utf8. It is the input
buffer from which sent data will be read.
The following bindings are exported by the library (vicare net
curl).
Encode the given string to become a portion of URL; if successful
return an ASCII bytevector, else return #f.
See (*manpages*)curl_easy_escape.
chars.data and chars.len must represent a generalised C string, (vicare-scheme)Introduction to generalised C strings. It must hold the input data.
Like curl-easy-escape, but return a string.
Decode the given string as if it comes from a portion of URL; if
successful return an ASCII bytevector, else return #f.
See (*manpages*)curl_easy_unescape.
chars.data and chars.len must represent a generalised C string, (vicare-scheme)Introduction to generalised C strings. It must hold the input data.
Like curl-easy-unescape, but return a string.
Previous: easy escape, Up: easy [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Return a string representing the description of the given CURLE_
error code; if code is invalid, return #f.
See (*manpages*)curl_easy_strerror.
| • multi examples: | Some simple usage examples. | |
| • multi struct: | Multi operations handle. | |
| • multi init: | Multi initialisation and finalisation. | |
| • multi easy: | Adding and removing easy handles. | |
| • multi config: | Selecting options for multi operations. | |
| • multi perform: | Performing multi operations. | |
| • multi sockets: | Performing multi operations with socket descriptors. | |
| • multi misc: | Miscellaneous functions for multi handles. |
Next: multi struct, Up: multi [Contents][Index]
The following example downloads the page at http://google.com/
using curl-multi-perform, curl-multi-fdset and
curl-multi-timeout:
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants)
(prefix (vicare ffi) ffi.)
(prefix (vicare posix) px.))
(define-inline (%pretty-print ?thing)
(pretty-print ?thing (current-error-port)))
(define (write-func buffer size nitems outstream)
(let ((nbytes (* size nitems)))
(guard (E (else (pretty-print E) nbytes))
(fprintf (current-error-port) "Google's Home page:\n~a\n"
(utf8->string (cstring->bytevector buffer nbytes))))
nbytes))
(define (%curl-multi-perform multi)
(let loop ()
(let-values (((code still-running)
(curl-multi-perform multi)))
(if (= code CURLM_CALL_MULTI_PERFORM)
(loop)
(values code still-running)))))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(let ((multi (curl-multi-init))
(easy (curl-easy-init))
(rfdset (px.make-fd-set-pointer))
(wfdset (px.make-fd-set-pointer))
(write-cb (make-curl-write-callback write-func)))
(unwind-protect
(begin
(curl-easy-setopt easy CURLOPT_URL "http://google.com/")
(curl-easy-setopt easy CURLOPT_WRITEFUNCTION write-cb)
(curl-easy-setopt easy CURLOPT_WRITEDATA #f)
(curl-multi-add-handle multi easy)
(let loop ()
(let-values (((code still-running)
(%curl-multi-perform multi)))
(unless (zero? still-running)
(let-values (((code milliseconds)
(curl-multi-timeout multi)))
(when (and (= code CURLM_OK)
(<= 0 milliseconds))
(px.FD_ZERO rfdset)
(px.FD_ZERO wfdset)
(let-values (((code max-fd)
(curl-multi-fdset multi
rfdset wfdset #f))
((secs nsecs)
(div-and-mod milliseconds 1000)))
(when (= code CURLM_OK)
(px.select-from-sets (+ 1 max-fd)
rfdset wfdset #f secs nsecs)
(loop))))))))
(let-values (((msg nmsgs)
(curl-multi-info-read multi)))
(when msg
(%pretty-print
(curl-constant-msg->symbol (curl-msg.msg msg))))))
;;Close handles before releasing the callbacks!!!
(curl-multi-cleanup multi)
(curl-easy-cleanup easy)
(ffi.free-c-callback write-cb)
(free rfdset)
(free wfdset)))
The following example downloads the page at http://google.com/
using curl-multi-perform, curl-multi-fdset and the multi
timer callback:
#!vicare
(program (demo)
(options typed-language)
(import (vicare)
(vicare net curl)
(vicare net curl constants)
(prefix (vicare ffi) ffi.)
(prefix (vicare posix) px.))
(define-inline (%pretty-print ?thing)
(pretty-print ?thing (current-error-port)))
(define (write-func buffer size nitems outstream)
(let ((nbytes (* size nitems)))
(guard (E (else (pretty-print E) nbytes))
(fprintf (current-error-port) "Google's Home page:\n~a\n"
(utf8->string (cstring->bytevector buffer nbytes))))
nbytes))
(define (%curl-multi-perform multi)
(let loop ()
(let-values (((code still-running)
(curl-multi-perform multi)))
(if (= code CURLM_CALL_MULTI_PERFORM)
(loop)
(values code still-running)))))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(let* ((multi (curl-multi-init))
(easy (curl-easy-init))
({milliseconds <exact-integer>} -1)
(rfdset (px.make-fd-set-pointer))
(wfdset (px.make-fd-set-pointer))
(write-cb (make-curl-write-callback write-func))
(timer-cb (make-curl-multi-timer-callback
(lambda (multi ms custom-data)
(set! milliseconds ms)
0))))
(unwind-protect
(begin
(curl-easy-setopt easy CURLOPT_URL "http://google.com/")
(curl-easy-setopt easy CURLOPT_WRITEFUNCTION write-cb)
(curl-easy-setopt easy CURLOPT_WRITEDATA #f)
(curl-multi-setopt multi CURLMOPT_TIMERFUNCTION timer-cb)
(curl-multi-setopt multi CURLMOPT_TIMERDATA #f)
(curl-multi-add-handle multi easy)
(let loop ()
(let-values (((code still-running)
(%curl-multi-perform multi)))
(when (and (not (zero? still-running))
(<= 0 milliseconds))
(px.FD_ZERO rfdset)
(px.FD_ZERO wfdset)
(let-values (((code max-fd)
(curl-multi-fdset multi
rfdset wfdset #f))
((secs nsecs)
(div-and-mod milliseconds 1000)))
(when (= code CURLM_OK)
(px.select-from-sets (+ 1 max-fd)
rfdset wfdset #f secs nsecs)
(loop))))))
(let-values (((msg nmsgs)
(curl-multi-info-read multi)))
(when msg
(%pretty-print
(curl-constant-msg->symbol (curl-msg.msg msg)))))
#t)
;;Close handles before releasing the callbacks!!!
(curl-multi-cleanup multi)
(curl-easy-cleanup easy)
(ffi.free-c-callback write-cb)
(ffi.free-c-callback timer-cb)
(free rfdset)
(free wfdset)))
#| end of program |# )
The following example downloads the page at http://google.com/
using curl-multi-socket-action, the multi socket callback and the
multi timer callback:
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants)
(prefix (vicare ffi) ffi.)
(prefix (vicare posix) px.))
(define-struct pending-socks
(rd-requests
;Null or a list of socket descriptors
;for which reading is requested.
wr-requests
;Null or a list of socket descriptors
;for which writing is requested.
rw-requests
;Null or a list of socket descriptors
;for which reading or writing is requested.
))
(define (%make-pending-socks)
(make-pending-socks '() '() '()))
(define (pending-socks-remove! ps sock-fd)
(pending-socks-remove-from-rd-requests! ps sock-fd)
(pending-socks-remove-from-wr-requests! ps sock-fd)
(pending-socks-remove-from-rw-requests! ps sock-fd))
(define (pending-socks-remove-from-rd-requests! ps sock-fd)
(set-pending-socks-rd-requests! ps
(remq sock-fd (pending-socks-rd-requests ps))))
(define (pending-socks-remove-from-wr-requests! ps sock-fd)
(set-pending-socks-wr-requests! ps
(remq sock-fd (pending-socks-wr-requests ps))))
(define (pending-socks-remove-from-rw-requests! ps sock-fd)
(set-pending-socks-rw-requests! ps
(remq sock-fd (pending-socks-rw-requests ps))))
(define (pending-socks-rd-request! ps sock-fd)
(set-pending-socks-rd-requests! ps
(cons sock-fd (pending-socks-rd-requests ps))))
(define (pending-socks-wr-request! ps sock-fd)
(set-pending-socks-wr-requests! ps
(cons sock-fd (pending-socks-wr-requests ps))))
(define (pending-socks-rw-request! ps sock-fd)
(set-pending-socks-rw-requests!
ps (cons sock-fd (pending-socks-rw-requests ps))))
(define (%curl-multi-socket-action multi sock-fd events)
(let loop ()
(let-values
(((code still-running)
(curl-multi-socket-action multi sock-fd events)))
(if (= code CURLM_CALL_MULTI_PERFORM)
(loop)
(values code still-running)))))
(define (write-func buffer size nitems outstream)
(let ((nbytes (* size nitems)))
(guard (E (else (pretty-print E) nbytes))
(fprintf (current-error-port) "Google's Home page:\n~a\n"
(cstring->string buffer nbytes)))
nbytes))
(define (socket-func easy sock-fd poll-type
callback-data sock-fd-data)
(define ps
(retrieve-to-avoid-collecting callback-data))
(case-integers poll-type
((CURL_POLL_NONE)
(void))
((CURL_POLL_IN)
(pending-socks-rd-request! ps sock-fd))
((CURL_POLL_OUT)
(pending-socks-wr-request! ps sock-fd))
((CURL_POLL_INOUT)
(pending-socks-rw-request! ps sock-fd))
((CURL_POLL_REMOVE)
(pending-socks-remove! ps sock-fd))))
(define (timer-func multi milliseconds timeout-pointer)
(replace-to-avoid-collecting timeout-pointer milliseconds)
0)
(module (%select)
(define (%select rd-requests wr-requests rw-requests
milliseconds)
;;Perform a SELECT call for the requested sockets;
;;use the given milliseconds as timeout. Return
;;two values: null or a list of socket descriptors
;;ready for reading; null or a list of socket
;;descriptors ready for writing.
;;
(let ((fdsets (px.make-fd-set-bytevector 3)))
(%set-requests rd-requests fdsets 0)
(%set-requests wr-requests fdsets 1)
(%set-requests rw-requests fdsets 0)
(%set-requests rw-requests fdsets 1)
(cond ((let-values (((secs nsecs)
(div-and-mod milliseconds 1000)))
(px.select-from-sets-array FD_SETSIZE
fdsets secs nsecs))
=> (lambda (fdsets)
(values (%filter-ready
(append rd-requests rw-requests)
fdsets 0)
(%filter-ready
(append wr-requests rw-requests)
fdsets 1))))
(else ;expired timeout
(values '() '())))))
(define (%filter-ready requests fdsets idx)
;;Filter from REQUESTS the socket descriptors
;;which are ready in FDSETS at fd_set index IDX;
;;return the list of ready sockets.
;;
(let loop ((ready '())
(requests requests))
(if (null? requests)
ready
(let ((sock-fd (car requests)))
(if (px.FD_ISSET sock-fd fdsets idx)
(loop (cons sock-fd ready) (cdr requests))
(loop ready (cdr requests)))))))
(define (%set-requests requests fdsets idx)
;;Set the socket descriptors from REQUESTS in
;;FDSETS and fd_set index IDX; return unspecified
;;values.
;;
(for-each (lambda (sock-fd)
(px.FD_SET sock-fd fdsets idx))
requests))
#| end of module |# )
(define-inline (%pretty-print ?thing)
(pretty-print ?thing (current-error-port)))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(let* ((multi (curl-multi-init))
(easy (curl-easy-init))
(write-cb (make-curl-write-callback write-func))
(socket-cb (make-curl-socket-callback socket-func))
(timer-cb (make-curl-multi-timer-callback timer-func))
(timeout-pointer
(register-to-avoid-collecting -1))
(pending-socks
(%make-pending-socks))
(pending-socks-pointer
(register-to-avoid-collecting pending-socks)))
(unwind-protect
(begin
(curl-easy-setopt easy
CURLOPT_URL "http://google.com/")
(curl-easy-setopt easy
CURLOPT_WRITEFUNCTION write-cb)
(curl-easy-setopt easy
CURLOPT_WRITEDATA #f)
(curl-multi-setopt multi
CURLMOPT_TIMERFUNCTION timer-cb)
(curl-multi-setopt multi
CURLMOPT_TIMERDATA timeout-pointer)
(curl-multi-setopt multi
CURLMOPT_SOCKETFUNCTION socket-cb)
(curl-multi-setopt multi
CURLMOPT_SOCKETDATA pending-socks-pointer)
(curl-multi-add-handle multi easy)
(let loop ()
(let-values
(((code still-running)
(%curl-multi-socket-action multi
CURL_SOCKET_TIMEOUT 0)))
(when (and (= code CURLM_OK)
(not (zero? still-running)))
(let-values
(((read-ready write-ready)
(%select
(pending-socks-rd-requests pending-socks)
(pending-socks-wr-requests pending-socks)
(pending-socks-rw-requests pending-socks)
(retrieve-to-avoid-collecting timeout-pointer))))
(for-each
(lambda (sock-fd)
(%curl-multi-socket-action multi
sock-fd CURL_CSELECT_IN))
read-ready)
(for-each
(lambda (sock-fd)
(%curl-multi-socket-action multi
sock-fd CURL_CSELECT_OUT))
write-ready)
(loop)))))
(let-values (((msg nmsgs)
(curl-multi-info-read multi)))
(when msg
(%pretty-print
(curl-constant-msg->symbol (curl-msg.msg msg))))))
;;Close handles before releasing the callbacks!!!
(curl-multi-cleanup multi)
(curl-easy-cleanup easy)
(ffi.free-c-callback write-cb)
(ffi.free-c-callback timer-cb)
(forget-to-avoid-collecting pending-socks-pointer)))
Next: multi init, Previous: multi examples, Up: multi [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Opaque structure type referencing an instance of the C language type
CURLM.
When instances of this type are used as arguments to functions: this documentation identifies them as multi.
Instances of this type must be finalised with curl-multi-cleanup;
whenever an instance of this type is garbage collected:
curl-multi-cleanup is automatically applied to it and any error
ignored. Before the finalisation takes place: all the easy handles are
removed from the context of multi.
In certain contexts, instances of this type own the referenced
CURLM value, in other contexts they do not:
curl-multi instance owning the CURLM value,
causes finalisation of the CURLM value too.
curl-multi instance not owning the
CURLM value, leaves the CURLM untouched.
this should happen transparently.
Return #t if obj is an instance of curl-multi;
otherwise return #f.
Return #t if obj is an instance of curl-multi and it
has not been finalised; otherwise return #f.
Retrieve or set a destructor function associated to multi.
Whenever multi is finalised, either explicitly with
curl-multi-cleanup or implicitly by the garbage collector,
func is applied to multi before the internal state of
multi is destroyed.
Notice that func can be used to associate some state to multi, for example, by doing:
(define multi ...)
(set-curl-multi-custom-destructor! multi
(let ((state (make-some-data-struct)))
(case-lambda
((multi)
(destroy state))
(()
state))))
(let ((state ((curl-multi-custom-destructor multi))))
(do-something-with multi state))
Next: multi easy, Previous: multi struct, Up: multi [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Build and return a new instance of curl-multi.
See (*manpages*)curl_multi_init.
Finalise an instance of curl-multi. If the finalisation happens
and it is successful: return CURLM_OK; if the finalisation
happens and it fails: return a CURLM_ error code; if multi
was already finalised: return #f. See (*manpages*)curl_multi_cleanup.
It is fine to apply this function multiple times to the same multi value: the first time the underlying session data is finalised, the subsequent times nothing happens.
If this function is applied to a multi value not owning the
underlying CURLM value: multi is finalised, but the
CURLM value is left alone.
Before the finalisation takes place: this function removes all the easy handles from the context of multi.
Next: multi config, Previous: multi init, Up: multi [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Add easy to the context of multi; if successful return
CURLM_OK, else return a CURLM_ error code.
See (*manpages*)curl_multi_add_handle.
Remove easy from the context of multi; if successful return
CURLM_OK, else return a CURLM_ error code.
See (*manpages*)curl_multi_remove_handle.
Notice that easy handles are automatically removed from a multi handle
whenever the multi handle is finalised, either explicitly with a call to
curl-multi-cleanup or implicitly by the garbage collector.
Return a vector holding the easy handles registered in multi.
Here is a meaningless example of adding and removing:
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(let* ((multi (curl-multi-init))
(easy1 (curl-easy-init))
(easy2 (curl-easy-init))
(easy3 (curl-easy-init)))
(curl-multi-add-handle multi easy1) ⇒ CURLM_OK
(curl-multi-add-handle multi easy2) ⇒ CURLM_OK
(curl-multi-add-handle multi easy3) ⇒ CURLM_OK
(curl-multi-remove-handle multi easy1) ⇒ CURLM_OK
(curl-multi-remove-handle multi easy2) ⇒ CURLM_OK
(curl-multi-remove-handle multi easy3) ⇒ CURLM_OK
(curl-easy-cleanup easy1)
(curl-easy-cleanup easy2)
(curl-easy-cleanup easy3)
(curl-multi-cleanup multi)) ⇒ CURLM_OK
Next: multi perform, Previous: multi easy, Up: multi [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Set an option for the multi handle; if successful return
CURLM_OK, if option is invalid return #f, else return
a CURLM_ error code. See (*manpages*)curl_multi_setopt.
option must be an exact integer representing one of the
CURLMOPT_ constants.
The type of parameter depends upon the selected option value; it can be one among:
long or
off_t. Whenever a long is expected: #t and #f
are also accepted and converted to 1 and 0.
#f is also accepted and converted to a
NULL pointer.
strings->utf8. For such values #f is also accepted to
represent the NULL pointer.
Here are meaningless examples of setting options:
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(define multi
(curl-multi-init)
(define socket-cb
(make-curl-socket-callback
(lambda (handle sock what callback-custom-data
socket-custom-data)
0)))
(define timer-cb
(make-curl-multi-timer-callback
(lambda (multi timeout-ms custom-data)
0)))
(curl-multi-setopt multi CURLMOPT_SOCKETFUNCTION cb)
⇒ CURLM_OK
(curl-multi-setopt multi CURLMOPT_SOCKETDATA #f)
⇒ CURLM_OK
(curl-multi-setopt multi CURLMOPT_PIPELINING #t)
⇒ CURLM_OK
(curl-multi-setopt multi CURLMOPT_PIPELINING #f)
⇒ CURLM_OK
(curl-multi-setopt multi CURLMOPT_TIMERFUNCTION cb))
⇒ CURLM_OK
(curl-multi-setopt multi CURLMOPT_TIMERDATA #f)
⇒ CURLM_OK
(curl-multi-setopt multi CURLMOPT_MAXCONNECTS 123)
⇒ CURLM_OK
Next: multi sockets, Previous: multi config, Up: multi [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Perform multi operations; return 2 values:
CURLM_ constant.
Here is an example of performance:
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants))
(define (write-func buffer size nitems outstream)
(let ((nbytes (* size nitems)))
(guard (E (else (pretty-print E) nbytes))
(fprintf (current-error-port) "Google's Home page:\n~a\n"
(utf8->string (cstring->bytevector buffer nbytes))))
nbytes))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(let ((multi (curl-multi-init))
(easy (curl-easy-init))
(write-cb (make-curl-write-callback write-func)))
(unwind-protect
(begin
(curl-easy-setopt easy CURLOPT_URL "http://google.com/")
(curl-easy-setopt easy CURLOPT_WRITEFUNCTION write-cb)
(curl-easy-setopt easy CURLOPT_WRITEDATA #f)
(curl-multi-add-handle multi easy)
(let loop ((running 0))
(let-values (((code running) (curl-multi-perform multi)))
(when (or (= code CURLM_CALL_MULTI_PERFORM)
(not (zero? running)))
(loop running))))
(let-values (((msg nmsgs)
(curl-multi-info-read multi)))
(when msg
(%pretty-print (curlmsg->symbol (curl-msg.msg msg))))))
(curl-multi-cleanup multi)
;;Close the connection before releasing the callbacks!!!
(curl-easy-cleanup easy)
(ffi.free-c-callback write-cb)))
-| Google's Home page:
-| <HTML><HEAD><meta http-equiv="content-type"
content="text/html;charset=utf-8">
-| <TITLE>301 Moved</TITLE></HEAD><BODY>
-| <H1>301 Moved</H1>
-| The document has moved
-| <A HREF="http://www.google.com/">here</A>.
-| </BODY></HTML>
-|
-| CURLMSG_DONE
Next: multi misc, Previous: multi perform, Up: multi [Contents][Index]
| • multi sockets fdsets: | Using file descriptor sets and select.
| |
| • multi sockets polls: | Using file descriptors and poll.
| |
| • multi sockets action: | Performing actions. | |
| • multi sockets data: | Associating custom data to file descriptors. | |
| • multi sockets depre: | Deprecated functions. |
Next: multi sockets polls, Up: multi sockets [Contents][Index]
selectThe following bindings are exported by the library (vicare net
curl).
Extract file descriptor informations from a multi handle; return 2 values:
CURLM_OK, else a CURLM_ error code.
fd_set structures; this value is -1 if no socket
descriptors are set.
See (*manpages*)curl_multi_fdset.
read-fds, write-fds, exc-fds must be #f or
pointer objects or memory-block holding or referencing C language
structures of type fd_set, ready to receive socket descriptors
registration; when #f an empty fd_set is internally
allocated and used.
Next: multi sockets action, Previous: multi sockets fdsets, Up: multi sockets [Contents][Index]
pollThe following bindings are exported by the library (vicare net
curl).
Data structure type representing at the Scheme level a struct
curl_waitfd C language structure. It has the following fields:
fdFixnum representing a socket descriptor.
eventsFixnum representing a short int bitmask of events.
reventsFixnum representing a short int bitmask of events.
Build and return a new instance of curl-waitfd.
Return #t if obj is an instance of curl-waitfd;
otherwise return #f.
Accessors for the fields of curl-waitfd structures.
Polls on all easy handles in a multi handle. Return two values:
CURLM_OK, else a CURLM_ error code.
See (*manpages*)curl_multi_wait.
extra-fds must be #f or a Scheme vector holding zero or more
instances of curl-waitfd (which are internally converted to
struct curl_waitfd); such structures are mutated by this function
to reflect the manipulations performed by cURL.
timeout must be an exact integer in the range of the C language
type int representing the number of milliseconds to wait for an
event to happen.
The following is a usage example for curl-multi-wait and
curl-multi-socket-action:
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants)
(prefix (vicare ffi) ffi.)
(prefix (vicare posix) px.))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(define-inline (%pretty-print ?thing)
(pretty-print ?thing (current-error-port)))
(define-struct pending-socks
(rd-requests
;Null or a list of socket descriptors for which reading
;is requested.
wr-requests
;Null or a list of socket descriptors for which writing
;is requested.
rw-requests
;Null or a list of socket descriptors for which reading
;or writing is requested.
))
(define (%make-pending-socks)
(make-pending-socks '() '() '()))
(define (pending-socks-remove! ps sock-fd)
(pending-socks-remove-from-rd-requests! ps sock-fd)
(pending-socks-remove-from-wr-requests! ps sock-fd)
(pending-socks-remove-from-rw-requests! ps sock-fd))
(define (pending-socks-remove-from-rd-requests! ps sock-fd)
(set-pending-socks-rd-requests! ps
(remq sock-fd (pending-socks-rd-requests ps))))
(define (pending-socks-remove-from-wr-requests! ps sock-fd)
(set-pending-socks-wr-requests! ps
(remq sock-fd (pending-socks-wr-requests ps))))
(define (pending-socks-remove-from-rw-requests! ps sock-fd)
(set-pending-socks-rw-requests! ps
(remq sock-fd (pending-socks-rw-requests ps))))
(define (pending-socks-rd-request! ps sock-fd)
(set-pending-socks-rd-requests! ps
(cons sock-fd (pending-socks-rd-requests ps))))
(define (pending-socks-wr-request! ps sock-fd)
(set-pending-socks-wr-requests! ps
(cons sock-fd (pending-socks-wr-requests ps))))
(define (pending-socks-rw-request! ps sock-fd)
(set-pending-socks-rw-requests! ps
(cons sock-fd (pending-socks-rw-requests ps))))
;;;
(define (%curl-multi-socket-action multi sock-fd events)
(let loop ()
(let-values (((code still-running)
(curl-multi-socket-action multi sock-fd events)))
(if (= code CURLM_CALL_MULTI_PERFORM)
(loop)
(values code still-running)))))
(define (socket-func easy sock-fd poll-type
callback-data sock-fd-data)
(define ps
(retrieve-to-avoid-collecting callback-data))
(case-integers poll-type
((CURL_POLL_NONE)
(void))
((CURL_POLL_IN)
(pending-socks-rd-request! ps sock-fd))
((CURL_POLL_OUT)
(pending-socks-wr-request! ps sock-fd))
((CURL_POLL_INOUT)
(pending-socks-rw-request! ps sock-fd))
((CURL_POLL_REMOVE)
(pending-socks-remove! ps sock-fd))))
(define (write-func buffer size nitems outstream)
(let ((nbytes (* size nitems)))
(guard (E (else (pretty-print E) nbytes))
(fprintf (current-error-port) "Google's Home page:\n~a\n"
(utf8->string (cstring->bytevector buffer nbytes))))
nbytes))
(define (timer-func multi milliseconds timeout-pointer)
(replace-to-avoid-collecting timeout-pointer milliseconds)
0)
;;;
(let*
((multi (curl-multi-init))
(easy (curl-easy-init))
(write-cb (make-curl-write-callback write-func))
(socket-cb (make-curl-socket-callback socket-func))
(timer-cb (make-curl-multi-timer-callback timer-func))
(timeout-pointer
(register-to-avoid-collecting -1))
(pending-socks
(%make-pending-socks))
(pending-socks-pointer
(register-to-avoid-collecting pending-socks)))
(unwind-protect
(begin
(curl-easy-setopt easy CURLOPT_URL "http://google.com/")
(curl-easy-setopt easy CURLOPT_WRITEFUNCTION write-cb)
(curl-easy-setopt easy CURLOPT_WRITEDATA #f)
(curl-multi-setopt multi
CURLMOPT_TIMERFUNCTION timer-cb)
(curl-multi-setopt multi
CURLMOPT_TIMERDATA timeout-pointer)
(curl-multi-setopt multi
CURLMOPT_SOCKETFUNCTION socket-cb)
(curl-multi-setopt multi
CURLMOPT_SOCKETDATA pending-socks-pointer)
(curl-multi-add-handle multi easy)
(let loop ()
(let-values
(((code still-running)
(%curl-multi-socket-action multi CURL_SOCKET_TIMEOUT 0)))
(when (and (= code CURLM_OK)
(not (zero? still-running)))
(let-values
(((code number-of-eventful-fds)
(curl-multi-wait multi #f
(retrieve-to-avoid-collecting timeout-pointer))))
(when (= code CURLM_OK)
(for-each
(lambda (sock-fd)
(%curl-multi-socket-action multi sock-fd
CURL_CSELECT_IN))
(pending-socks-rd-requests pending-socks))
(for-each
(lambda (sock-fd)
(%curl-multi-socket-action multi sock-fd
CURL_CSELECT_OUT))
(pending-socks-wr-requests pending-socks))
(loop))))))
(let-values (((msg nmsgs)
(curl-multi-info-read multi)))
(when msg
(%pretty-print
(curl-constant-msg->symbol (curl-msg.msg msg))))))
;;Close handles before releasing the callbacks!!!
(curl-multi-cleanup multi)
(curl-easy-cleanup easy)
(ffi.free-c-callback write-cb)
(ffi.free-c-callback timer-cb)
(ffi.free-c-callback socket-cb)
(forget-to-avoid-collecting pending-socks-pointer)))
Next: multi sockets data, Previous: multi sockets polls, Up: multi sockets [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Perform the pending actions for the socket descriptor sock-fd; return 2 values:
CURLM_OK, else a CURLM_ error code.
See (*manpages*)curl_multi_socket_action.
sock-fd must be the constant CURL_SOCKET_TIMEOUT or a
non–negative fixnum representing a socket descriptor in the context of
multi.
The optional ev-bitmask must be the fixnum zero or a bitwise
inclusive OR combination of the following constants:
CURL_CSELECT_IN, CURL_CSELECT_OUT,
CURL_CSELECT_ERR; when not given: ev-bitmask defaults to
zero.
Query the multi handle for how many milliseconds to wait for socket actions; if successful return 2 values:
CURLM_OK.
else return the values: a CURLM_ error code and #f.
See (*manpages*)curl_multi_timeout.
Next: multi sockets depre, Previous: multi sockets action, Up: multi sockets [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Associate custom-data to sock-fd in the context of the
multi handle; if successful return CURLM_OK, else return a
CURLM_ error code. See (*manpages*)curl_multi_assign.
sock-fd must be a non–negative fixnum representing a socket descriptor.
custom-data must be #f or a pointer object; #f is
internally converted to a NULL pointer.
Previous: multi sockets data, Up: multi sockets [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
This function is deprecated. See (*manpages*)curl_multi_socket.
This function is deprecated. See (*manpages*)curl_multi_socket_all.
Previous: multi sockets, Up: multi [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Retrieve the next informative message if any; return 2 values:
#f or a pointer object referencing the next message from the queue
of messages as an instance of CURLMsg. If this value is #f
it means that no messages are present.
See (*manpages*)curl_multi_info_read.
We can access the fields of a CURLMsg structure with the curl-msg functions;
cstructs msg for details.
Return #f or a string describing the code CURLM_
constant, which must be of type CURLMcode; #f is returned
if no message is available. See (*manpages*)curl_multi_strerror.
Easy API callbacks | ||
|---|---|---|
| • callbacks write: | Receiving data from a file transfer. | |
| • callbacks read: | Sending data to a file transfer. | |
| • callbacks ioctl: | Special control of a file transfer. | |
| • callbacks seek: | Seeking into an outgoing file. | |
| • callbacks sockopt: | Additional options for socket descriptors. | |
| • callbacks opensocket: | Opening a socket descriptor. | |
| • callbacks closesocket: | Closing a socket descriptor. | |
| • callbacks progress: | Tracking file transfer progress. | |
| • callbacks header: | Receiving headers from file transfer. | |
| • callbacks debug: | Debugging callback. | |
| • callbacks sslctx: | OpenSSL context configuration. | |
| • callbacks tonet: | Converting from host encoding to network encoding. | |
| • callbacks fromnet: | Converting from network encoding to host encoding. | |
| • callbacks fromutf8: | Converting from UTF-8 to host encoding. | |
| • callbacks interleave: | Processing interleaved RTP data. | |
| • callbacks chunk: | Processing informations about chunks of data. | |
| • callbacks fnmatch: | Implementing wildcard matching. | |
| • callbacks sshkey: | Accepting or rejecting SSH connections. | |
| • callbacks xferinfo: | Getting notifications of timeouts. | |
Multi API callbacks | ||
| • callbacks socket: | Getting informations about socket status. | |
| • callbacks mtimer: | Getting notifications of timeouts. | |
Next: callbacks read, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_write_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_WRITEFUNCTION option of curl-easy-setopt; it is
invoked to consume data incoming from a connection.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 4 arguments:
#f or a pointer object referencing an application selected value;
this value is associated to the callback with the
CURLOPT_WRITEDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact
integer: either the number of items consumed from the input
buffer or the constant CURL_WRITEFUNC_PAUSE.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
Next: callbacks ioctl, Previous: callbacks write, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_read_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_READFUNCTION option of curl-easy-setopt; it is
invoked to produce data outgoing to a connection.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 4 arguments:
#f or a pointer object referencing an application selected value;
this value is associated to the callback with the
CURLOPT_READDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact
integer: either the number of bytes actually written to the
output buffer or one of the constants CURL_READFUNC_ABORT,
CURL_READFUNC_PAUSE. Returning zero will signal the
end–of–file and will cause the end of the file transfer.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURL_READFUNC_ABORT to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks seek, Previous: callbacks read, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_ioctl_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_IOCTLFUNCTION option of curl-easy-setopt; it is
invoked to perform special operations in a connection.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 3 arguments:
curl-easy referencing the invoking session.
curliocmd constants:
CURLIOCMD_NOP, CURLIOCMD_RESTARTREAD.
#f or a pointer object referencing an application selected value;
this value is associated to the callback with the
CURLOPT_IOCTLDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact
integer, one of the curlioerr constants: CURLIOE_OK,
CURLIOE_UNKNOWNCMD, CURLIOE_FAILRESTART.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURLIOE_UNKNOWNCMD to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks sockopt, Previous: callbacks ioctl, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_seek_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_SEEKFUNCTION option of curl-easy-setopt; it is
invoked to seek to a position in the outgoing file.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 3 arguments:
#f or a pointer object referencing an application selected value;
this value is associated to the callback with the
CURLOPT_SEEKDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
SEEK_SET, SEEK_CUR,
SEEK_END from the library (vicare platform-constants).
user-scheme-callback must return a single value being an exact
integer, one of the constants: CURL_SEEKFUNC_OK,
CURL_SEEKFUNC_FAIL, CURL_SEEKFUNC_CANTSEEK.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURL_SEEKFUNC_FAIL to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks opensocket, Previous: callbacks seek, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_sockopt_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_SOCKOPTFUNCTION option of curl-easy-setopt; it is
invoked to allow an application to set additional socket options using
setsockopt from the library (vicare posix).
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 3 arguments:
#f or a pointer object referencing an application selected value;
this value is associated to the callback with the
CURLOPT_SOCKOPTDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
curlsocktype: CURLSOCKTYPE_IPCXN,
CURLSOCKTYPE_ACCEPT.
user-scheme-callback must return a single value being an exact
integer, one of the constants: CURL_SOCKOPT_OK,
CURL_SOCKOPT_ERROR, CURL_SOCKOPT_ALREADY_CONNECTED.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURL_SOCKOPT_ERROR to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks closesocket, Previous: callbacks sockopt, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_opensocket_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_OPENSOCKETFUNCTION option of curl-easy-setopt; it
is invoked to allow an application to open a socket using socket
from the library (vicare posix) and optionally set some socket
options using setsockopt. See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 3 arguments:
#f or a pointer object referencing an application selected value;
this value is associated to the callback with the
CURLOPT_OPENSOCKETDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
curlsocktype: CURLSOCKTYPE_IPCXN,
CURLSOCKTYPE_ACCEPT.
struct curl_sockaddr;
such data structure can be accessed with the curl-sockaddr.
functions, curl-sockaddr.
user-scheme-callback must return a single value being the exact
integer representing the socket descriptor or the constant
CURL_SOCKET_BAD.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURL_SOCKET_BAD to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks progress, Previous: callbacks opensocket, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_closesocket_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_CLOSESOCKETFUNCTION option of curl-easy-setopt; it
is invoked to allow an application to close a socket using close
from the library (vicare posix). See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 2 arguments:
#f or a pointer object referencing an application selected value;
this value is associated to the callback with the
CURLOPT_CLOSESOCKETDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being the exact
integer: 0 to signal success or 1 to signal failure.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 1 to the caller. user-scheme-callback
should take care of handling its own exceptions.
Next: callbacks header, Previous: callbacks closesocket, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_progress_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_PROGRESSFUNCTION option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 5 arguments:
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLOPT_PROGRESSDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value which is the answer to the question “Abort the transfer?”; when the returned value is true the transfer is aborted, else the transfer will proceed.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
1; else the value returned is 0.
Next: callbacks debug, Previous: callbacks progress, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function; the returned pointer must be released
with a call to free-c-callback from (vicare ffi).
This callback is associated to curl-easy instances with the
CURLOPT_HEADERFUNCTION option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 4 arguments:
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLOPT_HEADERDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact integer: the number of bytes consumed from the input buffer; if the returned value is different from the product between the second and third arguments: it means an error occurred.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
Next: callbacks sslctx, Previous: callbacks header, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_debug_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_DEBUGFUNCTION option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 5 arguments:
curl-easy referencing the invoking session.
curl_infotype, one of the constants: CURLINFO_TEXT,
CURLINFO_HEADER_IN, CURLINFO_HEADER_OUT,
CURLINFO_DATA_IN, CURLINFO_DATA_OUT,
CURLINFO_SSL_DATA_IN, CURLINFO_SSL_DATA_OUT.
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLOPT_DEBUGDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being the exact
integer 0.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
Next: callbacks tonet, Previous: callbacks debug, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_ssl_ctx_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_SSL_CTX_FUNCTION option of curl-easy-setopt; it
allows the application to specify options and actions for OpenSSL
operations. See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 3 arguments:
curl-easy referencing the invoking session.
SSL_CTX defined by OpenSSL.
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLOPT_SSL_CTX_DATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact
integer: if successful CURLE_OK, else one of the CURLE_
error codes.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURLE_ABORTED_BY_CALLBACK to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks fromnet, Previous: callbacks sslctx, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as callback; the
returned pointer must be released with a call to free-c-callback
from (vicare ffi).
This callback is associated to curl-easy instances with the
CURLOPT_CONV_TO_NETWORK_FUNCTION option of
curl-easy-setopt; its purpose is to convert from host encoding to
network encoding. See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 2 arguments:
user-scheme-callback must return a single value being an exact
integer: if successful CURLE_OK, else one of the CURLE_
error codes.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURLE_ABORTED_BY_CALLBACK to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks fromutf8, Previous: callbacks tonet, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as callback; the
returned pointer must be released with a call to free-c-callback
from (vicare ffi).
This callback is associated to curl-easy instances with the
CURLOPT_CONV_FROM_NETWORK_FUNCTION option of
curl-easy-setopt; its purpose is to convert from network encoding
to host encoding. See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 2 arguments:
user-scheme-callback must return a single value being an exact
integer: if successful CURLE_OK, else one of the CURLE_
error codes.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURLE_ABORTED_BY_CALLBACK to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks interleave, Previous: callbacks fromnet, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as callback; the
returned pointer must be released with a call to free-c-callback
from (vicare ffi).
This callback is associated to curl-easy instances with the
CURLOPT_CONV_FROM_UTF8_FUNCTION option of
curl-easy-setopt; its purpose is to convert from network encoding
to host encoding. See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 2 arguments:
user-scheme-callback must return a single value being an exact
integer: if successful CURLE_OK, else one of the CURLE_
error codes.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURLE_ABORTED_BY_CALLBACK to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks chunk, Previous: callbacks fromutf8, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as callback; the
returned pointer must be released with a call to free-c-callback
from (vicare ffi).
This callback is associated to curl-easy instances with the
CURLOPT_INTERLEAVEFUNCTION option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 5 arguments:
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLOPT_INTERLEAVEDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact integer representing the number of bytes consumed from the input.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
Next: callbacks fnmatch, Previous: callbacks interleave, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_chunk_bgn_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_CHUNK_BGN_FUNCTION option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 3 arguments:
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLOPT_CHUNK_DATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact
integer, one among: CURL_CHUNK_BGN_FUNC_OK,
CURL_CHUNK_BGN_FUNC_FAIL, CURL_CHUNK_BGN_FUNC_SKIP.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURL_CHUNK_BGN_FUNC_FAIL to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_chunk_end_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_CHUNK_END_FUNCTION option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept one argument: #f or a
pointer object referencing an application selected value; such value is
associated to the callback with the CURLOPT_CHUNK_DATA option of
curl-easy-setopt. See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact
integer, a constant among: CURL_CHUNK_END_FUNC_OK,
CURL_CHUNK_END_FUNC_FAIL.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURL_CHUNK_END_FUNC_FAIL to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks sshkey, Previous: callbacks chunk, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_fnmatch_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_FNMATCH_FUNCTION option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 3 arguments:
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLOPT_FNMATCH_DATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact
integer, a constant among: CURL_FNMATCHFUNC_MATCH,
CURL_FNMATCHFUNC_NOMATCH, CURL_FNMATCHFUNC_FAIL.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURL_FNMATCHFUNC_FAIL to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks xferinfo, Previous: callbacks fnmatch, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_sshkeycallback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_SSH_KEYFUNCTION option of curl-easy-setopt; it is
invoked to accept or reject SSH connections.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 5 arguments:
curl-easy referencing the invoking session.
#f or a pointer object, referencing an instance of the C language
type struct curl_khkey, representing the key from the
known_hosts file.
struct curl_khkey, representing the key from the remote site.
enum
curl_khmatch, one among: CURLKHMATCH_OK,
CURLKHMATCH_MISMATCH, CURLKHMATCH_MISSING.
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLOPT_SSH_KEYDATA option of curl-easy-setopt.
See (*manpages*)curl_easy_setopt.
user-scheme-callback must return a single value being an exact
integer representing a constant of type enum curl_khstat, one
among: CURLKHSTAT_FINE_ADD_TO_FILE, CURLKHSTAT_FINE,
CURLKHSTAT_REJECT, CURLKHSTAT_DEFER.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns CURLKHSTAT_REJECT to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: callbacks socket, Previous: callbacks sshkey, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_xferinfo_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-easy instances with the
CURLOPT_XFERINFOFUNCTION option of curl-easy-setopt; it is
invoked to notify the application of statistics about the transferred
data. See (*manpages*)curl_easy_setopt.
user-scheme-callback must accept 5 arguments:
#f or a custom pointer selected by the application with the option
CURLOPT_XFERINFODATA.
user-scheme-callback must return a single value being an exact
integer in the range of the C language type signed int; when the
callback is successul: the return value should be zero, non–zero
otherwise.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
Next: callbacks mtimer, Previous: callbacks xferinfo, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_socket_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-multi instances with the
CURLMOPT_SOCKETFUNCTION option of curl-multi-setopt; it is
invoked to notify the application about status changes for a socket
descriptor. See (*manpages*)curl_multi_setopt.
user-scheme-callback must accept 5 arguments:
curl-easy referencing the session associated to
the socket.
CURL_POLL_NONE, CURL_POLL_IN, CURL_POLL_OUT,
CURL_POLL_INOUT, CURL_POLL_REMOVE.
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLMOPT_SOCKETDATA option of curl-multi-setopt.
See (*manpages*)curl_multi_setopt.
#f or a pointer object referencing an application selected value;
such value is associated to the socket descriptor with the
function curl-multi-assign. See (*manpages*)curl_multi_assign.
user-scheme-callback can return unspecified values.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
0 to the caller.
Previous: callbacks socket, Up: callbacks [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
curl_multi_timer_callback callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
This callback is associated to curl-multi instances with the
CURLMOPT_TIMERFUNCTION option of curl-multi-setopt; it is
invoked to notify the application about changes in timeout expirations.
See (*manpages*)curl_multi_setopt.
user-scheme-callback must accept 5 arguments:
curl-multi referencing the invoking session.
-1 means that there is no pending
timeout; a value of 0 means that the timeout has already expired.
#f or a pointer object referencing an application selected value;
such value is associated to the callback with the
CURLMOPT_TIMERDATA option of curl-multi-setopt.
See (*manpages*)curl_multi_setopt.
user-scheme-callback must return a single value being an exact integer of unknown meaning (but there is a meaning believe me, I just do not know what it is).
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
The following bindings are exported by the library (vicare net
curl).
Add a string to a list of strings, possibly creating a new list; if
successful return a pointer object representing the head of the list,
else return #f. See (*manpages*)curl_slist_append.
The returned list must be released by curl-slist-free-all.
slist must be #f or a pointer object. When slist is
#f or the NULL pointer or not given: a new list is allocated.
string must be a string, ASCII bytevector, pointer or
memory-block.
#!r6rs
(import (vicare)
(vicare net curl))
;; assuming no error occurs
(let* ((slist (curl-slist-append "ciao"))
(slist (curl-slist-append slist "hello"))
(slist (curl-slist-append slist "salut")))
(curl-slist-free-all slist)
slist)
⇒ #<pointer #x00000000>
Release all the resources associated to slist, which must be the
return value of a previous call to curl-slist-append; return
unspecified values. See (*manpages*)curl_slist_free_all.
slist must be #f or a pointer. When slist is #f
or a NULL pointer: nothing happens. When slist is a
non–NULL pointer: slist itself is mutated to represent
NULL.
It is safe to apply this function multiple times to the same slist argument.
Convert a list of strings to and from a curl-list.
| • forms structs: | HTTP post data structures. | |
| • forms init: | Initialisation and finalisation. | |
| • forms adding: | Adding data to HTTP post. | |
| • forms inspect: | Inspecting HTTP post data. |
Next: forms init, Up: forms [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Opaque structure type referencing the first element in a C language
struct curl_httppost chain.
When instances of this type are used as arguments to functions: this documentation identifies them as httppost.
Instances of this type must be finalised with curl-formfree.
Whenever an instance of this type is garbage collected:
curl-formfree is automatically applied to it.
Return #t if obj is an instance of curl-form-data;
otherwise return #f.
Return #t if obj is an instance of curl-form-data and
it holds some contents; otherwise return #f.
Retrieve or set a destructor function associated to the httppost.
Whenever the httppost is finalised, either explicitly with
curl-formfree or implicitly by the garbage collector, func
is applied to httppost before the internal state of httppost
is finalised.
Notice that func can do anything, not only destroy some state associated to httppost; if we do:
(define httppost ...)
(set-curl-form-data-custom-destructor! httppost
(let ((state (make-some-data-struct)))
(case-lambda
((httppost)
(destroy state))
(()
state))))
(let ((state ((curl-form-data-custom-destructor httppost))))
(do-something-with httppost state))
we can easily associate values to httppost.
Next: forms adding, Previous: forms structs, Up: forms [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Build and return a new instance of curl-form-data ready to be
handed to curl-formadd.
Release all the resources associated to httppost, which must be an
instance of curl-form-data; return unspecified values.
See (*manpages*)curl_formfree.
It is safe to apply this function multiple times to the same httppost argument: the first time the data is finalised, the subsequent times nothing happens.
Next: forms inspect, Previous: forms init, Up: forms [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Add a section to a multipart/formdata HTTP POST; if
successful return CURL_FORMADD_OK, else return a
CURL_FORMADD_ error code. See (*manpages*)curl_formadd.
httppost must be an instance of curl-form-data; at the
first invocation of this function httppost must be the return
value of make-curl-form-data.
Each opt/val couple must be an option/value couple in which
opt is one of the CURLFORM_ constants and val is one
among: an exact integer in the range of the C language type long,
a string, an ASCII bytevector, a pointer, a memory-block.
When present end must be the constant CURLFORM_END.
Example of adding 2 parts:
(import (rnrs) (vicare net curl) (vicare net curl constants)) (assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL))) (define http-post (make-curl-form-data)) (curl-formadd http-post CURLFORM_COPYNAME "name" CURLFORM_COPYCONTENTS "contents" CURLFORM_END) (curl-formadd http-post CURLFORM_COPYNAME "other_name" CURLFORM_COPYCONTENTS "other contents" CURLFORM_END)
the string returned by curl-form-data-string for such composition
is something like (with line wrapping added):
Content-Type: multipart/form-data; \ boundary=----------------------------81c1e6167e72 ------------------------------81c1e6167e72 Content-Disposition: form-data; name="name" contents ------------------------------81c1e6167e72 Content-Disposition: form-data; name="other_name" other contents ------------------------------81c1e6167e72--
Previous: forms adding, Up: forms [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Given an instance of curl-form-data extract a string representing
the current contents; if successful return the string, else return
#f.
Invoke a callback for each line of content in httppost; when
successful return #f, else return #t.
See (*manpages*)curl_formget.
httppost must be an instance of curl-form-data.
callback must be the return value of a call to
make-curl-formget-callback.
custom-data must be #f or a pointer object that will be used
as first argument to callback; when #f, the argument will be
the NULL pointer.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as callback
argument in calls to curl-formget; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
user-scheme-function must accept 3 arguments:
curl-formget.
size_t,
representing the number of bytes in the content.
When successful user-scheme-callback must return its last
argument, the number of bytes in the content; else it must return a
different exact integer in the range of the C language type
size_t.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); user-scheme-callback should take care of
handling its own exceptions.
Here is a meaningless usage of the callback:
(program (demo)
(options typed-language)
(import (vicare)
(vicare net curl)
(vicare net curl constants)
(prefix (vicare ffi) ffi::))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(define http-post
(make-curl-form-data))
(curl-formadd http-post
CURLFORM_COPYNAME "name"
CURLFORM_COPYCONTENTS "contents"
CURLFORM_END)
(define {data <string>} "")
(define callback
(make-curl-formget-callback
(lambda (custom-data cstring.ptr cstring.len)
(set! data (string-append data
(cstring->string cstring.ptr
cstring.len)))
cstring.len)))
(curl-formget http-post #f callback)
(ffi::free-c-callback callback)
(curl-formfree http-post)
#| end of program |# )
Libcurl allows us to share entities and configuration options among easy handles through shared sets called shares.
| • shares examples: | Shares examples. | |
| • shares structs: | Shares data structures. | |
| • shares init: | Initialisation and finalisation of shares. | |
| • shares opts: | Registering in shares. | |
| • shares callbacks: | Preparing callback functions. | |
| • shares misc: | Miscellaneous shares functions. |
Next: shares structs, Up: shares [Contents][Index]
Random options setting:
#!r6rs
(import (vicare)
(vicare net curl)
(vicare net curl constants))
(assert (= CURLE_OK (curl-global-init CURL_GLOBAL_ALL)))
(define share
(curl-share-init))
(curl-share-setopt share CURLSHOPT_SHARE CURL_LOCK_DATA_COOKIE)
⇒ CURLSHE_OK
(curl-share-setopt share CURLSHOPT_SHARE CURL_LOCK_DATA_DNS)
⇒ CURLSHE_OK
(curl-share-setopt share CURLSHOPT_USERDATA #f)
⇒ CURLSHE_OK
(curl-share-setopt share CURLSHOPT_LOCKFUNC
(make-curl-lock-function
(lambda (easy what-to-lock how-to-lock custom-data)
(void))))
⇒ CURLSHE_OK
(curl-share-setopt share CURLSHOPT_UNLOCKFUNC
(make-curl-lock-function
(lambda (easy what-to-lock custom-data)
(void))))
⇒ CURLSHE_OK
(define easy
(curl-easy-init))
(curl-easy-setopt easy CURLOPT_SHARE share)
⇒ CURLE_OK
Next: shares init, Previous: shares examples, Up: shares [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Opaque structure type used to reference instances of the C language type
CURLSH. Such data structures can be registered in easy handles
with the CURLOPT_SHARE option of curl-easy-setopt.
When instances of this type are used as arguments to functions: this documentation identifies them as share.
Instances of this type must be finalised with curl-share-cleanup;
whenever an instance of this type is garbage collected:
curl-share-cleanup is automatically applied to it and any error
ignored.
Return #t if obj is an instance of curl-share;
otherwise return #f.
Return #t if obj is an instance of curl-share and it
has not been finalised yet; otherwise return #f.
Retrieve or set a destructor function associated to the share.
Whenever the share is finalised, either explicitly with
curl-share-cleanup or implicitly by the garbage collector,
func is applied to share before the internal state of
share is finalised.
Notice that func can do anything, not only destroy some state associated to share; if we do:
(define share ...)
(set-curl-share-custom-destructor! share
(let ((state (make-some-data-struct)))
(case-lambda
((share)
(destroy state))
(()
state))))
(let ((state ((curl-share-custom-destructor share))))
(do-something-with share state))
we can easily associate values to share.
Next: shares opts, Previous: shares structs, Up: shares [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Build a new instance of curl-share; if successful return the
instance, else return #f. See (*manpages*)curl_share_cleaup.
Attempt to release all the resources associated to share, which
must be an instance of curl-share. If the finalisation happens
and it is successful: return CURLSHE_OK; if the finalisation
happens and it fails: return a CURLSHE_ error code; if
share was already finalised: return #f.
See (*manpages*)curl_share_cleanup.
It is safe to apply this function multiple times to the same share object: the first time the data is finalised, the subsequent times nothing happens.
NOTE When this function actually finalises a CURLSH
object the registered callbacks may be called; be careful not to release
them before finalising share.
Next: shares callbacks, Previous: shares init, Up: shares [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Set option to parameter for the given share; if
successful return CURLSHE_OK, else return a CURLSHE_ error
code. See (*manpages*)curl_share_setopt.
option must be an exact integer representing a CURLSHOPT_
constant.
The type of parameter depends on option. Whenever the
option requires a pointer value: parameter can be either a
pointer object or #f, which will be converted to NULL.
Next: shares misc, Previous: shares opts, Up: shares [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as parameter
argument in calls to curl-share-setopt with option set to
CURLSHOPT_LOCKFUNC; the returned pointer must be released with a
call to free-c-callback from (vicare ffi).
user-scheme-function must accept 4 arguments:
curl-easy not holding ownership
for the wrapped CURL instance.
CURL_LOCK_DATA_ constant.
CURL_LOCK_ACCESS_ constant.
CURLSHOPT_USERDATA; this is #f or a pointer
object.
user-scheme-callback can return unspecified values.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
(void) is returned instead.
guard from
(vicare); user-scheme-callback should take care of
handling its own exceptions.
(void).
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as parameter
argument in calls to curl-share-setopt with option set to
CURLSHOPT_UNLOCKFUNC; the returned pointer must be released with
a call to free-c-callback from (vicare ffi).
user-scheme-function must accept 3 arguments:
curl-easy not holding ownership
for the wrapped CURL instance.
CURL_LOCK_DATA_ constant.
CURLSHOPT_USERDATA; this is #f or a pointer
object.
user-scheme-callback can return unspecified values.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
(void) is returned instead.
guard from
(vicare); user-scheme-callback should take care of
handling its own exceptions.
(void).
Previous: shares callbacks, Up: shares [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Given an exact integer representing a CURLSHE_ error code return
an ASCII bytevector or string describing the associated error.
See (*manpages*)curl_share_strerror.
| • cstructs sockaddr: | Accessing struct curl_sockaddr.
| |
| • cstructs fileinfo: | Accessing struct curl_fileinfo.
| |
| • cstructs khkey: | Accessing struct curl_khkey.
| |
| • cstructs forms: | Accessing struct curl_forms arrays.
| |
| • cstructs certinfo: | Accessing struct curl_certinfo.
| |
| • cstructs msg: | Accessing struct CURLMsg.
| |
| • cstructs tlssessioninfo: | Accessing struct curl_tlssessioninfo.
|
Next: cstructs fileinfo, Up: cstructs [Contents][Index]
struct curl_sockaddrThe following bindings are exported by the library (vicare net
curl).
Given a pointer to a struct curl_sockaddr, return the value of
each field in such structure. All the functions return an exact
integer, but curl-sockaddr.addr which returns a bytevector
holding the whole struct sockaddr field.
Next: cstructs khkey, Previous: cstructs sockaddr, Up: cstructs [Contents][Index]
struct curl_fileinfoThe following bindings are exported by the library (vicare net
curl).
Structure type mirroring a C language structure of type struct
curl_fileinfo. It has the following fields:
filename#f or a string.
filetypeAn exact integer.
timeAn exact integer.
permAn exact integer.
uidAn exact integer.
gidAn exact integer.
sizeAn exact integer.
hardlinksAn exact integer.
strings.time#f or a string.
strings.perm#f or a string.
strings.user#f or a string.
strings.group#f or a string.
strings.target#f or a string.
flagsAn exact integer.
Return #t if obj is an instance of curl-fileinfo.
Given a pointer object referencing a C language struct
curl_fileinfo, build and return an instance of curl-fileinfo
mirroring it.
Accessors for the fields of a curl-fileinfo instance.
Accessors for C language struct curl_fileinfo instances
referenced by a pointer object. When a struct field is of type
char *: the corresponding accessor returns a pointer object.
Next: cstructs forms, Previous: cstructs fileinfo, Up: cstructs [Contents][Index]
struct curl_khkeyThe following bindings are exported by the library (vicare net
curl).
Given a pointer object referencing a C language struct
curl_khkey, return two values:
#t if the second value holds data encoded in base64, #f if
the second value holds raw data.
Next: cstructs certinfo, Previous: cstructs khkey, Up: cstructs [Contents][Index]
struct curl_forms arraysThe following bindings are exported by the library (vicare net
curl).
Return the number of bytes that need to be allocated to hold an array of
number-of-structs instances of type struct curl_forms.
Given array as bytevector or pointer object or memory-block
holding an array of struct curl_forms, extract and return an
exact integer representing the option field of the structure at
index.
Given array as bytevector or pointer object or memory-block
holding an array of struct curl_forms, extract the value
field of the structure at index and return #f if it is
NULL or a string if it is not.
Given array as bytevector or pointer object or memory-block
holding an array of struct curl_forms, store the exact integer
value in the option field of the structure at index.
Given array as bytevector or pointer object or memory-block
holding an array of struct curl_forms, store the pointer from
value in the field of the structure at index.
value must be a pointer object or memory-block.
Next: cstructs msg, Previous: cstructs forms, Up: cstructs [Contents][Index]
struct curl_certinfoThe following bindings are exported by the library (vicare net
curl).
Given a pointer to an instance of struct curl_certinfo: return a
vector holding one item for each certificate in the structure; each item
is a list of strings representing informations about the certificate;
each string has the format name:value.
Notice that when using curl-easy-getinfo with the
CURLINFO_CERTINFO option: the returned value is already the
vector of lists of strings.
Next: cstructs tlssessioninfo, Previous: cstructs certinfo, Up: cstructs [Contents][Index]
struct CURLMsgThe following bindings are exported by the library (vicare net
curl).
Given a pointer to an instance of struct CURLMsg, return an exact
integer representing the value of the field CURLMSG msg.
Given a pointer to an instance of struct CURLMsg, return a
temporary instance of curl-easy referencing the value of the
field CURL *easy_handle.
Given a pointer to an instance of struct CURLMsg, return a
pointer object representing the value of the field void *
whatever in the union data.
Given a pointer to an instance of struct CURLMsg, return an exact
integer representing the value of the field CURLcode result in
the union data.
Previous: cstructs msg, Up: cstructs [Contents][Index]
struct curl_tlssessioninfoThe following bindings are exported by the library (vicare net
curl).
Given a pointer to an instance of struct curl_tlssessioninfo,
return an exact integer representing the value of the field
backend.
The returned value is one of the constants in the enum
curl_sslbackend, among the valid values are:
CURLSSLBACKEND_AXTLS CURLSSLBACKEND_CYASSL CURLSSLBACKEND_DARWINSSL CURLSSLBACKEND_GNUTLS CURLSSLBACKEND_GSKIT CURLSSLBACKEND_NONE CURLSSLBACKEND_NSS CURLSSLBACKEND_OPENSSL CURLSSLBACKEND_POLARSSL CURLSSLBACKEND_QSOSSL CURLSSLBACKEND_SCHANNEL
Given a pointer to an instance of struct curl_tlssessioninfo,
return a pointer object representing the value of the field
internals.
The following bindings are exported by the library (vicare net
curl).
Release memory allocated through a call to the cURL library; return unspecified values. See (*manpages*)curl_free.
pointer must be #f or a pointer object; when pointer
is neither #f nor NULL: pointer is mutated to represent
the NULL pointer.
It is safe to apply this function multiple times to the same pointer.
Obsolete function. Escape all the characters in the input string to
make it ready to be an URL component; if successful return a
bytevector holding the ASCII encoding of the string, else return
#f. See (*manpages*)curl_escape.
str.data and str.len must represent a generalised C string, (vicare-scheme)Introduction to generalised C strings. It must hold the representation of an ASCII string.
Like curl-escape but return a Scheme string.
Obsolete function. Unescape all the characters in the input string as
if it comes from a URL component; if successful return a bytevector
holding the ASCII encoding of the string, else return #f.
See (*manpages*)curl_unescape.
str.data and str.len must represent a generalised C string, (vicare-scheme)Introduction to generalised C strings. It must hold the representation of an ASCII string.
Like curl-unescape but return a Scheme string.
Convert a date string to the the number of seconds since the Epoch. See (*manpages*)curl_getdate.
date must represent a generalised C string, (vicare-scheme)Introduction to generalised C strings. It must represent an ASCIIZ string.
(import (vicare) (vicare net curl)) (curl-getdate "Sun Nov 6 94") ⇒ 784080000
Next: Package License, Previous: misc, Up: Top [Contents][Index]
The following bindings are exported by the library (vicare net
curl).
Given one among the HTTPPOST_ constants return a symbol
representing its name.
Given one among the CURLFILETYPE_ constants return a symbol
representing its name.
Given one among the CURLFINFOFLAG_ constants return a symbol
representing its name.
Given one among the CURL_CHUNK_BGN_ constants return a symbol
representing its name.
Given one among the CURL_CHUNK_END_ constants return a symbol
representing its name.
Given one among the CURL_FNMATCHFUNC_ constants return a symbol
representing its name.
Given one among the CURL_SEEKFUNC_ constants return a symbol
representing its name.
Given one among the CURL_READFUNC_ constants return a symbol
representing its name.
Given one among the CURLSOCKTYPE_ constants return a symbol
representing its name.
Given one among the CURL_SOCKOPT_ constants return a symbol
representing its name.
Given one among the CURLIOE_ constants return a symbol
representing its name.
Given one among the CURLIOCMD_ constants return a symbol
representing its name.
Given one among the CURLINFO_TEXT, CURLINFO_HEADER_IN,
CURLINFO_HEADER_OUT, CURLINFO_DATA_IN,
CURLINFO_DATA_OUT, CURLINFO_SSL_DATA_IN,
CURLINFO_SSL_DATA_OUT, CURLINFO_END constants return a
symbol representing its name.
Given one among the CURLE_ constants return a symbol representing
its name.
Given one among the CURLPROXY_ constants return a symbol
representing its name.
Given one among the CURLAUTH_ constants return a symbol
representing its name.
Given one among the CURLSSH_AUTH_ constants return a symbol
representing its name.
Given one among the CURLGSSAPI_DELEGATION_ constants return a
symbol representing its name.
Given one among the CURLKHTYPE_ constants return a symbol
representing its name.
Given one among the CURLKHSTAT_ constants return a symbol
representing its name.
Given one among the CURLKHMATCH_ constants return a symbol
representing its name.
Given one among the CURLUSESSL_ constants return a symbol
representing its name.
Given one among the CURLFTPSSL_CCC_ constants return a symbol
representing its name.
Given one among the CURLFTPAUTH_ constants return a symbol
representing its name.
Given one among the CURLFTP_CREATE_DIR_ constants return a symbol
representing its name.
Given one among the CURLFTPMETHOD_ constants return a symbol
representing its name.
Given one among the CURLPROTO_ constants return a symbol
representing its name.
Given one among the CURLOPTTYPE_ constants return a symbol
representing its name.
Given one among the CURLOPT_ constants return a symbol
representing its name.
Given one among the CURL_IPRESOLVE_ constants return a symbol
representing its name.
Given one among the CURL_HTTP_VERSION_ constants return a symbol
representing its name.
Given one among the CURL_RTSPREQ_ constants return a symbol
representing its name.
Given one among the CURL_NETRC_ constants return a symbol
representing its name.
Given one among the CURL_SSLVERSION_ constants return a symbol
representing its name.
Given one among the CURL_TLSAUTH_ constants return a symbol
representing its name.
Given one among the CURL_REDIR_ constants return a symbol
representing its name.
Given one among the CURL_TIMECOND_ constants return a symbol
representing its name.
Given one among the CURLFORM_ constants return a symbol
representing its name.
Given one among the CURL_FORMADD_ constants return a symbol
representing its name.
Given one among the CURLINFO_STRING, CURLINFO_LONG,
CURLINFO_DOUBLE, CURLINFO_SLIST, CURLINFO_MASK,
CURLINFO_TYPEMASK constants return a symbol representing its
name.
Given one among the CURLINFO_ constants return a symbol
representing its name.
Given one among the CURLCLOSEPOLICY_ constants return a symbol
representing its name.
Given one among the CURL_GLOBAL_ constants return a symbol
representing its name.
Given one among the CURL_LOCK_DATA_ constants return a symbol
representing its name.
Given one among the CURL_LOCK_ACCESS_ constants return a symbol
representing its name.
Given one among the CURLSHE_ constants return a symbol
representing its name.
Given one among the CURLSHOPT_ constants return a symbol
representing its name.
Given one among the CURLVERSION_FIRST, CURLVERSION_SECOND,
CURLVERSION_THIRD, CURLVERSION_FOURTH,
CURLVERSION_LAST, CURLVERSION_NOW constants return a
symbol representing its name.
Given one among the CURL_VERSION_ constants return a symbol
representing its name.
Given one among the CURLPAUSE_ constants return a symbol
representing its name.
Given one among the CURLM_ constants return a symbol representing
its name.
Given one among the CURLMSG_ constants return a symbol
representing its name.
Given one among the CURL_POLL_ constants return a symbol
representing its name.
Given one among the CURL_WAIT_POLL constants return a symbol
representing its name.
Given one among the CURL_CSELECT_ constants return a symbol
representing its name.
Given one among the CURLMOPT_ constants return a symbol
representing its name.
Next: Documentation License, Previous: symbols, Up: Top [Contents][Index]
Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program—to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.
A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the program's name and a brief idea of what it does. Copyright (C) year name of author This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
program Copyright (C) year name of author This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’. This is free software, and you are welcome to redistribute it under certain conditions; type ‘show c’ for details.
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html.
Next: references, Previous: Package License, Up: Top [Contents][Index]
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with
the Front-Cover Texts being list, and with the Back-Cover Texts
being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
Next: concept index, Previous: Documentation License, Up: Top [Contents][Index]
The documentation of Vicare/cURL is available online:
the latest version of this package can be downloaded from:
development takes place at:
the home page of the Vicare project is at:
Libcurl can be found here:
Next: function index, Previous: references, Up: Top [Contents][Index]
| Jump to: | (
A E F H L M S |
|---|
| Jump to: | (
A E F H L M S |
|---|
Next: variable index, Previous: concept index, Up: Top [Contents][Index]
| Jump to: | C L M P S V |
|---|
| Jump to: | C L M P S V |
|---|
Next: type index, Previous: function index, Up: Top [Contents][Index]
Previous: variable index, Up: Top [Contents][Index]
| Jump to: | C |
|---|
| Jump to: | C |
|---|