summaryrefslogtreecommitdiff
path: root/src/lib/ecore_con
diff options
context:
space:
mode:
authorThiep Ha <thiepha@gmail.com>2015-04-25 19:35:23 +0200
committerCedric BAIL <cedric@osg.samsung.com>2015-04-25 19:35:27 +0200
commit663bdcaf07a5d8550e6fe09d07a7089b1bb7a91c (patch)
tree93a13e85db3142d9258b45f90142366eeed3fde8 /src/lib/ecore_con
parent5c997ea4a34d5cfc8e3f5bb49b11a0ec60c03993 (diff)
ecore_con: fix typos and improve document consistence.
Summary: This patch fixes typos and uses primitive verb in brief section to improve document consistence for ecore_con. Reviewers: Hermet, cedric Reviewed By: cedric Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D2424 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib/ecore_con')
-rw-r--r--src/lib/ecore_con/Ecore_Con.h180
1 files changed, 90 insertions, 90 deletions
diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h
index 2c9907945c..05448586a1 100644
--- a/src/lib/ecore_con/Ecore_Con.h
+++ b/src/lib/ecore_con/Ecore_Con.h
@@ -81,7 +81,7 @@
81 * retrieval of the client's ip with @ref ecore_con_client_ip_get and 81 * retrieval of the client's ip with @ref ecore_con_client_ip_get and
82 * associating data with the client using ecore_con_client_data_set. 82 * associating data with the client using ecore_con_client_data_set.
83 * @li ECORE_CON_EVENT_CLIENT_DEL: Whenever a client connection to an 83 * @li ECORE_CON_EVENT_CLIENT_DEL: Whenever a client connection to an
84 * @c Ecore_Con_Server, an event of this type is emitted. The contents of 84 * @c Ecore_Con_Server is destroyed, an event of this type is emitted. The contents of
85 * the data with this event are variable, but if the client object in the data 85 * the data with this event are variable, but if the client object in the data
86 * is non-null, it must be freed with @ref ecore_con_client_del. 86 * is non-null, it must be freed with @ref ecore_con_client_del.
87 * @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a server object receives 87 * @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a server object receives
@@ -668,7 +668,7 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS;
668 */ 668 */
669 669
670/** 670/**
671 * Initialises the Ecore_Con library. 671 * @brief Initialise the Ecore_Con library.
672 * @return Number of times the library has been initialised without being 672 * @return Number of times the library has been initialised without being
673 * shut down. 673 * shut down.
674 * 674 *
@@ -678,7 +678,7 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS;
678EAPI int ecore_con_init(void); 678EAPI int ecore_con_init(void);
679 679
680/** 680/**
681 * Shuts down the Ecore_Con library. 681 * @brief Shut down the Ecore_Con library.
682 * @return Number of times the library has been initialised without being 682 * @return Number of times the library has been initialised without being
683 * shut down. 683 * shut down.
684 * @note This function already calls ecore_shutdown() internally, so you don't 684 * @note This function already calls ecore_shutdown() internally, so you don't
@@ -700,7 +700,7 @@ EAPI int ecore_con_shutdown(void);
700 */ 700 */
701 701
702/** 702/**
703 * Returns if SSL support is available 703 * @brief Return if SSL support is available
704 * @return 1 if SSL is available and provided by gnutls, 704 * @return 1 if SSL is available and provided by gnutls,
705 * 2 if SSL is available and provided by openssl, 705 * 2 if SSL is available and provided by openssl,
706 * 0 if it is not available. 706 * 0 if it is not available.
@@ -844,7 +844,7 @@ EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_
844 */ 844 */
845 845
846/** 846/**
847 * Add a SOCKS v4 proxy to the proxy list 847 * @brief Add a SOCKS v4 proxy to the proxy list
848 * 848 *
849 * Use this to create (or return, if previously added) a SOCKS proxy 849 * Use this to create (or return, if previously added) a SOCKS proxy
850 * object which can be used by any ecore_con servers. 850 * object which can be used by any ecore_con servers.
@@ -858,7 +858,7 @@ EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_
858EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, const char *username); 858EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, const char *username);
859 859
860/** 860/**
861 * Find a SOCKS v4 proxy in the proxy list 861 * @brief Find a SOCKS v4 proxy in the proxy list
862 * 862 *
863 * Use this to determine if a SOCKS proxy was previously added by checking 863 * Use this to determine if a SOCKS proxy was previously added by checking
864 * the proxy list against the parameters given. 864 * the proxy list against the parameters given.
@@ -873,7 +873,7 @@ EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, cons
873EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, const char *username); 873EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, const char *username);
874 874
875/** 875/**
876 * Remove a SOCKS v4 proxy from the proxy list and delete it 876 * @brief Remove a SOCKS v4 proxy from the proxy list and delete it
877 * 877 *
878 * Use this to remove a SOCKS proxy from the proxy list by checking 878 * Use this to remove a SOCKS proxy from the proxy list by checking
879 * the list against the parameters given. The proxy will then be deleted. 879 * the list against the parameters given. The proxy will then be deleted.
@@ -887,7 +887,7 @@ EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, c
887EAPI void ecore_con_socks4_remote_del(const char *ip, int port, const char *username); 887EAPI void ecore_con_socks4_remote_del(const char *ip, int port, const char *username);
888 888
889/** 889/**
890 * Add a SOCKS v5 proxy to the proxy list 890 * @brief Add a SOCKS v5 proxy to the proxy list
891 * 891 *
892 * Use this to create (or return, if previously added) a SOCKS proxy 892 * Use this to create (or return, if previously added) a SOCKS proxy
893 * object which can be used by any ecore_con servers. 893 * object which can be used by any ecore_con servers.
@@ -902,7 +902,7 @@ EAPI void ecore_con_socks4_remote_del(const char *ip, int port, cons
902EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, const char *username, const char *password); 902EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, const char *username, const char *password);
903 903
904/** 904/**
905 * Find a SOCKS v5 proxy in the proxy list 905 * @brief Find a SOCKS v5 proxy in the proxy list
906 * 906 *
907 * Use this to determine if a SOCKS proxy was previously added by checking 907 * Use this to determine if a SOCKS proxy was previously added by checking
908 * the proxy list against the parameters given. 908 * the proxy list against the parameters given.
@@ -918,7 +918,7 @@ EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, cons
918EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, const char *username, const char *password); 918EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, const char *username, const char *password);
919 919
920/** 920/**
921 * Remove a SOCKS v5 proxy from the proxy list and delete it 921 * @brief Remove a SOCKS v5 proxy from the proxy list and delete it
922 * 922 *
923 * Use this to remove a SOCKS proxy from the proxy list by checking 923 * Use this to remove a SOCKS proxy from the proxy list by checking
924 * the list against the parameters given. The proxy will then be deleted. 924 * the list against the parameters given. The proxy will then be deleted.
@@ -933,7 +933,7 @@ EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, c
933EAPI void ecore_con_socks5_remote_del(const char *ip, int port, const char *username, const char *password); 933EAPI void ecore_con_socks5_remote_del(const char *ip, int port, const char *username, const char *password);
934 934
935/** 935/**
936 * Set DNS lookup mode on an existing SOCKS proxy 936 * @brief Set DNS lookup mode on an existing SOCKS proxy
937 * 937 *
938 * According to RFC, SOCKS v4 does not require that a proxy perform 938 * According to RFC, SOCKS v4 does not require that a proxy perform
939 * its own DNS lookups for addresses. SOCKS v4a specifies the protocol 939 * its own DNS lookups for addresses. SOCKS v4a specifies the protocol
@@ -948,7 +948,7 @@ EAPI void ecore_con_socks5_remote_del(const char *ip, int port, cons
948EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool enable); 948EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool enable);
949 949
950/** 950/**
951 * Get DNS lookup mode on an existing SOCKS proxy 951 * @brief Get DNS lookup mode on an existing SOCKS proxy
952 * 952 *
953 * According to RFC, SOCKS v4 does not require that a proxy perform 953 * According to RFC, SOCKS v4 does not require that a proxy perform
954 * its own DNS lookups for addresses. SOCKS v4a specifies the protocol 954 * its own DNS lookups for addresses. SOCKS v4a specifies the protocol
@@ -962,7 +962,7 @@ EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool
962EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs); 962EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs);
963 963
964/** 964/**
965 * Enable bind mode on a SOCKS proxy 965 * @brief Enable bind mode on a SOCKS proxy
966 * 966 *
967 * Use this function to enable binding a remote port for use with a remote server. 967 * Use this function to enable binding a remote port for use with a remote server.
968 * For more information, see http://ufasoft.com/doc/socks4_protocol.htm 968 * For more information, see http://ufasoft.com/doc/socks4_protocol.htm
@@ -974,7 +974,7 @@ EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs);
974EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool is_bind); 974EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool is_bind);
975 975
976/** 976/**
977 * Return bind mode of a SOCKS proxy 977 * @brief Return bind mode of a SOCKS proxy
978 * 978 *
979 * Use this function to return bind mode of a proxy (binding a remote port for use with a remote server). 979 * Use this function to return bind mode of a proxy (binding a remote port for use with a remote server).
980 * For more information, see http://ufasoft.com/doc/socks4_protocol.htm 980 * For more information, see http://ufasoft.com/doc/socks4_protocol.htm
@@ -985,7 +985,7 @@ EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool i
985EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs); 985EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs);
986 986
987/** 987/**
988 * Return SOCKS version of a SOCKS proxy 988 * @brief Return SOCKS version of a SOCKS proxy
989 * 989 *
990 * Use this function to return the SOCKS protocol version of a proxy 990 * Use this function to return the SOCKS protocol version of a proxy
991 * @param ecs The proxy object 991 * @param ecs The proxy object
@@ -995,7 +995,7 @@ EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs);
995EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs); 995EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs);
996 996
997/** 997/**
998 * Remove a SOCKS v4 proxy from the proxy list and delete it 998 * @brief Remove a SOCKS v4 proxy from the proxy list and delete it
999 * 999 *
1000 * Use this to remove a SOCKS proxy from the proxy list by directly deleting the object given. 1000 * Use this to remove a SOCKS proxy from the proxy list by directly deleting the object given.
1001 * @param ecs The proxy object to delete 1001 * @param ecs The proxy object to delete
@@ -1005,7 +1005,7 @@ EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs);
1005EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs); 1005EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs);
1006 1006
1007/** 1007/**
1008 * Set a proxy object to be used with the next server created with ecore_con_server_connect() 1008 * @brief Set a proxy object to be used with the next server created with ecore_con_server_connect()
1009 * 1009 *
1010 * This function sets a proxy for the next ecore_con connection. After the next server is created, 1010 * This function sets a proxy for the next ecore_con connection. After the next server is created,
1011 * the proxy will NEVER be applied again unless explicitly enabled. 1011 * the proxy will NEVER be applied again unless explicitly enabled.
@@ -1016,7 +1016,7 @@ EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs);
1016EAPI void ecore_con_socks_apply_once(Ecore_Con_Socks *ecs); 1016EAPI void ecore_con_socks_apply_once(Ecore_Con_Socks *ecs);
1017 1017
1018/** 1018/**
1019 * Set a proxy object to be used with all servers created with ecore_con_server_connect() 1019 * @brief Set a proxy object to be used with all servers created with ecore_con_server_connect()
1020 * 1020 *
1021 * This function sets a proxy for all ecore_con connections. It will always be used. 1021 * This function sets a proxy for all ecore_con connections. It will always be used.
1022 * @param ecs The proxy object 1022 * @param ecs The proxy object
@@ -1106,7 +1106,7 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
1106 */ 1106 */
1107 1107
1108/** 1108/**
1109 * Creates a server to listen for connections. 1109 * @brief Create a server to listen for connections.
1110 * 1110 *
1111 * @param type The connection type. 1111 * @param type The connection type.
1112 * @param name Name to associate with the socket. It is used when 1112 * @param name Name to associate with the socket. It is used when
@@ -1146,7 +1146,7 @@ EAPI Ecore_Con_Server *ecore_con_server_add(Ecore_Con_Type type,
1146 const void *data); 1146 const void *data);
1147 1147
1148/** 1148/**
1149 * Creates a connection to the specified server and returns an associated object. 1149 * @brief Create a connection to the specified server and return an associated object.
1150 * 1150 *
1151 * @param type The connection type. 1151 * @param type The connection type.
1152 * @param name Name used when determining what socket to connect to. 1152 * @param name Name used when determining what socket to connect to.
@@ -1192,7 +1192,7 @@ EAPI Ecore_Con_Server *ecore_con_server_connect(Ecore_Con_Type type,
1192 const char *name, int port, 1192 const char *name, int port,
1193 const void *data); 1193 const void *data);
1194/** 1194/**
1195 * Closes the connection and frees the given server. 1195 * @brief Close the connection and free the given server.
1196 * 1196 *
1197 * @param svr The given server. 1197 * @param svr The given server.
1198 * @return Data associated with the server when it was created. 1198 * @return Data associated with the server when it was created.
@@ -1204,7 +1204,7 @@ EAPI Ecore_Con_Server *ecore_con_server_connect(Ecore_Con_Type type,
1204EAPI void * ecore_con_server_del(Ecore_Con_Server *svr); 1204EAPI void * ecore_con_server_del(Ecore_Con_Server *svr);
1205 1205
1206/** 1206/**
1207 * Retrieves the data associated with the given server. 1207 * @brief Retrieve the data associated with the given server.
1208 * 1208 *
1209 * @param svr The given server. 1209 * @param svr The given server.
1210 * @return The associated data. 1210 * @return The associated data.
@@ -1213,7 +1213,7 @@ EAPI void * ecore_con_server_del(Ecore_Con_Server *svr);
1213 */ 1213 */
1214EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr); 1214EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr);
1215/** 1215/**
1216 * Sets the data associated with the given server. 1216 * @brief Set the data associated with the given server.
1217 * 1217 *
1218 * @param svr The given server. 1218 * @param svr The given server.
1219 * @param data The data to associate with @p svr 1219 * @param data The data to associate with @p svr
@@ -1224,7 +1224,7 @@ EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr);
1224EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr, 1224EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr,
1225 void *data); 1225 void *data);
1226/** 1226/**
1227 * Retrieves whether the given server is currently connected. 1227 * @brief Retrieve whether the given server is currently connected.
1228 * 1228 *
1229 * @param svr The given server. 1229 * @param svr The given server.
1230 * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise. 1230 * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
@@ -1232,7 +1232,7 @@ EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr,
1232EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *svr); 1232EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *svr);
1233 1233
1234/** 1234/**
1235 * Retrieves the server port in use. 1235 * @brief Retrieve the server port in use.
1236 * 1236 *
1237 * @param svr The given server. 1237 * @param svr The given server.
1238 * @return The server port in use. 1238 * @return The server port in use.
@@ -1252,7 +1252,7 @@ EAPI int ecore_con_server_port_get(const Ecore_Con_Server *svr);
1252 */ 1252 */
1253EAPI double ecore_con_server_uptime_get(const Ecore_Con_Server *svr); 1253EAPI double ecore_con_server_uptime_get(const Ecore_Con_Server *svr);
1254/** 1254/**
1255 * Sends the given data to the given server. 1255 * @brief Send the given data to the given server.
1256 * 1256 *
1257 * @param svr The given server. 1257 * @param svr The given server.
1258 * @param data The given data. 1258 * @param data The given data.
@@ -1272,7 +1272,7 @@ EAPI int ecore_con_server_send(Ecore_Con_Server *svr,
1272 const void *data, 1272 const void *data,
1273 int size); 1273 int size);
1274/** 1274/**
1275 * Sets a limit on the number of clients that can be handled concurrently 1275 * @brief Set a limit on the number of clients that can be handled concurrently
1276 * by the given server, and a policy on what to do if excess clients try to 1276 * by the given server, and a policy on what to do if excess clients try to
1277 * connect. 1277 * connect.
1278 * 1278 *
@@ -1298,7 +1298,7 @@ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr,
1298 int client_limit, 1298 int client_limit,
1299 char reject_excess_clients); 1299 char reject_excess_clients);
1300/** 1300/**
1301 * Gets the IP address of a server that has been connected to. 1301 * @brief Get the IP address of a server that has been connected to.
1302 * 1302 *
1303 * @param svr The given server. 1303 * @param svr The given server.
1304 * @return A pointer to an internal string that contains the IP address of 1304 * @return A pointer to an internal string that contains the IP address of
@@ -1309,7 +1309,7 @@ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr,
1309 */ 1309 */
1310EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr); 1310EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr);
1311/** 1311/**
1312 * Flushes all pending data to the given server. 1312 * @brief Flush all pending data to the given server.
1313 * 1313 *
1314 * @param svr The given server. 1314 * @param svr The given server.
1315 * 1315 *
@@ -1320,7 +1320,7 @@ EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr);
1320 */ 1320 */
1321EAPI void ecore_con_server_flush(Ecore_Con_Server *svr); 1321EAPI void ecore_con_server_flush(Ecore_Con_Server *svr);
1322/** 1322/**
1323 * Set the default time after which an inactive client will be disconnected 1323 * @brief Set the default time after which an inactive client will be disconnected
1324 * 1324 *
1325 * @param svr The server object 1325 * @param svr The server object
1326 * @param timeout The timeout, in seconds, to disconnect after 1326 * @param timeout The timeout, in seconds, to disconnect after
@@ -1339,7 +1339,7 @@ EAPI void ecore_con_server_flush(Ecore_Con_Server *svr);
1339 */ 1339 */
1340EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, double timeout); 1340EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, double timeout);
1341/** 1341/**
1342 * Get the default time after which an inactive client will be disconnected 1342 * @brief Get the default time after which an inactive client will be disconnected
1343 * 1343 *
1344 * @param svr The server object 1344 * @param svr The server object
1345 * @return The timeout, in seconds, to disconnect after 1345 * @return The timeout, in seconds, to disconnect after
@@ -1353,7 +1353,7 @@ EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, doubl
1353EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr); 1353EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr);
1354 1354
1355/** 1355/**
1356 * Get the fd that the server is connected to 1356 * @brief Get the fd that the server is connected to
1357 * 1357 *
1358 * @param svr The server object 1358 * @param svr The server object
1359 * @return The fd, or -1 on failure 1359 * @return The fd, or -1 on failure
@@ -1367,7 +1367,7 @@ EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr)
1367EAPI int ecore_con_server_fd_get(const Ecore_Con_Server *svr); 1367EAPI int ecore_con_server_fd_get(const Ecore_Con_Server *svr);
1368 1368
1369/** 1369/**
1370 * Get the fd that the client is connected to 1370 * @brief Get the fd that the client is connected to
1371 * 1371 *
1372 * @param cl The client object 1372 * @param cl The client object
1373 * @return The fd, or -1 on failure 1373 * @return The fd, or -1 on failure
@@ -1402,7 +1402,7 @@ EAPI int ecore_con_client_fd_get(const Ecore_Con_Client *cl);
1402 */ 1402 */
1403 1403
1404/** 1404/**
1405 * Sends the given data to the given client. 1405 * @brief Send the given data to the given client.
1406 * 1406 *
1407 * @param cl The given client. 1407 * @param cl The given client.
1408 * @param data The given data. 1408 * @param data The given data.
@@ -1422,14 +1422,14 @@ EAPI int ecore_con_client_send(Ecore_Con_Client *cl,
1422 const void *data, 1422 const void *data,
1423 int size); 1423 int size);
1424/** 1424/**
1425 * Closes the connection and frees memory allocated to the given client. 1425 * @brief Close the connection and free memory allocated to the given client.
1426 * 1426 *
1427 * @param cl The given client. 1427 * @param cl The given client.
1428 * @return Data associated with the client. 1428 * @return Data associated with the client.
1429 */ 1429 */
1430EAPI void * ecore_con_client_del(Ecore_Con_Client *cl); 1430EAPI void * ecore_con_client_del(Ecore_Con_Client *cl);
1431/** 1431/**
1432 * Sets the data associated with the given client to @p data. 1432 * @brief Set the data associated with the given client to @p data.
1433 * 1433 *
1434 * @param cl The given client. 1434 * @param cl The given client.
1435 * @param data What to set the data to. 1435 * @param data What to set the data to.
@@ -1437,7 +1437,7 @@ EAPI void * ecore_con_client_del(Ecore_Con_Client *cl);
1437EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl, 1437EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl,
1438 const void *data); 1438 const void *data);
1439/** 1439/**
1440 * Retrieves the data associated with the given client. 1440 * @brief Retrieve the data associated with the given client.
1441 * 1441 *
1442 * @param cl The given client. 1442 * @param cl The given client.
1443 * @return The data associated with @p cl. 1443 * @return The data associated with @p cl.
@@ -1445,7 +1445,7 @@ EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl,
1445EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl); 1445EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl);
1446 1446
1447/** 1447/**
1448 * Gets the IP address of a client that has connected. 1448 * @brief Get the IP address of a client that has connected.
1449 * 1449 *
1450 * @param cl The given client. 1450 * @param cl The given client.
1451 * @return A pointer to an internal string that contains the IP address of 1451 * @return A pointer to an internal string that contains the IP address of
@@ -1456,7 +1456,7 @@ EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl);
1456 */ 1456 */
1457EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl); 1457EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl);
1458/** 1458/**
1459 * Flushes all pending data to the given client. 1459 * @brief Flush all pending data to the given client.
1460 * 1460 *
1461 * @param cl The given client. 1461 * @param cl The given client.
1462 * 1462 *
@@ -1477,7 +1477,7 @@ EAPI void ecore_con_client_flush(Ecore_Con_Client *cl);
1477 */ 1477 */
1478EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl); 1478EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl);
1479/** 1479/**
1480 * Get the default time after which the client will be disconnected when 1480 * @brief Get the default time after which the client will be disconnected when
1481 * inactive 1481 * inactive
1482 * 1482 *
1483 * @param cl The client object 1483 * @param cl The client object
@@ -1490,7 +1490,7 @@ EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl);
1490 */ 1490 */
1491EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl); 1491EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl);
1492/** 1492/**
1493 * Set the time after which the client will be disconnected when inactive 1493 * @brief Set the time after which the client will be disconnected when inactive
1494 * 1494 *
1495 * @param cl The client object 1495 * @param cl The client object
1496 * @param timeout The timeout, in seconds, to disconnect after 1496 * @param timeout The timeout, in seconds, to disconnect after
@@ -1510,7 +1510,7 @@ EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl);
1510 */ 1510 */
1511EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double timeout); 1511EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double timeout);
1512/** 1512/**
1513 * Returns whether the client is still connected 1513 * @brief Return whether the client is still connected
1514 * 1514 *
1515 * @param cl The given client. 1515 * @param cl The given client.
1516 * @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise. 1516 * @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise.
@@ -1643,7 +1643,7 @@ typedef enum _Ecore_Con_Url_Http_Version
1643} Ecore_Con_Url_Http_Version; 1643} Ecore_Con_Url_Http_Version;
1644 1644
1645/** 1645/**
1646 * Change the HTTP version used for the request 1646 * @brief Change the HTTP version used for the request
1647 * @param url_con Connection object through which the request will be sent. 1647 * @param url_con Connection object through which the request will be sent.
1648 * @param version The version to be used 1648 * @param version The version to be used
1649 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure to change version. 1649 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure to change version.
@@ -1653,7 +1653,7 @@ typedef enum _Ecore_Con_Url_Http_Version
1653EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ecore_Con_Url_Http_Version version); 1653EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ecore_Con_Url_Http_Version version);
1654 1654
1655/** 1655/**
1656 * Initialises the Ecore_Con_Url library. 1656 * @brief Initialise the Ecore_Con_Url library.
1657 * @return Number of times the library has been initialised without being 1657 * @return Number of times the library has been initialised without being
1658 * shut down. 1658 * shut down.
1659 * 1659 *
@@ -1663,7 +1663,7 @@ EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ec
1663EAPI int ecore_con_url_init(void); 1663EAPI int ecore_con_url_init(void);
1664 1664
1665/** 1665/**
1666 * Shuts down the Ecore_Con_Url library. 1666 * @brief Shut down the Ecore_Con_Url library.
1667 * @return Number of calls that still uses Ecore_Con_Url 1667 * @return Number of calls that still uses Ecore_Con_Url
1668 * 1668 *
1669 * @note This function doesn't call ecore_con_shutdown(). You still need to call 1669 * @note This function doesn't call ecore_con_shutdown(). You still need to call
@@ -1672,7 +1672,7 @@ EAPI int ecore_con_url_init(void);
1672EAPI int ecore_con_url_shutdown(void); 1672EAPI int ecore_con_url_shutdown(void);
1673 1673
1674/** 1674/**
1675 * Enable or disable HTTP 1.1 pipelining. 1675 * @brief Enable or disable HTTP 1.1 pipelining.
1676 * @param enable @c EINA_TRUE will turn it on, @c EINA_FALSE will disable it. 1676 * @param enable @c EINA_TRUE will turn it on, @c EINA_FALSE will disable it.
1677 * 1677 *
1678 * Pipelining allows to send one request after another one, without having to 1678 * Pipelining allows to send one request after another one, without having to
@@ -1688,7 +1688,7 @@ EAPI int ecore_con_url_shutdown(void);
1688 */ 1688 */
1689EAPI void ecore_con_url_pipeline_set(Eina_Bool enable); 1689EAPI void ecore_con_url_pipeline_set(Eina_Bool enable);
1690/** 1690/**
1691 * Is HTTP 1.1 pipelining enable ? 1691 * @brief Is HTTP 1.1 pipelining enable ?
1692 * @return @c EINA_TRUE if it is enable. 1692 * @return @c EINA_TRUE if it is enable.
1693 * 1693 *
1694 * @see ecore_con_url_pipeline_set() 1694 * @see ecore_con_url_pipeline_set()
@@ -1696,14 +1696,14 @@ EAPI void ecore_con_url_pipeline_set(Eina_Bool enable);
1696EAPI Eina_Bool ecore_con_url_pipeline_get(void); 1696EAPI Eina_Bool ecore_con_url_pipeline_get(void);
1697 1697
1698/** 1698/**
1699 * Creates and initializes a new Ecore_Con_Url connection object. 1699 * @brief Create and initialize a new Ecore_Con_Url connection object.
1700 * 1700 *
1701 * @param url URL that will receive requests. Can be changed using 1701 * @param url URL that will receive requests. Can be changed using
1702 * ecore_con_url_url_set. 1702 * ecore_con_url_url_set.
1703 * 1703 *
1704 * @return @c NULL on error, a new Ecore_Con_Url on success. 1704 * @return @c NULL on error, a new Ecore_Con_Url on success.
1705 * 1705 *
1706 * Creates and initializes a new Ecore_Con_Url connection object that can be 1706 * Create and initialize a new Ecore_Con_Url connection object that can be
1707 * used for sending requests. 1707 * used for sending requests.
1708 * 1708 *
1709 * @see ecore_con_url_custom_new() 1709 * @see ecore_con_url_custom_new()
@@ -1711,14 +1711,14 @@ EAPI Eina_Bool ecore_con_url_pipeline_get(void);
1711 */ 1711 */
1712EAPI Ecore_Con_Url * ecore_con_url_new(const char *url); 1712EAPI Ecore_Con_Url * ecore_con_url_new(const char *url);
1713/** 1713/**
1714 * Creates a custom connection object. 1714 * @brief Create a custom connection object.
1715 * 1715 *
1716 * @param url URL that will receive requests 1716 * @param url URL that will receive requests
1717 * @param custom_request Custom request (e.g. GET, POST, HEAD, PUT, etc) 1717 * @param custom_request Custom request (e.g. GET, POST, HEAD, PUT, etc)
1718 * 1718 *
1719 * @return @c NULL on error, a new Ecore_Con_Url on success. 1719 * @return @c NULL on error, a new Ecore_Con_Url on success.
1720 * 1720 *
1721 * Creates and initializes a new Ecore_Con_Url for a custom request (e.g. HEAD, 1721 * Create and initialize a new Ecore_Con_Url for a custom request (e.g. HEAD,
1722 * SUBSCRIBE and other obscure HTTP requests). This object should be used like 1722 * SUBSCRIBE and other obscure HTTP requests). This object should be used like
1723 * one created with ecore_con_url_new(). 1723 * one created with ecore_con_url_new().
1724 * 1724 *
@@ -1728,7 +1728,7 @@ EAPI Ecore_Con_Url * ecore_con_url_new(const char *url);
1728EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url, 1728EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url,
1729 const char *custom_request); 1729 const char *custom_request);
1730/** 1730/**
1731 * Destroys a Ecore_Con_Url connection object. 1731 * @brief Destroy a Ecore_Con_Url connection object.
1732 * 1732 *
1733 * @param url_con Connection object to free. 1733 * @param url_con Connection object to free.
1734 * 1734 *
@@ -1737,12 +1737,12 @@ EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url,
1737EAPI void ecore_con_url_free(Ecore_Con_Url *url_con); 1737EAPI void ecore_con_url_free(Ecore_Con_Url *url_con);
1738 1738
1739/** 1739/**
1740 * Associates data with a connection object. 1740 * @brief Associate data with a connection object.
1741 * 1741 *
1742 * @param url_con Connection object to associate data. 1742 * @param url_con Connection object to associate data.
1743 * @param data Data to be set. 1743 * @param data Data to be set.
1744 * 1744 *
1745 * Associates data with a connection object, which can be retrieved later with 1745 * Associate data with a connection object, which can be retrieved later with
1746 * ecore_con_url_data_get()). 1746 * ecore_con_url_data_get()).
1747 * 1747 *
1748 * @see ecore_con_url_data_get() 1748 * @see ecore_con_url_data_get()
@@ -1750,26 +1750,26 @@ EAPI void ecore_con_url_free(Ecore_Con_Url *url_con);
1750EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con, 1750EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con,
1751 void *data); 1751 void *data);
1752/** 1752/**
1753 * Retrieves data associated with a Ecore_Con_Url connection object. 1753 * @brief Retrieve data associated with a Ecore_Con_Url connection object.
1754 * 1754 *
1755 * @param url_con Connection object to retrieve data from. 1755 * @param url_con Connection object to retrieve data from.
1756 * 1756 *
1757 * @return Data associated with the given object. 1757 * @return Data associated with the given object.
1758 * 1758 *
1759 * Retrieves data associated with a Ecore_Con_Url connection object (previously 1759 * Retrieve data associated with a Ecore_Con_Url connection object (previously
1760 * set with ecore_con_url_data_set()). 1760 * set with ecore_con_url_data_set()).
1761 * 1761 *
1762 * @see ecore_con_url_data_set() 1762 * @see ecore_con_url_data_set()
1763 */ 1763 */
1764EAPI void * ecore_con_url_data_get(Ecore_Con_Url *url_con); 1764EAPI void * ecore_con_url_data_get(Ecore_Con_Url *url_con);
1765/** 1765/**
1766 * Adds an additional header to the request connection object. 1766 * @brief Add an additional header to the request connection object.
1767 * 1767 *
1768 * @param url_con Connection object 1768 * @param url_con Connection object
1769 * @param key Header key 1769 * @param key Header key
1770 * @param value Header value 1770 * @param value Header value
1771 * 1771 *
1772 * Adds an additional header (User-Agent, Content-Type, etc.) to the request 1772 * Add an additional header (User-Agent, Content-Type, etc.) to the request
1773 * connection object. This addition will be valid for only one 1773 * connection object. This addition will be valid for only one
1774 * ecore_con_url_get() or ecore_con_url_post() call. 1774 * ecore_con_url_get() or ecore_con_url_post() call.
1775 * 1775 *
@@ -1783,11 +1783,11 @@ EAPI void ecore_con_url_additional_header_add(Ecore_Con_Url *url_co
1783 const char *key, 1783 const char *key,
1784 const char *value); 1784 const char *value);
1785/** 1785/**
1786 * Cleans additional headers. 1786 * @brief Clean additional headers.
1787 * 1787 *
1788 * @param url_con Connection object to clean additional headers. 1788 * @param url_con Connection object to clean additional headers.
1789 * 1789 *
1790 * Cleans additional headers associated with a connection object (previously 1790 * Clean additional headers associated with a connection object (previously
1791 * added with ecore_con_url_additional_header_add()). 1791 * added with ecore_con_url_additional_header_add()).
1792 * 1792 *
1793 * @see ecore_con_url_additional_header_add() 1793 * @see ecore_con_url_additional_header_add()
@@ -1796,11 +1796,11 @@ EAPI void ecore_con_url_additional_header_add(Ecore_Con_Url *url_co
1796 */ 1796 */
1797EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url_con); 1797EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url_con);
1798/** 1798/**
1799 * Retrieves headers from last request sent. 1799 * @brief Retrieve headers from last request sent.
1800 * 1800 *
1801 * @param url_con Connection object to retrieve response headers from. 1801 * @param url_con Connection object to retrieve response headers from.
1802 * 1802 *
1803 * Retrieves a list containing the response headers. This function should be 1803 * Retrieve a list containing the response headers. This function should be
1804 * used after an ECORE_CON_EVENT_URL_COMPLETE event (headers should normally be 1804 * used after an ECORE_CON_EVENT_URL_COMPLETE event (headers should normally be
1805 * ready at that time). 1805 * ready at that time).
1806 * 1806 *
@@ -1808,13 +1808,13 @@ EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url
1808 */ 1808 */
1809EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con); 1809EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con);
1810/** 1810/**
1811 * Setup a file for receiving response data. 1811 * @brief Set up a file for receiving response data.
1812 * 1812 *
1813 * @param url_con Connection object to set file 1813 * @param url_con Connection object to set file
1814 * @param fd File descriptor associated with the file. A negative value will 1814 * @param fd File descriptor associated with the file. A negative value will
1815 * unset any previously set fd. 1815 * unset any previously set fd.
1816 * 1816 *
1817 * Sets up a file to have response data written into. Note that 1817 * Set up a file to have response data written into. Note that
1818 * ECORE_CON_EVENT_URL_DATA events will not be emitted if a file has been set to 1818 * ECORE_CON_EVENT_URL_DATA events will not be emitted if a file has been set to
1819 * receive the response data. 1819 * receive the response data.
1820 * 1820 *
@@ -1823,9 +1823,9 @@ EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con
1823 */ 1823 */
1824EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd); 1824EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd);
1825/** 1825/**
1826 * Retrieves the number of bytes received. 1826 * @brief Retrieve the number of bytes received.
1827 * 1827 *
1828 * Retrieves the number of bytes received on the last request of the given 1828 * Retrieve the number of bytes received on the last request of the given
1829 * connection object. 1829 * connection object.
1830 * 1830 *
1831 * @param url_con Connection object which the request was sent on. 1831 * @param url_con Connection object which the request was sent on.
@@ -1837,7 +1837,7 @@ EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd);
1837 */ 1837 */
1838EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con); 1838EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con);
1839/** 1839/**
1840 * Sets url_con to use http auth, with given username and password, "safely" or not. 1840 * @brief Set url_con to use http auth, with given username and password, "safely" or not.
1841 * 1841 *
1842 * @param url_con Connection object to perform a request on, previously created 1842 * @param url_con Connection object to perform a request on, previously created
1843 * with ecore_con_url_new() or ecore_con_url_custom_new(). 1843 * with ecore_con_url_new() or ecore_con_url_custom_new().
@@ -1847,7 +1847,7 @@ EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con);
1847 * 1847 *
1848 * @return @c EINA_TRUE on success, @c EINA_FALSE on error. 1848 * @return @c EINA_TRUE on success, @c EINA_FALSE on error.
1849 * 1849 *
1850 * @attention Requires libcurl >= 7.19.1 to work, otherwise will always return 1850 * @attention Require libcurl >= 7.19.1 to work, otherwise will always return
1851 * @c 0. 1851 * @c 0.
1852 */ 1852 */
1853EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con, 1853EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
@@ -1855,7 +1855,7 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
1855 const char *password, 1855 const char *password,
1856 Eina_Bool safe); 1856 Eina_Bool safe);
1857/** 1857/**
1858 * Sends a get request. 1858 * @brief Send a get request.
1859 * 1859 *
1860 * @param url_con Connection object to perform a request on, previously created 1860 * @param url_con Connection object to perform a request on, previously created
1861 * 1861 *
@@ -1876,7 +1876,7 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
1876 */ 1876 */
1877EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con); 1877EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con);
1878/** 1878/**
1879 * Sends a HEAD request. 1879 * @brief Send a HEAD request.
1880 * 1880 *
1881 * @param url_con Connection object to perform a request on, previously created 1881 * @param url_con Connection object to perform a request on, previously created
1882 * 1882 *
@@ -1896,7 +1896,7 @@ EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con);
1896 */ 1896 */
1897EAPI Eina_Bool ecore_con_url_head(Ecore_Con_Url *url_con); 1897EAPI Eina_Bool ecore_con_url_head(Ecore_Con_Url *url_con);
1898/** 1898/**
1899 * Sends a post request. 1899 * @brief Send a post request.
1900 * 1900 *
1901 * @param url_con Connection object to perform a request on, previously created 1901 * @param url_con Connection object to perform a request on, previously created
1902 * with ecore_con_url_new() or ecore_con_url_custom_new(). 1902 * with ecore_con_url_new() or ecore_con_url_custom_new().
@@ -1927,7 +1927,7 @@ EAPI Eina_Bool ecore_con_url_post(Ecore_Con_Url *url_con,
1927 const void *data, long length, 1927 const void *data, long length,
1928 const char *content_type); 1928 const char *content_type);
1929/** 1929/**
1930 * Sets whether HTTP requests should be conditional, dependent on 1930 * @brief Set whether HTTP requests should be conditional, dependent on
1931 * modification time. 1931 * modification time.
1932 * 1932 *
1933 * @param url_con Ecore_Con_Url to act upon. 1933 * @param url_con Ecore_Con_Url to act upon.
@@ -1946,7 +1946,7 @@ EAPI void ecore_con_url_time(Ecore_Con_Url *url_con,
1946 double timestamp); 1946 double timestamp);
1947 1947
1948/** 1948/**
1949 * @brief Uploads a file to an ftp site. 1949 * @brief Upload a file to an ftp site.
1950 * 1950 *
1951 * @param url_con The Ecore_Con_Url object to send with 1951 * @param url_con The Ecore_Con_Url object to send with
1952 * @param filename The path to the file to send 1952 * @param filename The path to the file to send
@@ -1964,7 +1964,7 @@ EAPI Eina_Bool ecore_con_url_ftp_upload(Ecore_Con_Url *url_con,
1964 const char *pass, 1964 const char *pass,
1965 const char *upload_dir); 1965 const char *upload_dir);
1966/** 1966/**
1967 * Toggle libcurl's verbose output. 1967 * @brief Toggle libcurl's verbose output.
1968 * 1968 *
1969 * @param url_con Ecore_Con_Url instance which will be acted upon. 1969 * @param url_con Ecore_Con_Url instance which will be acted upon.
1970 * @param verbose Whether or not to enable libcurl's verbose output. 1970 * @param verbose Whether or not to enable libcurl's verbose output.
@@ -1976,7 +1976,7 @@ EAPI Eina_Bool ecore_con_url_ftp_upload(Ecore_Con_Url *url_con,
1976EAPI void ecore_con_url_verbose_set(Ecore_Con_Url *url_con, 1976EAPI void ecore_con_url_verbose_set(Ecore_Con_Url *url_con,
1977 Eina_Bool verbose); 1977 Eina_Bool verbose);
1978/** 1978/**
1979 * Enable or disable EPSV extension 1979 * @brief Enable or disable EPSV extension
1980 * @param url_con The Ecore_Con_Url instance which will be acted upon. 1980 * @param url_con The Ecore_Con_Url instance which will be acted upon.
1981 * @param use_epsv Boolean to enable/disable the EPSV extension. 1981 * @param use_epsv Boolean to enable/disable the EPSV extension.
1982 */ 1982 */
@@ -1984,7 +1984,7 @@ EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con,
1984 Eina_Bool use_epsv); 1984 Eina_Bool use_epsv);
1985 1985
1986/** 1986/**
1987 * Enables the cookie engine for subsequent HTTP requests. 1987 * @brief Enable the cookie engine for subsequent HTTP requests.
1988 * 1988 *
1989 * @param url_con Ecore_Con_Url instance which will be acted upon. 1989 * @param url_con Ecore_Con_Url instance which will be acted upon.
1990 * 1990 *
@@ -1997,7 +1997,7 @@ EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con,
1997 */ 1997 */
1998EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con); 1998EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con);
1999/** 1999/**
2000 * Controls whether session cookies from previous sessions shall be loaded. 2000 * @brief Control whether session cookies from previous sessions shall be loaded.
2001 * 2001 *
2002 * @param url_con Ecore_Con_Url instance which will be acted upon. 2002 * @param url_con Ecore_Con_Url instance which will be acted upon.
2003 * @param ignore If @c EINA_TRUE, ignore session cookies when loading cookies 2003 * @param ignore If @c EINA_TRUE, ignore session cookies when loading cookies
@@ -2019,7 +2019,7 @@ EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con);
2019EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Url *url_con, 2019EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Url *url_con,
2020 Eina_Bool ignore); 2020 Eina_Bool ignore);
2021/** 2021/**
2022 * Clears currently loaded cookies. 2022 * @brief Clear currently loaded cookies.
2023 * @param url_con Ecore_Con_Url instance which will be acted upon. 2023 * @param url_con Ecore_Con_Url instance which will be acted upon.
2024 * 2024 *
2025 * The cleared cookies are removed and will not be sent in subsequent HTTP 2025 * The cleared cookies are removed and will not be sent in subsequent HTTP
@@ -2042,7 +2042,7 @@ EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Ur
2042 */ 2042 */
2043EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con); 2043EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con);
2044/** 2044/**
2045 * Clears currently loaded session cookies. 2045 * @brief Clear currently loaded session cookies.
2046 * 2046 *
2047 * @param url_con Ecore_Con_Url instance which will be acted upon. 2047 * @param url_con Ecore_Con_Url instance which will be acted upon.
2048 * 2048 *
@@ -2071,7 +2071,7 @@ EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con);
2071 */ 2071 */
2072EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_con); 2072EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_con);
2073/** 2073/**
2074 * Adds a file to the list of files from which to load cookies. 2074 * @brief Add a file to the list of files from which to load cookies.
2075 * 2075 *
2076 * @param url_con Ecore_Con_Url instance which will be acted upon. 2076 * @param url_con Ecore_Con_Url instance which will be acted upon.
2077 * @param file_name Name of the file that will be added to the list. 2077 * @param file_name Name of the file that will be added to the list.
@@ -2099,7 +2099,7 @@ EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_co
2099EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con, 2099EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con,
2100 const char * const file_name); 2100 const char * const file_name);
2101/** 2101/**
2102 * Sets the name of the file to which all current cookies will be written when 2102 * @brief Set the name of the file to which all current cookies will be written when
2103 * either cookies are flushed or Ecore_Con is shut down. 2103 * either cookies are flushed or Ecore_Con is shut down.
2104 * 2104 *
2105 * @param url_con Ecore_Con_Url instance which will be acted upon. 2105 * @param url_con Ecore_Con_Url instance which will be acted upon.
@@ -2122,7 +2122,7 @@ EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con,
2122EAPI Eina_Bool ecore_con_url_cookies_jar_file_set(Ecore_Con_Url *url_con, 2122EAPI Eina_Bool ecore_con_url_cookies_jar_file_set(Ecore_Con_Url *url_con,
2123 const char * const cookiejar_file); 2123 const char * const cookiejar_file);
2124/** 2124/**
2125 * Writes all current cookies to the cookie jar immediately. 2125 * @brief Write all current cookies to the cookie jar immediately.
2126 * 2126 *
2127 * @param url_con Ecore_Con_Url instance which will be acted upon. 2127 * @param url_con Ecore_Con_Url instance which will be acted upon.
2128 * 2128 *
@@ -2142,7 +2142,7 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con,
2142 const char *ca_path); 2142 const char *ca_path);
2143 2143
2144/** 2144/**
2145 * Set HTTP proxy to use. 2145 * @brief Set HTTP proxy to use.
2146 * 2146 *
2147 * The parameter should be a char * to a zero terminated string holding 2147 * The parameter should be a char * to a zero terminated string holding
2148 * the host name or dotted IP address. To specify port number in this string, 2148 * the host name or dotted IP address. To specify port number in this string,
@@ -2161,9 +2161,9 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con,
2161EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy); 2161EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy);
2162 2162
2163/** 2163/**
2164 * Set zero terminated username to use for proxy. 2164 * @brief Set zero terminated username to use for proxy.
2165 * 2165 *
2166 * if socks protocol is used for proxy, protocol should be socks5 and above. 2166 * If socks protocol is used for proxy, protocol should be socks5 and above.
2167 * 2167 *
2168 * @param url_con Connection object that will use the proxy. 2168 * @param url_con Connection object that will use the proxy.
2169 * @param username Username string. 2169 * @param username Username string.
@@ -2177,9 +2177,9 @@ EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy
2177EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const char *username); 2177EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const char *username);
2178 2178
2179/** 2179/**
2180 * Set zero terminated password to use for proxy. 2180 * @brief Set zero terminated password to use for proxy.
2181 * 2181 *
2182 * if socks protocol is used for proxy, protocol should be socks5 and above. 2182 * If socks protocol is used for proxy, protocol should be socks5 and above.
2183 * 2183 *
2184 * @param url_con Connection object that will use the proxy. 2184 * @param url_con Connection object that will use the proxy.
2185 * @param password Password string. 2185 * @param password Password string.
@@ -2193,9 +2193,9 @@ EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const ch
2193EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const char *password); 2193EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const char *password);
2194 2194
2195/** 2195/**
2196 * Set timeout in seconds. 2196 * @brief Set timeout in seconds.
2197 * 2197 *
2198 * the maximum time in seconds that you allow the ecore con url transfer 2198 * The maximum time in seconds that you allow the ecore con url transfer
2199 * operation to take. Normally, name lookups can take a considerable time 2199 * operation to take. Normally, name lookups can take a considerable time
2200 * and limiting operations to less than a few minutes risk aborting perfectly 2200 * and limiting operations to less than a few minutes risk aborting perfectly
2201 * normal operations. 2201 * normal operations.
@@ -2210,7 +2210,7 @@ EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const ch
2210EAPI void ecore_con_url_timeout_set(Ecore_Con_Url *url_con, double timeout); 2210EAPI void ecore_con_url_timeout_set(Ecore_Con_Url *url_con, double timeout);
2211 2211
2212/** 2212/**
2213 * Get the returned HTTP STATUS code 2213 * @brief Get the returned HTTP STATUS code
2214 * 2214 *
2215 * This is used to, at any time, try to return the status code for a transmission. 2215 * This is used to, at any time, try to return the status code for a transmission.
2216 * @param url_con Connection object 2216 * @param url_con Connection object