class ECURL_EASY_INPUT_STREAM
Summary
Direct parents
Inherit list: ECURL_INPUT_STREAM
Class invariant
Overview
Creation features
Features
{ANY}
{ECURL_EASY_HANDLE}
{}
{ANY}
Options
{ANY}
{FILTER_INPUT_STREAM}
{}
{ANY}
{ANY}
Common options
{ANY}
{FILTER}
{ECURL_HANDLE}
{ANY}
{}
{STREAM_HANDLER}
{ANY}
{}
{RECYCLING_POOL}
  • recycle
    Do whatever needs to be done to free resources or recycle other objects when recycling this one
{}
  • dispose
    Action to be executed just before garbage collection reclaims an object.
{}
"easy" API
{}
"multi" API
{}
EcUrl specific functions
{}
Constants (extracted from curl.h, version 7.39.0; removed deprecated and synonyms
{}
{}
{ANY}
{ANY}
{FILTER_INPUT_STREAM}
{FILTER}
{ANY}
{}
{ANY}
Skipping separators:
{ANY}
To read one number at a time:
{ANY}
To read one line or one word at a time:
{ANY}
Other features:
{ANY}
{}
{FILTER}
can_perform: BOOLEAN
effective function
{ANY}
perform
effective procedure
{ANY}
Perform the action; after that, options cannot be changed and the object can be used as a stream on_error is called with the cUrl error code (defined in ECURL_ERRORS) if the action failed to perform.
require
  • can_perform
disconnect
effective procedure
{ANY}
Try to disconnect the stream.
Note that it *does not* ensure that the stream will effectively be disconnected (some terminal streams, for instance, are always connected) but the feature can be used to "shake off" filters.
require
    • is_connected
    • can_disconnect
      • is_connected
      • can_disconnect
      • is_connected
      • can_disconnect
ensure
  • not is_filtered
multi_perform_done (error_code: INTEGER_32)
effective procedure
writable attribute
{}
done (err: INTEGER_32)
effective procedure
{}
can_read_character: BOOLEAN
is True
constant attribute
{ANY}
Note that this state is usually temporary.
Usually it is called until either it becomes True or the stream is disconnected:
 from
 until
    stream.can_read_character or else not stream.is_connected
 loop
    -- some "still waiting..." code, maybe a sandglass?
 end
 if stream.is_connected then
    stream.read_character
 end
See also: is_connected, end_of_input
require
  • is_connected
ensure
  • Result implies not end_of_input
can_read_line: BOOLEAN
is True
constant attribute
{ANY}
require
  • is_connected
can_unread_character: BOOLEAN
effective function
{ANY}
require
  • is_connected
  • valid_last_character
valid_last_character: BOOLEAN
effective function
{ANY}
require
  • is_connected
end_of_input: BOOLEAN
effective function
{ANY}
end_of_input means the previous attempt in character reading failed because the end has been reached.
So last_character is not valid and you are not allowed to do any read attempt anymore.
Notes:
  • Just after a successful connect, end_of_input is always False because you did not yet read anything).
  • Once the end of input has been reached, this is definitive in that no more characters will ever be provided (but of course you can still come back if can_unread_character; end_of_input will be changed if you unread_character). In that, it is different from can_read_character which is only a temporary state.
Please refer to the Liberty Eiffel FAQ or tutorial/io examples.
set_follow_location (enable: BOOLEAN)
effective procedure
{ANY}
filtered_read_character
effective procedure
require
  • is_connected
  • can_read_character
filtered_unread_character
effective procedure
require
  • is_connected
  • can_unread_character
filtered_last_character: CHARACTER
effective function
require
  • is_connected
  • valid_last_character
init_connect
effective procedure
{}
require
  • handle /= Void
ecurl_callback (buffer: POINTER, size: INTEGER_32)
effective procedure
{}
require
ecurl_buffer: STRING
writable attribute
{}
index: INTEGER_32
writable attribute
{}
state: INTEGER_8
writable attribute
{}
State_init: INTEGER_8
is 0
constant attribute
{}
State_performing: INTEGER_8
is 1
constant attribute
{}
State_ready: INTEGER_8
is 2
constant attribute
{}
is_performing: BOOLEAN
effective function
{}
is_ready: BOOLEAN
effective function
{}
is_connected: BOOLEAN
effective function
{ANY}
True if the stream is connected.
Only in that case can data be transferred via this stream.
can_disconnect: BOOLEAN
is True
constant attribute
{ANY}
True if the stream can be safely disconnected (without data loss, etc.)
require
  • is_connected
writable attribute
{ANY}
set_on_error (a_on_error: PROCEDURE[TUPLE 2[INTEGER_32, ECURL_HANDLE]]) assign on_error
effective procedure
{ANY}
ensure
set_url (a_url: URL)
effective procedure
{ANY}
require
set_url_string (a_url: ABSTRACT_STRING)
effective procedure
{ANY}
require
set_verbose (a_verbose: BOOLEAN)
effective procedure
{ANY}
set ECURLOPT_VERBOSE
require
set_header (a_header: BOOLEAN)
effective procedure
{ANY}
set ECURLOPT_HEADER
require
filtered_descriptor: INTEGER_32
effective function
Find the descriptor of the terminal stream...
Filters do not have descriptors of their own
require
  • is_connected
  • filtered_has_descriptor
filtered_has_descriptor: BOOLEAN
is False
constant attribute
True if the underlying terminal stream has a descriptor
require
  • is_connected
filtered_stream_pointer: POINTER
effective function
Find the pointer of the terminal stream...
Filters do not have pointers of their own
require
  • is_connected
  • filtered_has_stream_pointer
filtered_has_stream_pointer: BOOLEAN
is False
constant attribute
True if the underlying terminal stream has a pointer
require
  • is_connected
is_connected_to (a_handle: ECURL_HANDLE): BOOLEAN
effective function
ensure
connect_to (a_handle: ECURL_HANDLE)
effective procedure
require
descriptor: INTEGER_32
effective function
{ANY}
Some OS-dependent descriptor.
Mainly used by the sequencer library (see READY_CONDITION).
require
has_descriptor: BOOLEAN
effective function
{ANY}
True if that stream can be associated to some OS-meaningful descriptor.
require
url: URL
frozen
effective function
{ANY}
The URL to this stream as resource
ensure
  • not_void: Result /= Void
  • always_the_same: Result = url
url_memory: URL
writable attribute
{}
new_url: URL
deferred function
{}
ensure
  • Result /= Void
stream_pointer: POINTER
effective function
Some Back-end-dependent pointer (FILE* in C, InputStream or OutputStream in Java)
has_stream_pointer: BOOLEAN
effective function
True if that stream can be associated to some Back-end-meaningful stream pointer.
require
event_exception: EVENT_DESCRIPTOR
effective function
{ANY}
stream_exception: STREAM_EXCEPTION
writable attribute
{}
recycle
effective procedure
Do whatever needs to be done to free resources or recycle other objects when recycling this one
dispose
effective procedure
{}
Action to be executed just before garbage collection reclaims an object.
sequencer_descriptor (file: POINTER): INTEGER_32
{}
curl_easy_init: POINTER
{}
curl_easy_setopt_string (handle: POINTER, option: INTEGER_32, parameter: STRING)
effective procedure
{}
curl_easy_setopt_boolean (handle: POINTER, option: INTEGER_32, parameter: BOOLEAN)
effective procedure
{}
curl_easy_setopt_pointer (handle: POINTER, option: INTEGER_32, parameter: POINTER)
{}
curl_easy_setopt_integer (handle: POINTER, option: INTEGER_32, parameter: INTEGER_64)
{}
curl_easy_reset (handle: POINTER)
{}
curl_easy_duphandle (handle: POINTER)
{}
curl_easy_perform (handle: POINTER): INTEGER_32
{}
curl_easy_cleanup (handle: POINTER)
{}
curl_easy_strerror (errornum: INTEGER_32): POINTER
{}
curl_multi_init: POINTER
{}
curl_multi_cleanup (handle: POINTER)
{}
curl_multi_perform (handle: POINTER, running_handles: POINTER): INTEGER_32
{}
curl_multi_fdset (handle: POINTER, rset: POINTER, wset: POINTER, eset: POINTER, fdmax: POINTER)
{}
curl_multi_info_read (handle: POINTER, nbmsg: POINTER): POINTER
{}
ecurl_init_write_function (handle: POINTER, object: POINTER)
{}
ecurl_init_read_function (handle: POINTER, object: POINTER)
{}
ecurl_multi_info_easy_handle (info: POINTER): POINTER
{}
ecurl_multi_info_easy_code (info: POINTER): INTEGER_32
{}
ecurl_multi_info_easy_done (info: POINTER): BOOLEAN
{}
Curlopt_writedata: INTEGER_32
{}
 /* This is the FILE * or void * the regular output should be written to.
  • /
Curlopt_url: INTEGER_32
{}
 /* The full URL to get/put */
Curlopt_port: INTEGER_32
{}
 /* Port number to connect to, if other than default.
  • /
Curlopt_proxy: INTEGER_32
{}
 /* Name of proxy to use.
  • /
Curlopt_userpwd: INTEGER_32
{}
 /* "user:password;options" to use when fetching.
  • /
Curlopt_proxyuserpwd: INTEGER_32
{}
 /* "user:password" to use with proxy.
  • /
Curlopt_range: INTEGER_32
{}
 /* Range to get, specified as an ASCII string.
  • /
Curlopt_readdata: INTEGER_32
{}
 /* Specified file stream to upload from (use as input): */
Curlopt_errorbuffer: INTEGER_32
{}
 /* Buffer to receive error messages in, must be at least ECURL_ERROR_SIZE
  * bytes big.
If this is not used, error messages go to stderr instead: */
Curlopt_writefunction: INTEGER_32
{}
 /* Function that will be called to store the output (instead of fwrite).
The
  * parameters will use fwrite() syntax, make sure to follow them. */
Curlopt_readfunction: INTEGER_32
{}
 /* Function that will be called to read the input (instead of fread).
The
  * parameters will use fread() syntax, make sure to follow them. */
Curlopt_timeout: INTEGER_32
{}
 /* Time-out the read operation after this amount of seconds */
Curlopt_infilesize: INTEGER_32
{}
 /* If the curlopt_infile is used, this can be used to inform libcurl about
  * how large the file being sent really is.
that allows better error
  * checking and better verifies that the upload was successful. -1 means
  * unknown size.
  *
  * for large file support, there is also a _large version of the key
  * which takes an off_t type, allowing platforms with larger off_t
  * sizes to handle larger files.  see below for infilesize_large.
  */
Curlopt_postfields: INTEGER_32
{}
 /* POST static input fields.
  • /
Curlopt_referer: INTEGER_32
{}
 /* Set the referrer page (needed by some CGIs) */
Curlopt_ftpport: INTEGER_32
{}
 /* Set the FTP PORT string (interface name, named or numerical IP address)
    Use i.e '-' to use default address.
  • /
Curlopt_useragent: INTEGER_32
{}
 /* Set the User-Agent string (examined by some CGIs) */
Curlopt_low_speed_limit: INTEGER_32
{}
 /* If the download receives less than "low speed limit" bytes/second
  * during "low speed time" seconds, the operations is aborted.
  * You could i.e if you have a pretty high speed connection, abort if
  * it is less than 2000 bytes/sec during 20 seconds.
  */
 /* Set the "low speed limit" */
Curlopt_low_speed_time: INTEGER_32
{}
 /* Set the "low speed time" */
Curlopt_resume_from: INTEGER_32
{}
 /* Set the continuation offset.
  *
  * Note there is also a _LARGE version of this key which uses
  * off_t types, allowing for large file offsets on platforms which
  * use larger-than-32-bit off_t's.  Look below for RESUME_FROM_LARGE.
  */
Curlopt_cookie: INTEGER_32
{}
 /* Set cookie in request: */
Curlopt_httpheader: INTEGER_32
{}
 /* This points to a linked list of headers, struct curl_slist kind.
This
    list is also used for RTSP (in spite of its name) */
Curlopt_httppost: INTEGER_32
{}
 /* This points to a linked list of post entries, struct curl_httppost */
Curlopt_sslcert: INTEGER_32
{}
 /* name of the file keeping your private SSL-certificate */
Curlopt_keypasswd: INTEGER_32
{}
 /* password for the SSL or SSH private key */
Curlopt_crlf: INTEGER_32
{}
 /* send TYPE parameter?
  • /
Curlopt_quote: INTEGER_32
{}
 /* send linked-list of QUOTE commands */
Curlopt_headerdata: INTEGER_32
{}
 /* send FILE * or void * to store headers to, if you use a callback it
    is simply passed to the callback unmodified */
Curlopt_cookiefile: INTEGER_32
{}
 /* point to a file to read the initial cookies from, also enables
    "cookie awareness" */
Curlopt_sslversion: INTEGER_32
{}
 /* What version to specifically try to use.
    See ECURL_SSLVERSION defines below. */
Curlopt_timecondition: INTEGER_32
{}
 /* What kind of HTTP time condition to use, see defines */
Curlopt_timevalue: INTEGER_32
{}
 /* Time to use with the above condition.
Specified in number of seconds
    since 1 Jan 1970 */
Curlopt_customrequest: INTEGER_32
{}
 /* Custom request, for customizing the get command like
    HTTP: DELETE, TRACE and others
    FTP: to use a different list command
    */
Curlopt_stderr: INTEGER_32
{}
 /* HTTP request, for odd commands like DELETE, TRACE and others */
Curlopt_postquote: INTEGER_32
{}
 /* send linked-list of post-transfer QUOTE commands */
Curlopt_obsolete40: INTEGER_32
{}
Curlopt_verbose: INTEGER_32
{}
Curlopt_header: INTEGER_32
{}
Curlopt_noprogress: INTEGER_32
{}
Curlopt_nobody: INTEGER_32
{}
Curlopt_failonerror: INTEGER_32
{}
Curlopt_upload: INTEGER_32
{}
Curlopt_post: INTEGER_32
{}
Curlopt_dirlistonly: INTEGER_32
{}
Curlopt_append: INTEGER_32
{}
Curlopt_netrc: INTEGER_32
{}
 /* Specify whether to read the user+password from the .netrc or the URL.
  * This must be one of the ECURL_NETRC_* enums below. */
Curlopt_followlocation: INTEGER_32
{}
Curlopt_transfertext: INTEGER_32
{}
Curlopt_put: INTEGER_32
{}
Curlopt_progressfunction: INTEGER_32
{}
 /* DEPRECATED
  * Function that will be called instead of the internal progress display
  * function.
This function should be defined as the curl_progress_callback
  * prototype defines. */
Curlopt_progressdata: INTEGER_32
{}
 /* Data passed to the curlopt_progressfunction and curlopt_xferinfofunction
    callbacks */
Curlopt_autoreferer: INTEGER_32
{}
 /* We want the referrer field set automatically when following locations */
Curlopt_proxyport: INTEGER_32
{}
 /* Port of the proxy, can be set in the proxy string as well with:
    "[host]:[port]" */
Curlopt_postfieldsize: INTEGER_32
{}
 /* size of the POST input data, if strlen() is not good to use */
Curlopt_httpproxytunnel: INTEGER_32
{}
 /* tunnel non-http operations through a HTTP proxy */
Curlopt_interface: INTEGER_32
{}
 /* Set the interface string to use as outgoing network interface */
Curlopt_krblevel: INTEGER_32
{}
 /* Set the krb4/5 security level, this also enables krb4/5 awareness.
 This
  * is a string, 'clear', 'safe', 'confidential' or 'private'.  If the string
  * is set but doesn't match one of these, 'private' will be used.  */
Curlopt_ssl_verifypeer: INTEGER_32
{}
 /* Set if we should verify the peer in ssl handshake, set 1 to verify.
  • /
Curlopt_cainfo: INTEGER_32
{}
 /* The CApath or CAfile used to validate the peer certificate
    this option is used only if SSL_VERIFYPEER is true */
Curlopt_maxredirs: INTEGER_32
{}
 /* Maximum number of http redirects to follow */
Curlopt_filetime: INTEGER_32
{}
 /* Pass a long set to 1 to get the date of the requested document (if
    possible)!
Pass a zero to shut it off. */
Curlopt_telnetoptions: INTEGER_32
{}
 /* This points to a linked list of telnet options */
Curlopt_maxconnects: INTEGER_32
{}
 /* Max amount of cached alive connections */
Curlopt_fresh_connect: INTEGER_32
{}
 /* Set to explicitly use a new connection for the upcoming transfer.
    Do not use this unless you're absolutely sure of this, as it makes the
    operation slower and is less friendly for the network. */
Curlopt_forbid_reuse: INTEGER_32
{}
 /* Set to explicitly forbid the upcoming transfer's connection to be re-used
    when done.
Do not use this unless you're absolutely sure of this, as it
    makes the operation slower and is less friendly for the network. */
Curlopt_random_file: INTEGER_32
{}
 /* Set to a file name that contains random data for libcurl to use to
    seed the random engine when doing SSL connects.
  • /
Curlopt_egdsocket: INTEGER_32
{}
 /* Set to the Entropy Gathering Daemon socket pathname */
Curlopt_connecttimeout: INTEGER_32
{}
 /* Time-out connect operations after this amount of seconds, if connects are
    OK within this time, then fine...
This only aborts the connect phase. */
Curlopt_headerfunction: INTEGER_32
{}
 /* Function that will be called to store headers (instead of fwrite).
The
  * parameters will use fwrite() syntax, make sure to follow them. */
Curlopt_httpget: INTEGER_32
{}
 /* Set this to force the HTTP request to get back to GET.
Only really usable
    if POST, PUT or a custom request have been used first.
  */
Curlopt_ssl_verifyhost: INTEGER_32
{}
 /* Set if we should verify the Common name from the peer certificate in ssl
  * handshake, set 1 to check existence, 2 to ensure that it matches the
  * provided hostname.
  • /
Curlopt_cookiejar: INTEGER_32
{}
 /* Specify which file name to write all known cookies in after completed
    operation.
Set file name to "-" (dash) to make it go to stdout. */
Curlopt_ssl_cipher_list: INTEGER_32
{}
 /* Specify which SSL ciphers to use */
Curlopt_http_version: INTEGER_32
{}
 /* Specify which HTTP version to use!
This must be set to one of the
    ECURL_HTTP_VERSION* enums set below. */
Curlopt_ftp_use_epsv: INTEGER_32
{}
 /* Specifically switch on or off the FTP engine's use of the EPSV command.
By
    default, that one will always be attempted before the more traditional
    PASV command. */
Curlopt_sslcerttype: INTEGER_32
{}
 /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */
Curlopt_sslkey: INTEGER_32
{}
 /* name of the file keeping your private SSL-key */
Curlopt_sslkeytype: INTEGER_32
{}
 /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */
Curlopt_sslengine: INTEGER_32
{}
 /* crypto engine for the SSL-sub system */
Curlopt_sslengine_default: INTEGER_32
{}
 /* set the crypto engine for the SSL-sub system as default
    the param has no meaning...
  */
Curlopt_dns_use_global_cache: INTEGER_32
{}
 /* Non-zero value means to use the global dns cache */
Curlopt_dns_cache_timeout: INTEGER_32
{}
 /* DNS cache timeout */
Curlopt_prequote: INTEGER_32
{}
 /* send linked-list of pre-transfer QUOTE commands */
Curlopt_debugfunction: INTEGER_32
{}
 /* set the debug function */
Curlopt_debugdata: INTEGER_32
{}
 /* set the data for the debug function */
Curlopt_cookiesession: INTEGER_32
{}
 /* mark this as start of a cookie session */
Curlopt_capath: INTEGER_32
{}
 /* The CApath directory used to validate the peer certificate
    this option is used only if SSL_VERIFYPEER is true */
Curlopt_buffersize: INTEGER_32
{}
 /* Instruct libcurl to use a smaller receive buffer */
Curlopt_nosignal: INTEGER_32
{}
 /* Instruct libcurl to not use any signal/alarm handlers, even when using
    timeouts.
This option is useful for multi-threaded applications.
    See libcurl-the-guide for more background information. */
Curlopt_share: INTEGER_32
{}
 /* Provide a ECURLShare for mutexing non-ts data */
Curlopt_proxytype: INTEGER_32
{}
 /* indicates type of proxy.
accepted values are ECURLPROXY_HTTP (default),
    ECURLPROXY_SOCKS4, ECURLPROXY_SOCKS4A and ECURLPROXY_SOCKS5. */
Curlopt_accept_encoding: INTEGER_32
{}
 /* Set the Accept-Encoding string.
Use this to tell a server you would like
    the response to be compressed. Before 7.21.6, this was known as
    curlopt_encoding */
Curlopt_private: INTEGER_32
{}
 /* Set pointer to private data */
Curlopt_http200aliases: INTEGER_32
{}
 /* Set aliases for HTTP 200 in the HTTP Response header */
Curlopt_unrestricted_auth: INTEGER_32
{}
 /* Continue to send authentication (user+password) when following locations,
    even when hostname changed.
This can potentially send off the name
    and password to whatever host the server decides. */
Curlopt_ftp_use_eprt: INTEGER_32
{}
 /* Specifically switch on or off the FTP engine's use of the EPRT command (
    it also disables the LPRT attempt).
By default, those ones will always be
    attempted before the good old traditional PORT command. */
Curlopt_httpauth: INTEGER_32
{}
 /* Set this to a bitmask value to enable the particular authentications
    methods you like.
Use this in combination with curlopt_userpwd.
    note that setting multiple bits may cause extra network round-trips. */
Curlopt_ssl_ctx_function: INTEGER_32
{}
 /* Set the ssl context callback function, currently only for OpenSSL ssl_ctx
    in second argument.
The function must be matching the
    curl_ssl_ctx_callback proto. */
Curlopt_ssl_ctx_data: INTEGER_32
{}
 /* Set the userdata for the ssl context callback function's third
    argument */
Curlopt_ftp_create_missing_dirs: INTEGER_32
{}
 /* FTP Option that causes missing dirs to be created on the remote server.
    In 7.19.4 we introduced the convenience enums for this option using the
    ECURLFTP_CREATE_DIR prefix.
 */
Curlopt_proxyauth: INTEGER_32
{}
 /* Set this to a bitmask value to enable the particular authentications
    methods you like.
Use this in combination with curlopt_proxyuserpwd.
    note that setting multiple bits may cause extra network round-trips. */
Curlopt_ftp_response_timeout: INTEGER_32
{}
 /* FTP option that changes the timeout, in seconds, associated with
    getting a response.
 This is different from transfer timeout time and
    essentially places a demand on the FTP server to acknowledge commands
    in a timely manner. */
Curlopt_ipresolve: INTEGER_32
{}
 /* Set this option to one of the ECURL_IPRESOLVE_* defines (see below) to
    tell libcurl to resolve names to those IP versions only.
This only has
    affect on systems with support for more than one, i.e IPv4 _and_ IPv6. */
Curlopt_maxfilesize: INTEGER_32
{}
  /* Set this option to limit the size of a file that will be downloaded from
        an HTTP or FTP server.
    Note there is also _LARGE version which adds large file support for
    platforms which have larger off_t sizes.  See MAXFILESIZE_LARGE below. */
Curlopt_infilesize_large: INTEGER_32
{}
 /* See the comment for INFILESIZE above, but in short, specifies
  * the size of the file being uploaded.
 -1 means unknown.
  */
Curlopt_resume_from_large: INTEGER_32
{}
 /* Sets the continuation offset.
 There is also a LONG version of this;
  * look above for RESUME_FROM.
  */
Curlopt_maxfilesize_large: INTEGER_32
{}
 /* Sets the maximum size of data that will be downloaded from
  * an HTTP or FTP server.
 See MAXFILESIZE above for the LONG version.
  */
Curlopt_netrc_file: INTEGER_32
{}
 /* Set this option to the file name of your .netrc file you want libcurl
    to parse (using the curlopt_netrc option).
if not set, libcurl will do
    a poor attempt to find the user's home directory and check for a .netrc
    file in there. */
Curlopt_use_ssl: INTEGER_32
{}
 /* Enable SSL/TLS for FTP, pick one of:
    ECURLUSESSL_TRY     - try using SSL, proceed anyway otherwise
    ECURLUSESSL_CONTROL - SSL for the control connection or fail
    ECURLUSESSL_ALL     - SSL for all communication or fail
 */
Curlopt_postfieldsize_large: INTEGER_32
{}
 /* The _LARGE version of the standard POSTFIELDSIZE option */
Curlopt_tcp_nodelay: INTEGER_32
{}
 /* Enable/disable the TCP Nagle algorithm */
Curlopt_ftpsslauth: INTEGER_32
{}
 /* When FTP over SSL/TLS is selected (with curlopt_use_ssl), this option
    can be used to change libcurl's default action which is to first try
    "auth ssl" and then "auth tls" in this order, and proceed when a ok
    response has been received.
    available parameters are:
    ECURLFTPAUTH_DEFAULT - let libcurl decide
    ECURLFTPAUTH_SSL     - try "AUTH SSL" first, then TLS
    ECURLFTPAUTH_TLS     - try "AUTH TLS" first, then SSL
 */
Curlopt_ioctlfunction: INTEGER_32
{}
Curlopt_ioctldata: INTEGER_32
{}
Curlopt_ftp_account: INTEGER_32
{}
 /* zero terminated string for pass on to the FTP server when asked for
    "account" info */
Curlopt_cookielist: INTEGER_32
{}
 /* feed cookies into cookie engine */
Curlopt_ignore_content_length: INTEGER_32
{}
 /* ignore Content-Length */
Curlopt_ftp_skip_pasv_ip: INTEGER_32
{}
 /* Set to non-zero to skip the IP address received in a 227 PASV FTP server
    response.
Typically used for FTP-SSL purposes but is not restricted to
    that. libcurl will then instead use the same IP address it used for the
    control connection. */
Curlopt_ftp_filemethod: INTEGER_32
{}
 /* Select "file method" to use when doing FTP, see the curl_ftpmethod
    above.
  • /
Curlopt_localport: INTEGER_32
{}
 /* Local port number to bind the socket to */
Curlopt_localportrange: INTEGER_32
{}
 /* Number of ports to try, including the first one set with LOCALPORT.
    Thus, setting it to 1 will make no additional attempts but the first.
 */
Curlopt_connect_only: INTEGER_32
{}
 /* no transfer, set up connection and let application use the socket by
    extracting it with ECURLINFO_LASTSOCKET */
Curlopt_conv_from_network_function: INTEGER_32
{}
 /* Function that will be called to convert from the
    network encoding (instead of using the iconv calls in libcurl) */
Curlopt_conv_to_network_function: INTEGER_32
{}
 /* Function that will be called to convert to the
    network encoding (instead of using the iconv calls in libcurl) */
Curlopt_conv_from_utf8_function: INTEGER_32
{}
 /* Function that will be called to convert from UTF8
    (instead of using the iconv calls in libcurl)
    Note that this is used only for SSL certificate processing */
Curlopt_max_send_speed_large: INTEGER_32
{}
 /* if the connection proceeds too quickly then need to slow it down */
 /* limit-rate: maximum number of bytes per second to send or receive */
Curlopt_max_recv_speed_large: INTEGER_32
{}
Curlopt_ftp_alternative_to_user: INTEGER_32
{}
 /* Pointer to command string to send if USER/PASS fails.
  • /
Curlopt_sockoptfunction: INTEGER_32
{}
 /* callback function for setting socket options */
Curlopt_sockoptdata: INTEGER_32
{}
Curlopt_ssl_sessionid_cache: INTEGER_32
{}
 /* set to 0 to disable session ID re-use for this transfer, default is
    enabled (== 1) */
Curlopt_ssh_auth_types: INTEGER_32
{}
 /* allowed SSH authentication methods */
Curlopt_ssh_public_keyfile: INTEGER_32
{}
 /* Used by scp/sftp to do public/private key authentication */
Curlopt_ssh_private_keyfile: INTEGER_32
{}
Curlopt_ftp_ssl_ccc: INTEGER_32
{}
 /* Send CCC (Clear Command Channel) after authentication */
Curlopt_timeout_ms: INTEGER_32
{}
 /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */
Curlopt_connecttimeout_ms: INTEGER_32
{}
Curlopt_http_transfer_decoding: INTEGER_32
{}
 /* set to zero to disable the libcurl's decoding and thus pass the raw body
    data to the application even when it is encoded/compressed */
Curlopt_http_content_decoding: INTEGER_32
{}
Curlopt_new_file_perms: INTEGER_32
{}
 /* Permission used when creating new files and directories on the remote
    server for protocols that support it, SFTP/SCP/FILE */
Curlopt_new_directory_perms: INTEGER_32
{}
Curlopt_postredir: INTEGER_32
{}
 /* Set the behaviour of POST when redirecting.
Values must be set to one
    of ECURL_REDIR* defines below. This used to be called curlopt_post301 */
Curlopt_ssh_host_public_key_md5: INTEGER_32
{}
 /* used by scp/sftp to verify the host's public key */
Curlopt_opensocketfunction: INTEGER_32
{}
 /* Callback function for opening socket (instead of socket(2)).
Optionally,
    callback is able change the address or refuse to connect returning
    ECURL_SOCKET_BAD.  The callback should have type
    curl_opensocket_callback */
Curlopt_opensocketdata: INTEGER_32
{}
Curlopt_copypostfields: INTEGER_32
{}
 /* POST volatile input fields.
  • /
Curlopt_proxy_transfer_mode: INTEGER_32
{}
 /* set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy */
Curlopt_seekfunction: INTEGER_32
{}
 /* Callback function for seeking in the input stream */
Curlopt_seekdata: INTEGER_32
{}
Curlopt_crlfile: INTEGER_32
{}
 /* CRL file */
Curlopt_issuercert: INTEGER_32
{}
 /* Issuer certificate */
Curlopt_address_scope: INTEGER_32
{}
 /* (IPv6) Address scope */
Curlopt_certinfo: INTEGER_32
{}
 /* Collect certificate chain info and allow it to get retrievable with
    ECURLINFO_CERTINFO after the transfer is complete.
  • /
Curlopt_username: INTEGER_32
{}
 /* "name" and "pwd" to use when fetching.
  • /
Curlopt_password: INTEGER_32
{}
Curlopt_proxyusername: INTEGER_32
{}
   /* "name" and "pwd" to use with Proxy when fetching.
  • /
Curlopt_proxypassword: INTEGER_32
{}
Curlopt_noproxy: INTEGER_32
{}
 /* Comma separated list of hostnames defining no-proxy zones.
These should
    match both hostnames directly, and hostnames within a domain. For
    example, local.com will match local.com and www.local.com, but NOT
    notlocal.com or www.notlocal.com. For compatibility with other
    implementations of this, .local.com will be considered to be the same as
    local.com. A single * is the only valid wildcard, and effectively
    disables the use of proxy. */
Curlopt_tftp_blksize: INTEGER_32
{}
 /* block size for TFTP transfers */
Curlopt_socks5_gssapi_service: INTEGER_32
{}
 /* Socks Service */
Curlopt_socks5_gssapi_nec: INTEGER_32
{}
 /* Socks Service */
Curlopt_protocols: INTEGER_32
{}
 /* set the bitmask for the protocols that are allowed to be used for the
    transfer, which thus helps the app which takes URLs from users or other
    external inputs and want to restrict what protocol(s) to deal
    with.
Defaults to ECURLPROTO_ALL. */
Curlopt_redir_protocols: INTEGER_32
{}
 /* set the bitmask for the protocols that libcurl is allowed to follow to,
    as a subset of the curlopt_protocols ones.
that means the protocol needs
    to be set in both bitmasks to be allowed to get redirected to. defaults
    to all protocols except file and scp. */
Curlopt_ssh_knownhosts: INTEGER_32
{}
 /* set the SSH knownhost file name to use */
Curlopt_ssh_keyfunction: INTEGER_32
{}
 /* set the SSH host key callback, must point to a curl_sshkeycallback
    function */
Curlopt_ssh_keydata: INTEGER_32
{}
 /* set the SSH host key callback custom pointer */
Curlopt_mail_from: INTEGER_32
{}
 /* set the SMTP mail originator */
Curlopt_mail_rcpt: INTEGER_32
{}
 /* set the SMTP mail receiver(s) */
Curlopt_ftp_use_pret: INTEGER_32
{}
 /* FTP: send PRET before PASV */
Curlopt_rtsp_request: INTEGER_32
{}
 /* RTSP request method (OPTIONS, SETUP, PLAY, etc...)
  • /
Curlopt_rtsp_session_id: INTEGER_32
{}
 /* The RTSP session identifier */
Curlopt_rtsp_stream_uri: INTEGER_32
{}
 /* The RTSP stream URI */
Curlopt_rtsp_transport: INTEGER_32
{}
 /* The Transport: header to use in RTSP requests */
Curlopt_rtsp_client_cseq: INTEGER_32
{}
 /* Manually initialize the client RTSP CSeq for this handle */
Curlopt_rtsp_server_cseq: INTEGER_32
{}
 /* Manually initialize the server RTSP CSeq for this handle */
Curlopt_interleavedata: INTEGER_32
{}
 /* The stream to pass to INTERLEAVEFUNCTION.
  • /
Curlopt_interleavefunction: INTEGER_32
{}
 /* Let the application define a custom write method for RTP data */
Curlopt_wildcardmatch: INTEGER_32
{}
 /* Turn on wildcard matching */
Curlopt_chunk_bgn_function: INTEGER_32
{}
 /* Directory matching callback called before downloading of an
    individual file (chunk) started */
Curlopt_chunk_end_function: INTEGER_32
{}
 /* Directory matching callback called after the file (chunk)
    was downloaded, or skipped */
Curlopt_fnmatch_function: INTEGER_32
{}
 /* Change match (fnmatch-like) callback for wildcard matching */
Curlopt_chunk_data: INTEGER_32
{}
 /* Let the application define custom chunk data pointer */
Curlopt_fnmatch_data: INTEGER_32
{}
 /* FNMATCH_FUNCTION user pointer */
Curlopt_resolve: INTEGER_32
{}
 /* send linked-list of name:port:address sets */
Curlopt_tlsauth_username: INTEGER_32
{}
 /* Set a username for authenticated TLS */
Curlopt_tlsauth_password: INTEGER_32
{}
 /* Set a password for authenticated TLS */
Curlopt_tlsauth_type: INTEGER_32
{}
 /* Set authentication type for authenticated TLS */
Curlopt_transfer_encoding: INTEGER_32
{}
 /* Set to 1 to enable the "TE:" header in HTTP requests to ask for
    compressed transfer-encoded responses.
Set to 0 to disable the use of TE:
    in outgoing requests. The current default is 0, but it might change in a
    future libcurl release.

    libcurl will ask for the compressed methods it knows of, and if that
    isn't any, it will not ask for transfer-encoding at all even if this
    option is set to 1.

 */
Curlopt_closesocketfunction: INTEGER_32
{}
 /* Callback function for closing socket (instead of close(2)).
The callback
    should have type curl_closesocket_callback */
Curlopt_closesocketdata: INTEGER_32
{}
Curlopt_gssapi_delegation: INTEGER_32
{}
 /* allow GSSAPI credential delegation */
Curlopt_dns_servers: INTEGER_32
{}
 /* Set the name servers to use for DNS resolution */
Curlopt_accepttimeout_ms: INTEGER_32
{}
 /* Time-out accept operations (currently for FTP only) after this amount
    of miliseconds.
  • /
Curlopt_tcp_keepalive: INTEGER_32
{}
 /* Set TCP keepalive */
Curlopt_tcp_keepidle: INTEGER_32
{}
 /* non-universal keepalive knobs (Linux, AIX, HP-UX, more) */
Curlopt_tcp_keepintvl: INTEGER_32
{}
Curlopt_ssl_options: INTEGER_32
{}
 /* Enable/disable specific SSL features with a bitmask, see ECURLSSLOPT_* */
Curlopt_mail_auth: INTEGER_32
{}
 /* Set the SMTP auth originator */
Curlopt_sasl_ir: INTEGER_32
{}
 /* Enable/disable SASL initial response */
Curlopt_xferinfofunction: INTEGER_32
{}
 /* Function that will be called instead of the internal progress display
  * function.
This function should be defined as the curl_xferinfo_callback
  * prototype defines. (Deprecates curlopt_progressfunction) */
Curlopt_xoauth2_bearer: INTEGER_32
{}
 /* The XOAUTH2 bearer token */
Curlopt_dns_interface: INTEGER_32
{}
 /* Set the interface string to use as outgoing network
  * interface for DNS requests.
  * Only supported by the c-ares DNS backend */
Curlopt_dns_local_ip4: INTEGER_32
{}
 /* Set the local IPv4 address to use for outgoing DNS requests.
  * Only supported by the c-ares DNS backend */
Curlopt_dns_local_ip6: INTEGER_32
{}
 /* Set the local IPv4 address to use for outgoing DNS requests.
  * Only supported by the c-ares DNS backend */
Curlopt_login_options: INTEGER_32
{}
 /* Set authentication options directly */
Curlopt_ssl_enable_npn: INTEGER_32
{}
 /* Enable/disable TLS NPN extension (http2 over ssl might fail without) */
Curlopt_ssl_enable_alpn: INTEGER_32
{}
 /* Enable/disable TLS ALPN extension (http2 over ssl might fail without) */
Curlopt_expect_100_timeout_ms: INTEGER_32
{}
 /* Time to wait for a response to a HTTP request containing an
  * Expect: 100-continue header before sending the data anyway.
  • /
Curlopt_proxyheader: INTEGER_32
{}
 /* This points to a linked list of headers used for proxy requests only,
    struct curl_slist kind */
Curlopt_headeropt: INTEGER_32
{}
 /* Pass in a bitmask of "header options" */
Curlopt_pinnedpublickey: INTEGER_32
{}
 /* The public key in DER form used to validate the peer public key
    this option is used only if SSL_VERIFYPEER is true */
Curle_ok: INTEGER_32
{}
Curle_unsupported_protocol: INTEGER_32
{}
Curle_failed_init: INTEGER_32
{}
Curle_url_malformat: INTEGER_32
{}
Curle_not_built_in: INTEGER_32
{}
Curle_couldnt_resolve_proxy: INTEGER_32
{}
Curle_couldnt_resolve_host: INTEGER_32
{}
Curle_couldnt_connect: INTEGER_32
{}
Curle_ftp_weird_server_reply: INTEGER_32
{}
Curle_remote_access_denied: INTEGER_32
{}
Curle_ftp_accept_failed: INTEGER_32
{}
Curle_ftp_weird_pass_reply: INTEGER_32
{}
Curle_ftp_accept_timeout: INTEGER_32
{}
Curle_ftp_weird_pasv_reply: INTEGER_32
{}
Curle_ftp_weird_227_format: INTEGER_32
{}
Curle_ftp_cant_get_host: INTEGER_32
{}
Curle_http2: INTEGER_32
{}
Curle_ftp_couldnt_set_type: INTEGER_32
{}
Curle_partial_file: INTEGER_32
{}
Curle_ftp_couldnt_retr_file: INTEGER_32
{}
Curle_obsolete20: INTEGER_32
{}
Curle_quote_error: INTEGER_32
{}
Curle_http_returned_error: INTEGER_32
{}
Curle_write_error: INTEGER_32
{}
Curle_obsolete24: INTEGER_32
{}
Curle_upload_failed: INTEGER_32
{}
Curle_read_error: INTEGER_32
{}
Curle_out_of_memory: INTEGER_32
{}
Curle_operation_timedout: INTEGER_32
{}
Curle_obsolete29: INTEGER_32
{}
Curle_ftp_port_failed: INTEGER_32
{}
Curle_ftp_couldnt_use_rest: INTEGER_32
{}
Curle_obsolete32: INTEGER_32
{}
Curle_range_error: INTEGER_32
{}
Curle_http_post_error: INTEGER_32
{}
Curle_ssl_connect_error: INTEGER_32
{}
Curle_bad_download_resume: INTEGER_32
{}
Curle_file_couldnt_read_file: INTEGER_32
{}
Curle_ldap_cannot_bind: INTEGER_32
{}
Curle_ldap_search_failed: INTEGER_32
{}
Curle_obsolete40: INTEGER_32
{}
Curle_function_not_found: INTEGER_32
{}
Curle_aborted_by_callback: INTEGER_32
{}
Curle_bad_function_argument: INTEGER_32
{}
Curle_obsolete44: INTEGER_32
{}
Curle_interface_failed: INTEGER_32
{}
Curle_obsolete46: INTEGER_32
{}
Curle_too_many_redirects: INTEGER_32
{}
Curle_unknown_option: INTEGER_32
{}
Curle_telnet_option_syntax: INTEGER_32
{}
Curle_obsolete50: INTEGER_32
{}
Curle_peer_failed_verification: INTEGER_32
{}
Curle_got_nothing: INTEGER_32
{}
Curle_ssl_engine_notfound: INTEGER_32
{}
Curle_ssl_engine_setfailed: INTEGER_32
{}
Curle_send_error: INTEGER_32
{}
Curle_recv_error: INTEGER_32
{}
Curle_obsolete57: INTEGER_32
{}
Curle_ssl_certproblem: INTEGER_32
{}
Curle_ssl_cipher: INTEGER_32
{}
Curle_ssl_cacert: INTEGER_32
{}
Curle_bad_content_encoding: INTEGER_32
{}
Curle_ldap_invalid_url: INTEGER_32
{}
Curle_filesize_exceeded: INTEGER_32
{}
Curle_use_ssl_failed: INTEGER_32
{}
Curle_send_fail_rewind: INTEGER_32
{}
Curle_ssl_engine_initfailed: INTEGER_32
{}
Curle_login_denied: INTEGER_32
{}
Curle_tftp_notfound: INTEGER_32
{}
Curle_tftp_perm: INTEGER_32
{}
Curle_remote_disk_full: INTEGER_32
{}
Curle_tftp_illegal: INTEGER_32
{}
Curle_tftp_unknownid: INTEGER_32
{}
Curle_remote_file_exists: INTEGER_32
{}
Curle_tftp_nosuchuser: INTEGER_32
{}
Curle_conv_failed: INTEGER_32
{}
Curle_conv_reqd: INTEGER_32
{}
Curle_ssl_cacert_badfile: INTEGER_32
{}
Curle_remote_file_not_found: INTEGER_32
{}
Curle_ssh: INTEGER_32
{}
Curle_ssl_shutdown_failed: INTEGER_32
{}
Curle_again: INTEGER_32
{}
Curle_ssl_crl_badfile: INTEGER_32
{}
Curle_ssl_issuer_error: INTEGER_32
{}
Curle_ftp_pret_failed: INTEGER_32
{}
Curle_rtsp_cseq_error: INTEGER_32
{}
Curle_rtsp_session_error: INTEGER_32
{}
Curle_ftp_bad_file_list: INTEGER_32
{}
Curle_chunk_failed: INTEGER_32
{}
Curle_no_connection_available: INTEGER_32
{}
Curle_ssl_pinnedpubkeynotmatch: INTEGER_32
{}
valid_url (a_url: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
True if the STRING represents a real URL (i.e. with a known protocol and a valid URI for that protocol)
require
  • a_url /= Void
read_character
effective procedure
{ANY}
If read_character fail, end_of_input is set.
Else, use last_character. Read tutorial or io cluster documentation to learn the read_character usage pattern.
require
  • is_connected
  • not is_filtered and then can_read_character
ensure
read_line_in (buffer: STRING)
effective procedure
{ANY}
Same job as read_line but storage is directly done in buffer.
Read tutorial or io cluster documentation to learn the read_line usage pattern.
require
  • is_connected
  • not is_filtered and then can_read_line
  • buffer /= Void
read_available_in (buffer: STRING, limit: INTEGER_32)
effective procedure
{ANY}
Same job as read_available but storage is directly done in buffer.
The usage pattern is the same as for read_line.
require
  • is_connected
  • not is_filtered
  • buffer /= Void
  • limit > 0
unread_character
effective procedure
{ANY}
require
  • is_connected
  • not is_filtered and then can_unread_character
ensure
last_character: CHARACTER
effective function
{ANY}
require
  • is_connected
  • not end_of_input
  • not is_filtered and then valid_last_character
ensure
detach
effective procedure
{ANY}
Shake off the filter.
ensure
  • not is_filtered
filtered_read_available_in (buffer: STRING, limit: INTEGER_32)
effective procedure
require
filtered_read_line_in (buffer: STRING)
effective procedure
require
writable attribute
The filter that uses this stream as backend
event_can_read: EVENT_DESCRIPTOR
effective function
{ANY}
writable attribute
{}
is_filtered: BOOLEAN
deferred function
{ANY}
skip_separators
effective procedure
{ANY}
Skip all separators (see is_separator of class CHARACTER) and make the first non-separator available in last_character.
This non-separator character is pushed back into the stream (see unread_character) to be available one more time (the next read_character will consider this non-separator). When end_of_input occurs, this process is automatically stopped.
require
skip_separators_using (separators: STRING)
effective procedure
{ANY}
Same job as skip_separators using the separators set.
require
skip_remainder_of_line
effective procedure
{ANY}
Skip all the remainder of the line including the end of line delimiter itself.
read_integer
effective procedure
{ANY}
Read an integer according to the Eiffel syntax.
 Make result available in last_integer.  Heading
separators are automatically skipped using is_separator of class CHARACTER.  Trailing separators
are not skipped.
require ensure
last_integer: INTEGER_32
writable attribute
{ANY}
Last integer read using read_integer.
valid_last_integer: BOOLEAN
writable attribute
{ANY}
Was the last call to read_integer successful ?
last_real: REAL_64
writable attribute
{ANY}
Last real read with read_real.
valid_last_real: BOOLEAN
writable attribute
{ANY}
Was the last call to read_real successful ?
read_real
effective procedure
{ANY}
Read a REAL and make the result available in last_real.
require ensure
last_string: STRING
once function
{ANY}
Access to the unique common buffer to get for example the result computed by read_line, read_word, newline, etc.
This is a once function (the same common buffer is used for all streams).
read_line
effective procedure
{ANY}
Read a complete line ended by '%N' or end_of_input.%
% Make the result available in last_string common buffer. The end of line character (usually '%N') is not added in the last_string buffer. Read tutorial or io cluster documentation to learn the read_line usage pattern.
See also read_line_in.
require
read_available (limit: INTEGER_32)
effective procedure
{ANY}
Read as many characters as possible, as long as the stream does not block and up to the given limit.
read_word
effective procedure
{ANY}
Read a word using is_separator of class CHARACTER.
The result is available in the last_string common buffer. Heading separators are automatically skipped. Trailing separators are not skipped (last_character is left on the first one). If end_of_input is encountered, Result can be the empty string.
require
newline
effective procedure
{ANY}
Consume input until newline ('%N') is found.
% The corresponding STRING is stored in last_string common buffer.
require
reach_and_skip (keyword: STRING)
effective procedure
{ANY}
Try to skip enough characters in order to reach the keyword which is skipped too.
If the keyword is not in the remainder of this stream, the process is stopped as soon as end_of_input occurs.
require ensure
read_word_using (separators: STRING)
effective procedure
{ANY}
Same job as read_word using separators.
require
read_tail_in (str: STRING)
effective procedure
{ANY}
Read all remaining character of the stream in str.
require ensure
io_getc (stream: POINTER): INTEGER_32
{}
io_ungetc (byte: CHARACTER, stream: POINTER)
{}
io_fread (buf: NATIVE_ARRAY[CHARACTER], size: INTEGER_32, stream: POINTER): INTEGER_32
{}
return size read or 0 if end of input (-1 on error => exception ?)
{}
set_filter (a_filter: FILTER)
effective procedure
Used by the filter itself to get attached
require
  • a_filter /= Void
ensure