Utility functions that set up, use and shut down the Ecore URL Connection library. More...
Data Structures | |
struct | _Ecore_Con_Event_Url_Data |
Used as the data param for the ECORE_CON_EVENT_URL_DATA event. More... | |
struct | _Ecore_Con_Event_Url_Complete |
Used as the data param for the ECORE_CON_EVENT_URL_COMPLETE event. More... | |
struct | _Ecore_Con_Event_Url_Progress |
Used as the data param for the ECORE_CON_EVENT_URL_PROGRESS event. More... | |
Macros | |
#define | MODE_AUTO 0 |
#define | MODE_GET 1 |
#define | MODE_POST 2 |
Typedefs | |
typedef enum _Ecore_Con_Url_Time | Ecore_Con_Url_Time |
typedef enum _Ecore_Con_Url_Http_Version | Ecore_Con_Url_Http_Version |
typedef struct _Ecore_Con_Url | Ecore_Con_Url |
A handle to an http upload/download object. | |
typedef struct _Ecore_Con_Event_Url_Data | Ecore_Con_Event_Url_Data |
Used as the data param for the corresponding event. | |
typedef struct _Ecore_Con_Event_Url_Complete | Ecore_Con_Event_Url_Complete |
Used as the data param for the corresponding event. | |
typedef struct _Ecore_Con_Event_Url_Progress | Ecore_Con_Event_Url_Progress |
Used as the data param for the corresponding event. | |
Enumerations | |
enum | _Ecore_Con_Url_Time { ECORE_CON_URL_TIME_NONE = 0, ECORE_CON_URL_TIME_IFMODSINCE, ECORE_CON_URL_TIME_IFUNMODSINCE } |
The type of condition to use when making an HTTP request dependent on time, so that headers such as "If-Modified-Since" are used. More... | |
enum | _Ecore_Con_Url_Http_Version { ECORE_CON_URL_HTTP_VERSION_1_0, ECORE_CON_URL_HTTP_VERSION_1_1 } |
The http version to use. More... | |
Functions | |
EAPI Eina_Bool | ecore_con_url_http_version_set (Ecore_Con_Url *url_con, Ecore_Con_Url_Http_Version version) |
Change the HTTP version used for the request. More... | |
EAPI int | ecore_con_url_init (void) |
Initialises the Ecore_Con_Url library. More... | |
EAPI int | ecore_con_url_shutdown (void) |
Shuts down the Ecore_Con_Url library. More... | |
EAPI void | ecore_con_url_pipeline_set (Eina_Bool enable) |
Enable or disable HTTP 1.1 pipelining. More... | |
EAPI Eina_Bool | ecore_con_url_pipeline_get (void) |
Is HTTP 1.1 pipelining enable ? More... | |
EAPI Ecore_Con_Url * | ecore_con_url_new (const char *url) |
Creates and initializes a new Ecore_Con_Url connection object. More... | |
EAPI Ecore_Con_Url * | ecore_con_url_custom_new (const char *url, const char *custom_request) |
Creates a custom connection object. More... | |
EAPI void | ecore_con_url_free (Ecore_Con_Url *url_con) |
Destroys a Ecore_Con_Url connection object. More... | |
EAPI Eina_Bool | ecore_con_url_url_set (Ecore_Con_Url *url_con, const char *url) |
Sets the URL to send the request to. More... | |
EAPI const char * | ecore_con_url_url_get (Ecore_Con_Url *url_con) |
Gets the URL to send the request to. More... | |
EAPI void | ecore_con_url_data_set (Ecore_Con_Url *url_con, void *data) |
Associates data with a connection object. More... | |
EAPI void * | ecore_con_url_data_get (Ecore_Con_Url *url_con) |
Retrieves data associated with a Ecore_Con_Url connection object. More... | |
EAPI void | ecore_con_url_additional_header_add (Ecore_Con_Url *url_con, const char *key, const char *value) |
Adds an additional header to the request connection object. More... | |
EAPI void | ecore_con_url_additional_headers_clear (Ecore_Con_Url *url_con) |
Cleans additional headers. More... | |
EAPI const Eina_List * | ecore_con_url_response_headers_get (Ecore_Con_Url *url_con) |
Retrieves headers from last request sent. More... | |
EAPI void | ecore_con_url_fd_set (Ecore_Con_Url *url_con, int fd) |
Setup a file for receiving response data. More... | |
EAPI int | ecore_con_url_received_bytes_get (Ecore_Con_Url *url_con) |
Retrieves the number of bytes received. More... | |
EAPI Eina_Bool | ecore_con_url_httpauth_set (Ecore_Con_Url *url_con, const char *username, const char *password, Eina_Bool safe) |
Sets url_con to use http auth, with given username and password, "safely" or not. More... | |
EAPI Eina_Bool | ecore_con_url_get (Ecore_Con_Url *url_con) |
Sends a get request. More... | |
EAPI Eina_Bool | ecore_con_url_post (Ecore_Con_Url *url_con, const void *data, long length, const char *content_type) |
Sends a post request. More... | |
EAPI void | ecore_con_url_time (Ecore_Con_Url *url_con, Ecore_Con_Url_Time time_condition, double timestamp) |
Sets whether HTTP requests should be conditional, dependent on modification time. More... | |
EAPI Eina_Bool | ecore_con_url_ftp_upload (Ecore_Con_Url *url_con, const char *filename, const char *user, const char *pass, const char *upload_dir) |
Uploads a file to an ftp site. More... | |
EAPI void | ecore_con_url_verbose_set (Ecore_Con_Url *url_con, Eina_Bool verbose) |
Toggle libcurl's verbose output. More... | |
EAPI void | ecore_con_url_ftp_use_epsv_set (Ecore_Con_Url *url_con, Eina_Bool use_epsv) |
Enable or disable EPSV extension. More... | |
EAPI void | ecore_con_url_cookies_init (Ecore_Con_Url *url_con) |
Enables the cookie engine for subsequent HTTP requests. More... | |
EAPI void | ecore_con_url_cookies_ignore_old_session_set (Ecore_Con_Url *url_con, Eina_Bool ignore) |
Controls whether session cookies from previous sessions shall be loaded. More... | |
EAPI void | ecore_con_url_cookies_clear (Ecore_Con_Url *url_con) |
Clears currently loaded cookies. More... | |
EAPI void | ecore_con_url_cookies_session_clear (Ecore_Con_Url *url_con) |
Clears currently loaded session cookies. More... | |
EAPI void | ecore_con_url_cookies_file_add (Ecore_Con_Url *url_con, const char *const file_name) |
Adds a file to the list of files from which to load cookies. More... | |
EAPI Eina_Bool | ecore_con_url_cookies_jar_file_set (Ecore_Con_Url *url_con, const char *const cookiejar_file) |
Sets the name of the file to which all current cookies will be written when either cookies are flushed or Ecore_Con is shut down. More... | |
EAPI void | ecore_con_url_cookies_jar_write (Ecore_Con_Url *url_con) |
Writes all current cookies to the cookie jar immediately. More... | |
EAPI void | ecore_con_url_ssl_verify_peer_set (Ecore_Con_Url *url_con, Eina_Bool verify) |
Toggle libcurl's verify peer's certificate option. More... | |
EAPI int | ecore_con_url_ssl_ca_set (Ecore_Con_Url *url_con, const char *ca_path) |
Set a custom CA to trust for SSL/TLS connections. More... | |
EAPI Eina_Bool | ecore_con_url_proxy_set (Ecore_Con_Url *url_con, const char *proxy) |
Set HTTP proxy to use. More... | |
EAPI Eina_Bool | ecore_con_url_proxy_username_set (Ecore_Con_Url *url_con, const char *username) |
Set zero terminated username to use for proxy. More... | |
EAPI Eina_Bool | ecore_con_url_proxy_password_set (Ecore_Con_Url *url_con, const char *password) |
Set zero terminated password to use for proxy. More... | |
EAPI void | ecore_con_url_timeout_set (Ecore_Con_Url *url_con, double timeout) |
Set timeout in seconds. More... | |
EAPI int | ecore_con_url_status_code_get (Ecore_Con_Url *url_con) |
Get the returned HTTP STATUS code. More... | |
static Eina_Bool | _ecore_con_url_send (Ecore_Con_Url *url_con, int mode, const void *data, long length, const char *content_type) |
Variables | |
Ecore_Con_Socks * | _ecore_con_proxy_global |
Utility functions that set up, use and shut down the Ecore URL Connection library.
These functions are a shortcut to make it easy to perform http requests (POST, GET, etc).
Brief usage:
Note that it is good to reuse Ecore_Con_Url objects wherever possible, but bear in mind that each one can only perform one operation at a time. You need to wait for the ECORE_CON_EVENT_URL_COMPLETE event before re-using or destroying the object.
If it's necessary to change the Ecore_Con_Url object url, use ecore_con_url_url_set().
Simple Usage 1 (HTTP GET):
Simple usage 2 (HTTP POST):
Simple Usage 3 (FTP download):
Simple Usage 4 (FTP upload as ftp://ftp.example.com/file):
Simple Usage 5 (FTP upload as ftp://ftp.example.com/dir/file):
These are complete examples for the API:
enum _Ecore_Con_Url_Time |
The type of condition to use when making an HTTP request dependent on time, so that headers such as "If-Modified-Since" are used.
EAPI Eina_Bool ecore_con_url_http_version_set | ( | Ecore_Con_Url * | url_con, |
Ecore_Con_Url_Http_Version | version | ||
) |
Change the HTTP version used for the request.
url_con | Connection object through which the request will be sent. |
version | The version to be used |
EINA_TRUE
on success, EINA_FALSE
on failure to change version. References ECORE_CON_URL_HTTP_VERSION_1_0, ECORE_CON_URL_HTTP_VERSION_1_1, and EINA_FALSE.
EAPI int ecore_con_url_init | ( | void | ) |
Initialises the Ecore_Con_Url library.
References EAPI, ECORE_CON_EVENT_URL_COMPLETE, ECORE_CON_EVENT_URL_DATA, ECORE_CON_EVENT_URL_PROGRESS, and ecore_event_type_new().
EAPI int ecore_con_url_shutdown | ( | void | ) |
Shuts down the Ecore_Con_Url library.
References EAPI, ecore_con_url_free(), ecore_idler_del(), ecore_main_fd_handler_del(), ecore_timer_del(), and EINA_LIST_FREE.
Enable or disable HTTP 1.1 pipelining.
enable | EINA_TRUE will turn it on, EINA_FALSE will disable it. |
Pipelining allows to send one request after another one, without having to wait for the reply of the first request. The respective replies are received in the order that the requests were sent.
Enabling this feature will be valid for all requests done using ecore_con_url
.
See http://en.wikipedia.org/wiki/HTTP_pipelining for more info.
References EAPI.
Is HTTP 1.1 pipelining enable ?
EINA_TRUE
if it is enable.EAPI Ecore_Con_Url * ecore_con_url_new | ( | const char * | url | ) |
Creates and initializes a new Ecore_Con_Url connection object.
url | URL that will receive requests. Can be changed using ecore_con_url_url_set. |
NULL
on error, a new Ecore_Con_Url on success.Creates and initializes a new Ecore_Con_Url connection object that can be used for sending requests.
References ecore_con_url_free(), ecore_con_url_proxy_set(), ecore_con_url_proxy_username_set(), and ecore_con_url_url_set().
Referenced by ecore_con_url_custom_new().
EAPI Ecore_Con_Url * ecore_con_url_custom_new | ( | const char * | url, |
const char * | custom_request | ||
) |
Creates a custom connection object.
url | URL that will receive requests |
custom_request | Custom request (e.g. GET, POST, HEAD, PUT, etc) |
NULL
on error, a new Ecore_Con_Url on success.Creates and initializes a new Ecore_Con_Url for a custom request (e.g. HEAD, SUBSCRIBE and other obscure HTTP requests). This object should be used like one created with ecore_con_url_new().
References ecore_con_url_new().
EAPI void ecore_con_url_free | ( | Ecore_Con_Url * | url_con | ) |
Destroys a Ecore_Con_Url connection object.
url_con | Connection object to free. |
References EAPI, ecore_timer_del(), EINA_LIST_FREE, eina_list_remove(), eina_stringshare_del(), and EINA_TRUE.
Referenced by ecore_con_url_new(), ecore_con_url_shutdown(), and ecore_file_download_abort().
EAPI Eina_Bool ecore_con_url_url_set | ( | Ecore_Con_Url * | url_con, |
const char * | url | ||
) |
Sets the URL to send the request to.
url_con | Connection object through which the request will be sent. |
url | URL that will receive the request |
EINA_TRUE
on success, EINA_FALSE
on error. References EINA_FALSE.
Referenced by ecore_con_url_new().
EAPI const char * ecore_con_url_url_get | ( | Ecore_Con_Url * | url_con | ) |
Gets the URL to send the request to.
url_con | Connection object through which the request will be sent. |
NULL
on failure. URL is stringshared. References EAPI.
EAPI void ecore_con_url_data_set | ( | Ecore_Con_Url * | url_con, |
void * | data | ||
) |
Associates data with a connection object.
url_con | Connection object to associate data. |
data | Data to be set. |
Associates data with a connection object, which can be retrieved later with ecore_con_url_data_get()).
References EAPI.
EAPI void * ecore_con_url_data_get | ( | Ecore_Con_Url * | url_con | ) |
Retrieves data associated with a Ecore_Con_Url connection object.
url_con | Connection object to retrieve data from. |
Retrieves data associated with a Ecore_Con_Url connection object (previously set with ecore_con_url_data_set()).
References EAPI.
Referenced by ecore_file_download_abort().
EAPI void ecore_con_url_additional_header_add | ( | Ecore_Con_Url * | url_con, |
const char * | key, | ||
const char * | value | ||
) |
Adds an additional header to the request connection object.
url_con | Connection object |
key | Header key |
value | Header value |
Adds an additional header (User-Agent, Content-Type, etc.) to the request connection object. This addition will be valid for only one ecore_con_url_get() or ecore_con_url_post() call.
Some functions like ecore_con_url_time() also add headers to the request.
References EAPI, and eina_list_append().
EAPI void ecore_con_url_additional_headers_clear | ( | Ecore_Con_Url * | url_con | ) |
Cleans additional headers.
url_con | Connection object to clean additional headers. |
Cleans additional headers associated with a connection object (previously added with ecore_con_url_additional_header_add()).
References EAPI, and EINA_LIST_FREE.
EAPI const Eina_List * ecore_con_url_response_headers_get | ( | Ecore_Con_Url * | url_con | ) |
Retrieves headers from last request sent.
url_con | Connection object to retrieve response headers from. |
Retrieves a list containing the response headers. This function should be used after an ECORE_CON_EVENT_URL_COMPLETE event (headers should normally be ready at that time).
References EAPI.
EAPI void ecore_con_url_fd_set | ( | Ecore_Con_Url * | url_con, |
int | fd | ||
) |
Setup a file for receiving response data.
url_con | Connection object to set file |
fd | File descriptor associated with the file. A negative value will unset any previously set fd. |
Sets up a file to have response data written into. Note that ECORE_CON_EVENT_URL_DATA events will not be emitted if a file has been set to receive the response data.
This call can be used to easily setup a file where the downloaded data will be saved.
References EAPI.
EAPI int ecore_con_url_received_bytes_get | ( | Ecore_Con_Url * | url_con | ) |
Retrieves the number of bytes received.
Retrieves the number of bytes received on the last request of the given connection object.
url_con | Connection object which the request was sent on. |
References EAPI.
EAPI Eina_Bool ecore_con_url_httpauth_set | ( | Ecore_Con_Url * | url_con, |
const char * | username, | ||
const char * | password, | ||
Eina_Bool | safe | ||
) |
Sets url_con to use http auth, with given username and password, "safely" or not.
url_con | Connection object to perform a request on, previously created with ecore_con_url_new() or ecore_con_url_custom_new(). |
username | Username to use in authentication |
password | Password to use in authentication |
safe | Whether to use "safer" methods (eg, NOT http basic auth) |
EINA_TRUE
on success, EINA_FALSE
on error.0
. References EINA_FALSE.
EAPI Eina_Bool ecore_con_url_get | ( | Ecore_Con_Url * | url_con | ) |
Sends a get request.
url_con | Connection object to perform a request on, previously created |
EINA_TRUE
on success, EINA_FALSE
on error.The request is performed immediately, but you need to setup event handlers for ECORE_CON_EVENT_URL_DATA, ECORE_CON_EVENT_URL_COMPLETE or ECORE_CON_EVENT_URL_PROGRESS to get more information about its result.
EAPI Eina_Bool ecore_con_url_post | ( | Ecore_Con_Url * | url_con, |
const void * | data, | ||
long | length, | ||
const char * | content_type | ||
) |
Sends a post request.
url_con | Connection object to perform a request on, previously created with ecore_con_url_new() or ecore_con_url_custom_new(). |
data | Payload (data sent on the request). Can be NULL . |
length | Payload length. If -1 , rely on automatic length calculation via strlen() on data . |
content_type | Content type of the payload (e.g. text/xml). Can be NULL . |
EINA_TRUE
on success, EINA_FALSE
on error.The request starts immediately, but you need to setup event handlers for ECORE_CON_EVENT_URL_DATA, ECORE_CON_EVENT_URL_COMPLETE or ECORE_CON_EVENT_URL_PROGRESS to get more information about its result.
This call won't block your main loop.
EAPI void ecore_con_url_time | ( | Ecore_Con_Url * | url_con, |
Ecore_Con_Url_Time | time_condition, | ||
double | timestamp | ||
) |
Sets whether HTTP requests should be conditional, dependent on modification time.
url_con | Ecore_Con_Url to act upon. |
time_condition | Condition to use for HTTP requests. |
timestamp | Time since 1 Jan 1970 to use in the condition. |
This function may set the header "If-Modified-Since" or "If-Unmodified-Since", depending on the value of time_condition
, with the value timestamp
.
References EAPI.
EAPI Eina_Bool ecore_con_url_ftp_upload | ( | Ecore_Con_Url * | url_con, |
const char * | filename, | ||
const char * | user, | ||
const char * | pass, | ||
const char * | upload_dir | ||
) |
Uploads a file to an ftp site.
url_con | The Ecore_Con_Url object to send with |
filename | The path to the file to send |
user | The username to log in with |
pass | The password to log in with |
upload_dir | The directory to which the file should be uploaded |
EINA_TRUE
on success, EINA_FALSE
otherwise.Upload filename
to an ftp server set in url_con
using user
and pass
to directory upload_dir
References EINA_FALSE.
EAPI void ecore_con_url_verbose_set | ( | Ecore_Con_Url * | url_con, |
Eina_Bool | verbose | ||
) |
Toggle libcurl's verbose output.
url_con | Ecore_Con_Url instance which will be acted upon. |
verbose | Whether or not to enable libcurl's verbose output. |
If verbose
is EINA_TRUE
, libcurl will output a lot of verbose information about its operations, which is useful for debugging. The verbose information will be sent to stderr.
References EAPI.
EAPI void ecore_con_url_ftp_use_epsv_set | ( | Ecore_Con_Url * | url_con, |
Eina_Bool | use_epsv | ||
) |
Enable or disable EPSV extension.
url_con | The Ecore_Con_Url instance which will be acted upon. |
use_epsv | Boolean to enable/disable the EPSV extension. |
References EAPI.
EAPI void ecore_con_url_cookies_init | ( | Ecore_Con_Url * | url_con | ) |
Enables the cookie engine for subsequent HTTP requests.
url_con | Ecore_Con_Url instance which will be acted upon. |
After this function is called, cookies set by the server in HTTP responses will be parsed and stored, as well as sent back to the server in new HTTP requests.
ecore_con_url_cookies_init()
, there is no symmetrical shutdown operation. References EAPI.
EAPI void ecore_con_url_cookies_ignore_old_session_set | ( | Ecore_Con_Url * | url_con, |
Eina_Bool | ignore | ||
) |
Controls whether session cookies from previous sessions shall be loaded.
url_con | Ecore_Con_Url instance which will be acted upon. |
ignore | If EINA_TRUE , ignore session cookies when loading cookies from files. If EINA_FALSE , all cookies will be loaded. |
Session cookies are cookies with no expire date set, which usually means they are removed after the current session is closed.
By default, when Ecore_Con_Url loads cookies from a file, all cookies are loaded, including session cookies, which, most of the time, were supposed to be loaded and valid only for that session.
If ignore
is set to EINA_TRUE
, when Ecore_Con_Url loads cookies from the files passed to ecore_con_url_cookies_file_add()
, session cookies will not be loaded.
References EAPI.
EAPI void ecore_con_url_cookies_clear | ( | Ecore_Con_Url * | url_con | ) |
Clears currently loaded cookies.
url_con | Ecore_Con_Url instance which will be acted upon. |
The cleared cookies are removed and will not be sent in subsequent HTTP requests, nor will they be written to the cookiejar file set via ecore_con_url_cookies_jar_file_set()
.
url_con
handler, and call this function to clear any cookie set by a previous request on this handler.References EAPI.
EAPI void ecore_con_url_cookies_session_clear | ( | Ecore_Con_Url * | url_con | ) |
Clears currently loaded session cookies.
url_con | Ecore_Con_Url instance which will be acted upon. |
Session cookies are cookies with no expire date set, which usually means they are removed after the current session is closed.
The cleared cookies are removed and will not be sent in subsequent HTTP requests, nor will they be written to the cookiejar file set via ecore_con_url_cookies_jar_file_set()
.
url_con
handler, and call this function to clear any session cookie set by a previous request on this handler. An easier way to don't use old session cookies is by using the function ecore_con_url_cookies_ignore_old_session_set().References EAPI.
EAPI void ecore_con_url_cookies_file_add | ( | Ecore_Con_Url * | url_con, |
const char *const | file_name | ||
) |
Adds a file to the list of files from which to load cookies.
url_con | Ecore_Con_Url instance which will be acted upon. |
file_name | Name of the file that will be added to the list. |
Files must contain cookies defined according to two possible formats:
Cookies will only be read from this file. If you want to save cookies to a file, use ecore_con_url_cookies_jar_file_set(). Also notice that this function supports the both types of cookie file cited above, while ecore_con_url_cookies_jar_file_set() will save only in the Netscape/Mozilla's format.
Please notice that the file will not be read immediately, but rather added to a list of files that will be loaded and parsed at a later time.
References EAPI.
EAPI Eina_Bool ecore_con_url_cookies_jar_file_set | ( | Ecore_Con_Url * | url_con, |
const char *const | cookiejar_file | ||
) |
Sets the name of the file to which all current cookies will be written when either cookies are flushed or Ecore_Con is shut down.
url_con | Ecore_Con_Url instance which will be acted upon. |
cookiejar_file | File to which the cookies will be written. |
EINA_TRUE
is the file name has been set successfully, EINA_FALSE
otherwise.Cookies are written following Netscape/Mozilla's data format, also known as cookie-jar.
Cookies will only be saved to this file. If you need to read cookies from a file, use ecore_con_url_cookies_file_add() instead.
References EINA_FALSE.
EAPI void ecore_con_url_cookies_jar_write | ( | Ecore_Con_Url * | url_con | ) |
Writes all current cookies to the cookie jar immediately.
url_con | Ecore_Con_Url instance which will be acted upon. |
A cookie-jar file must have been previously set by ecore_con_url_jar_file_set
, otherwise nothing will be done.
References EAPI.
EAPI void ecore_con_url_ssl_verify_peer_set | ( | Ecore_Con_Url * | url_con, |
Eina_Bool | verify | ||
) |
Toggle libcurl's verify peer's certificate option.
If verify
is EINA_TRUE
, libcurl will verify the authenticity of the peer's certificate, otherwise it will not. Default behavior of libcurl is to check peer's certificate.
url_con | Ecore_Con_Url instance which will be acted upon. |
verify | Whether or not libcurl will check peer's certificate. |
References EAPI.
EAPI int ecore_con_url_ssl_ca_set | ( | Ecore_Con_Url * | url_con, |
const char * | ca_path | ||
) |
Set a custom CA to trust for SSL/TLS connections.
Specify the path of a file (in PEM format) containing one or more CA certificate(s) to use for the validation of the server certificate.
This function can also disable CA validation if ca_path
is NULL
. However, the server certificate still needs to be valid for the connection to succeed (i.e., the certificate must concern the server the connection is made to).
url_con | Connection object that will use the custom CA. |
ca_path | Path to a CA certificate(s) file or NULL to disable CA validation. |
0
on success. When cURL is used, non-zero return values are equal to cURL error codes. References EAPI.
EAPI Eina_Bool ecore_con_url_proxy_set | ( | Ecore_Con_Url * | url_con, |
const char * | proxy | ||
) |
Set HTTP proxy to use.
The parameter should be a char * to a zero terminated string holding the host name or dotted IP address. To specify port number in this string, append :[port] to the end of the host name. The proxy string may be prefixed with [protocol]:// since any such prefix will be ignored. The proxy's port number may optionally be specified with the separate option. If not specified, libcurl will default to using port 1080 for proxies.
url_con | Connection object that will use the proxy. |
proxy | Porxy string or NULL to disable |
EINA_TRUE
on success, EINA_FALSE
on error. References EINA_FALSE.
Referenced by ecore_con_url_new().
EAPI Eina_Bool ecore_con_url_proxy_username_set | ( | Ecore_Con_Url * | url_con, |
const char * | username | ||
) |
Set zero terminated username to use for proxy.
if socks protocol is used for proxy, protocol should be socks5 and above.
url_con | Connection object that will use the proxy. |
username | Username string. |
EINA_TRUE
on success, EINA_FALSE
on error.References EINA_FALSE.
Referenced by ecore_con_url_new().
EAPI Eina_Bool ecore_con_url_proxy_password_set | ( | Ecore_Con_Url * | url_con, |
const char * | password | ||
) |
Set zero terminated password to use for proxy.
if socks protocol is used for proxy, protocol should be socks5 and above.
url_con | Connection object that will use the proxy. |
password | Password string. |
EINA_TRUE
on success, EINA_FALSE
on error.References EINA_FALSE.
EAPI void ecore_con_url_timeout_set | ( | Ecore_Con_Url * | url_con, |
double | timeout | ||
) |
Set timeout in seconds.
the maximum time in seconds that you allow the ecore con url transfer operation to take. Normally, name lookups can take a considerable time and limiting operations to less than a few minutes risk aborting perfectly normal operations.
url_con | Connection object that will use the timeout. |
timeout | time in seconds. |
References EAPI, ecore_timer_add(), and ecore_timer_del().
EAPI int ecore_con_url_status_code_get | ( | Ecore_Con_Url * | url_con | ) |
Get the returned HTTP STATUS code.
This is used to, at any time, try to return the status code for a transmission.
url_con | Connection object |
References EAPI.