cedric pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=034bcbace53f075e7f1bce99d2b32f9c19a484e5
commit 034bcbace53f075e7f1bce99d2b32f9c19a484e5
Author: Srivardhan Hebbar <sri.heb...@samsung.com>
Date: Fri Mar 13 08:43:50 2015 +0100
ecore_con: move Socks API documentation to Ecore_Con.h
Summary:
Reviewers: cedric
Reviewed By: cedric
Subscribers: cedric
Differential Revision: https://phab.enlightenment.org/D2138
Signed-off-by: Cedric BAIL <ced...@osg.samsung.com>
---
src/lib/ecore_con/Ecore_Con.h | 184 ++++++++++++++++++++++++++++++++++++
src/lib/ecore_con/ecore_con_socks.c | 168 +-------------------------------
2 files changed, 186 insertions(+), 166 deletions(-)
diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h
index d000e83..fee1889 100644
--- a/src/lib/ecore_con/Ecore_Con.h
+++ b/src/lib/ecore_con/Ecore_Con.h
@@ -837,22 +837,206 @@ EAPI Eina_Bool
ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_
* @}
*/
+/**
+ * @defgroup Ecore_Con_Socks_Group Ecore Connection SOCKS functions
+ * @ingroup Ecore_Con_Group
+ * @{
+ */
+
+/**
+ * Add a SOCKS v4 proxy to the proxy list
+ *
+ * Use this to create (or return, if previously added) a SOCKS proxy
+ * object which can be used by any ecore_con servers.
+ * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
+ * @param port The port to connect to on the proxy
+ * @param username The username to use for the proxy (OPTIONAL)
+ * @return An allocated proxy object, or NULL on failure
+ * @note This object NEVER needs to be explicitly freed.
+ * @since 1.2
+ */
EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port,
const char *username);
+
+/**
+ * Find a SOCKS v4 proxy in the proxy list
+ *
+ * Use this to determine if a SOCKS proxy was previously added by checking
+ * the proxy list against the parameters given.
+ * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
+ * @param port The port to connect to on the proxy, or -1 to match the first
proxy with @p ip
+ * @param username The username used for the proxy (OPTIONAL)
+ * @return true only if a proxy exists matching the given params
+ * @note This function matches slightly more loosely than
ecore_con_socks4_remote_add(), and
+ * ecore_con_socks4_remote_add() should be used to return the actual object.
+ * @since 1.2
+ */
EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port,
const char *username);
+
+/**
+ * Remove a SOCKS v4 proxy from the proxy list and delete it
+ *
+ * Use this to remove a SOCKS proxy from the proxy list by checking
+ * the list against the parameters given. The proxy will then be deleted.
+ * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
+ * @param port The port to connect to on the proxy, or -1 to match the first
proxy with @p ip
+ * @param username The username used for the proxy (OPTIONAL)
+ * @note This function matches in the same way as
ecore_con_socks4_remote_exists().
+ * @warning Be aware that deleting a proxy which is being used WILL ruin your
life.
+ * @since 1.2
+ */
EAPI void ecore_con_socks4_remote_del(const char *ip, int port,
const char *username);
+
+/**
+ * Add a SOCKS v5 proxy to the proxy list
+ *
+ * Use this to create (or return, if previously added) a SOCKS proxy
+ * object which can be used by any ecore_con servers.
+ * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
+ * @param port The port to connect to on the proxy
+ * @param username The username to use for the proxy (OPTIONAL)
+ * @param password The password to use for the proxy (OPTIONAL)
+ * @return An allocated proxy object, or NULL on failure
+ * @note This object NEVER needs to be explicitly freed.
+ * @since 1.2
+ */
EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port,
const char *username, const char *password);
+
+/**
+ * Find a SOCKS v5 proxy in the proxy list
+ *
+ * Use this to determine if a SOCKS proxy was previously added by checking
+ * the proxy list against the parameters given.
+ * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
+ * @param port The port to connect to on the proxy, or -1 to match the first
proxy with @p ip
+ * @param username The username used for the proxy (OPTIONAL)
+ * @param password The password used for the proxy (OPTIONAL)
+ * @return true only if a proxy exists matching the given params
+ * @note This function matches slightly more loosely than
ecore_con_socks5_remote_add(), and
+ * ecore_con_socks5_remote_add() should be used to return the actual object.
+ * @since 1.2
+ */
EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port,
const char *username, const char *password);
+
+/**
+ * Remove a SOCKS v5 proxy from the proxy list and delete it
+ *
+ * Use this to remove a SOCKS proxy from the proxy list by checking
+ * the list against the parameters given. The proxy will then be deleted.
+ * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
+ * @param port The port to connect to on the proxy, or -1 to match the first
proxy with @p ip
+ * @param username The username used for the proxy (OPTIONAL)
+ * @param password The password used for the proxy (OPTIONAL)
+ * @note This function matches in the same way as
ecore_con_socks4_remote_exists().
+ * @warning Be aware that deleting a proxy which is being used WILL ruin your
life.
+ * @since 1.2
+ */
EAPI void ecore_con_socks5_remote_del(const char *ip, int port,
const char *username, const char *password);
+
+/**
+ * Set DNS lookup mode on an existing SOCKS proxy
+ *
+ * According to RFC, SOCKS v4 does not require that a proxy perform
+ * its own DNS lookups for addresses. SOCKS v4a specifies the protocol
+ * for this. SOCKS v5 allows DNS lookups.
+ * If you want to enable remote DNS lookup and are sure that your
+ * proxy supports it, use this function.
+ * @param ecs The proxy object
+ * @param enable If true, the proxy will perform the dns lookup
+ * @note By default, this setting is DISABLED.
+ * @since 1.2
+ */
EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs,
Eina_Bool enable);
+
+/**
+ * Get DNS lookup mode on an existing SOCKS proxy
+ *
+ * According to RFC, SOCKS v4 does not require that a proxy perform
+ * its own DNS lookups for addresses. SOCKS v4a specifies the protocol
+ * for this. SOCKS v5 allows DNS lookups.
+ * This function returns whether lookups are enabled on a proxy object.
+ * @param ecs The proxy object
+ * @return If true, the proxy will perform the dns lookup
+ * @note By default, this setting is DISABLED.
+ * @since 1.2
+ */
EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs);
+
+/**
+ * Enable bind mode on a SOCKS proxy
+ *
+ * Use this function to enable binding a remote port for use with a remote
server.
+ * For more information, see http://ufasoft.com/doc/socks4_protocol.htm
+ * @param ecs The proxy object
+ * @param is_bind If true, the connection established will be a port binding
+ * @warning Be aware that changing the operation mode of an active proxy may
result in undefined behavior
+ * @since 1.2
+ */
EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool
is_bind);
+
+/**
+ * Return bind mode of a SOCKS proxy
+ *
+ * Use this function to return bind mode of a proxy (binding a remote port for
use with a remote server).
+ * For more information, see http://ufasoft.com/doc/socks4_protocol.htm
+ * @param ecs The proxy object
+ * @return If true, the connection established will be a port binding
+ * @since 1.2
+ */
EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs);
+
+/**
+ * Return SOCKS version of a SOCKS proxy
+ *
+ * Use this function to return the SOCKS protocol version of a proxy
+ * @param ecs The proxy object
+ * @return 0 on error, else 4/5
+ * @since 1.2
+ */
EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs);
+
+/**
+ * Remove a SOCKS v4 proxy from the proxy list and delete it
+ *
+ * Use this to remove a SOCKS proxy from the proxy list by directly deleting
the object given.
+ * @param ecs The proxy object to delete
+ * @warning Be aware that deleting a proxy which is being used WILL ruin your
life.
+ * @since 1.2
+ */
EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs);
+
+/**
+ * Set a proxy object to be used with the next server created with
ecore_con_server_connect()
+ *
+ * This function sets a proxy for the next ecore_con connection. After the
next server is created,
+ * the proxy will NEVER be applied again unless explicitly enabled.
+ * @param ecs The proxy object
+ * @see ecore_con_socks_apply_always()
+ * @since 1.2
+ */
EAPI void ecore_con_socks_apply_once(Ecore_Con_Socks *ecs);
+
+/**
+ * Set a proxy object to be used with all servers created with
ecore_con_server_connect()
+ *
+ * This function sets a proxy for all ecore_con connections. It will always be
used.
+ * @param ecs The proxy object
+ * @see ecore_con_socks_apply_once()
+ * @since 1.2
+ * @note ecore-con supports setting this through environment variables like so:
+ * ECORE_CON_SOCKS_V4=[user@]server-port:lookup
+ * ECORE_CON_SOCKS_V5=[user@]server-port:lookup
+ * user is the OPTIONAL string that would be passed to the proxy as the
username
+ * server is the IP_ADDRESS of the proxy server
+ * port is the port to connect to on the proxy server
+ * lookup is 1 if the proxy should perform all DNS lookups, otherwise 0 or
omitted
+ */
EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
/**
+ * @}
+ */
+
+/**
* @defgroup Ecore_Con_Server_Group Ecore Connection Server Functions
* @ingroup Ecore_Con_Group
*
diff --git a/src/lib/ecore_con/ecore_con_socks.c
b/src/lib/ecore_con/ecore_con_socks.c
index a3ba58c..893804b 100644
--- a/src/lib/ecore_con/ecore_con_socks.c
+++ b/src/lib/ecore_con/ecore_con_socks.c
@@ -657,24 +657,10 @@ ecore_con_socks_init(void)
/////////////////////////////////////////////////////////////////////////////////////
-/**
- * @defgroup Ecore_Con_Socks_Group Ecore Connection SOCKS functions
- * @ingroup Ecore_Con_Group
- * @{
+/*
+ * General Socks API.
*/
-/**
- * Add a SOCKS v4 proxy to the proxy list
- *
- * Use this to create (or return, if previously added) a SOCKS proxy
- * object which can be used by any ecore_con servers.
- * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
- * @param port The port to connect to on the proxy
- * @param username The username to use for the proxy (OPTIONAL)
- * @return An allocated proxy object, or NULL on failure
- * @note This object NEVER needs to be explicitly freed.
- * @since 1.2
- */
EAPI Ecore_Con_Socks *
ecore_con_socks4_remote_add(const char *ip, int port, const char *username)
{
@@ -704,19 +690,6 @@ ecore_con_socks4_remote_add(const char *ip, int port,
const char *username)
return ecs;
}
-/**
- * Find a SOCKS v4 proxy in the proxy list
- *
- * Use this to determine if a SOCKS proxy was previously added by checking
- * the proxy list against the parameters given.
- * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
- * @param port The port to connect to on the proxy, or -1 to match the first
proxy with @p ip
- * @param username The username used for the proxy (OPTIONAL)
- * @return true only if a proxy exists matching the given params
- * @note This function matches slightly more loosely than
ecore_con_socks4_remote_add(), and
- * ecore_con_socks4_remote_add() should be used to return the actual object.
- * @since 1.2
- */
EAPI Eina_Bool
ecore_con_socks4_remote_exists(const char *ip, int port, const char *username)
{
@@ -725,18 +698,6 @@ ecore_con_socks4_remote_exists(const char *ip, int port,
const char *username)
return !!_ecore_con_socks_find(4, ip, port, username, username ?
strlen(username) : 0, NULL, 0);
}
-/**
- * Remove a SOCKS v4 proxy from the proxy list and delete it
- *
- * Use this to remove a SOCKS proxy from the proxy list by checking
- * the list against the parameters given. The proxy will then be deleted.
- * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
- * @param port The port to connect to on the proxy, or -1 to match the first
proxy with @p ip
- * @param username The username used for the proxy (OPTIONAL)
- * @note This function matches in the same way as
ecore_con_socks4_remote_exists().
- * @warning Be aware that deleting a proxy which is being used WILL ruin your
life.
- * @since 1.2
- */
EAPI void
ecore_con_socks4_remote_del(const char *ip, int port, const char *username)
{
@@ -751,19 +712,6 @@ ecore_con_socks4_remote_del(const char *ip, int port,
const char *username)
_ecore_con_socks_free((Ecore_Con_Socks *)v4);
}
-/**
- * Add a SOCKS v5 proxy to the proxy list
- *
- * Use this to create (or return, if previously added) a SOCKS proxy
- * object which can be used by any ecore_con servers.
- * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
- * @param port The port to connect to on the proxy
- * @param username The username to use for the proxy (OPTIONAL)
- * @param password The password to use for the proxy (OPTIONAL)
- * @return An allocated proxy object, or NULL on failure
- * @note This object NEVER needs to be explicitly freed.
- * @since 1.2
- */
EAPI Ecore_Con_Socks *
ecore_con_socks5_remote_add(const char *ip, int port, const char *username,
const char *password)
{
@@ -801,20 +749,6 @@ ecore_con_socks5_remote_add(const char *ip, int port,
const char *username, cons
return (Ecore_Con_Socks *)ecs5;
}
-/**
- * Find a SOCKS v5 proxy in the proxy list
- *
- * Use this to determine if a SOCKS proxy was previously added by checking
- * the proxy list against the parameters given.
- * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
- * @param port The port to connect to on the proxy, or -1 to match the first
proxy with @p ip
- * @param username The username used for the proxy (OPTIONAL)
- * @param password The password used for the proxy (OPTIONAL)
- * @return true only if a proxy exists matching the given params
- * @note This function matches slightly more loosely than
ecore_con_socks5_remote_add(), and
- * ecore_con_socks5_remote_add() should be used to return the actual object.
- * @since 1.2
- */
EAPI Eina_Bool
ecore_con_socks5_remote_exists(const char *ip, int port, const char *username,
const char *password)
{
@@ -823,19 +757,6 @@ ecore_con_socks5_remote_exists(const char *ip, int port,
const char *username, c
return !!_ecore_con_socks_find(5, ip, port, username, username ?
strlen(username) : 0, password, password ? strlen(password) : 0);
}
-/**
- * Remove a SOCKS v5 proxy from the proxy list and delete it
- *
- * Use this to remove a SOCKS proxy from the proxy list by checking
- * the list against the parameters given. The proxy will then be deleted.
- * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.)
- * @param port The port to connect to on the proxy, or -1 to match the first
proxy with @p ip
- * @param username The username used for the proxy (OPTIONAL)
- * @param password The password used for the proxy (OPTIONAL)
- * @note This function matches in the same way as
ecore_con_socks4_remote_exists().
- * @warning Be aware that deleting a proxy which is being used WILL ruin your
life.
- * @since 1.2
- */
EAPI void
ecore_con_socks5_remote_del(const char *ip, int port, const char *username,
const char *password)
{
@@ -851,19 +772,6 @@ ecore_con_socks5_remote_del(const char *ip, int port,
const char *username, cons
_ecore_con_socks_free((Ecore_Con_Socks *)v5);
}
-/**
- * Set DNS lookup mode on an existing SOCKS proxy
- *
- * According to RFC, SOCKS v4 does not require that a proxy perform
- * its own DNS lookups for addresses. SOCKS v4a specifies the protocol
- * for this. SOCKS v5 allows DNS lookups.
- * If you want to enable remote DNS lookup and are sure that your
- * proxy supports it, use this function.
- * @param ecs The proxy object
- * @param enable If true, the proxy will perform the dns lookup
- * @note By default, this setting is DISABLED.
- * @since 1.2
- */
EAPI void
ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool enable)
{
@@ -871,18 +779,6 @@ ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool
enable)
ecs->lookup = !!enable;
}
-/**
- * Get DNS lookup mode on an existing SOCKS proxy
- *
- * According to RFC, SOCKS v4 does not require that a proxy perform
- * its own DNS lookups for addresses. SOCKS v4a specifies the protocol
- * for this. SOCKS v5 allows DNS lookups.
- * This function returns whether lookups are enabled on a proxy object.
- * @param ecs The proxy object
- * @return If true, the proxy will perform the dns lookup
- * @note By default, this setting is DISABLED.
- * @since 1.2
- */
EAPI Eina_Bool
ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs)
{
@@ -890,16 +786,6 @@ ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs)
return ecs->lookup;
}
-/**
- * Enable bind mode on a SOCKS proxy
- *
- * Use this function to enable binding a remote port for use with a remote
server.
- * For more information, see http://ufasoft.com/doc/socks4_protocol.htm
- * @param ecs The proxy object
- * @param is_bind If true, the connection established will be a port binding
- * @warning Be aware that changing the operation mode of an active proxy may
result in undefined behavior
- * @since 1.2
- */
EAPI void
ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool is_bind)
{
@@ -908,15 +794,6 @@ ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool
is_bind)
ecs->bind = !!is_bind;
}
-/**
- * Return bind mode of a SOCKS proxy
- *
- * Use this function to return bind mode of a proxy (binding a remote port for
use with a remote server).
- * For more information, see http://ufasoft.com/doc/socks4_protocol.htm
- * @param ecs The proxy object
- * @return If true, the connection established will be a port binding
- * @since 1.2
- */
EAPI Eina_Bool
ecore_con_socks_bind_get(Ecore_Con_Socks *ecs)
{
@@ -925,14 +802,6 @@ ecore_con_socks_bind_get(Ecore_Con_Socks *ecs)
return ecs->bind;
}
-/**
- * Return SOCKS version of a SOCKS proxy
- *
- * Use this function to return the SOCKS protocol version of a proxy
- * @param ecs The proxy object
- * @return 0 on error, else 4/5
- * @since 1.2
- */
EAPI unsigned int
ecore_con_socks_version_get(Ecore_Con_Socks *ecs)
{
@@ -941,14 +810,6 @@ ecore_con_socks_version_get(Ecore_Con_Socks *ecs)
return ecs->version;
}
-/**
- * Remove a SOCKS v4 proxy from the proxy list and delete it
- *
- * Use this to remove a SOCKS proxy from the proxy list by directly deleting
the object given.
- * @param ecs The proxy object to delete
- * @warning Be aware that deleting a proxy which is being used WILL ruin your
life.
- * @since 1.2
- */
EAPI void
ecore_con_socks_remote_del(Ecore_Con_Socks *ecs)
{
@@ -959,40 +820,15 @@ ecore_con_socks_remote_del(Ecore_Con_Socks *ecs)
_ecore_con_socks_free(ecs);
}
-/**
- * Set a proxy object to be used with the next server created with
ecore_con_server_connect()
- *
- * This function sets a proxy for the next ecore_con connection. After the
next server is created,
- * the proxy will NEVER be applied again unless explicitly enabled.
- * @param ecs The proxy object
- * @see ecore_con_socks_apply_always()
- * @since 1.2
- */
EAPI void
ecore_con_socks_apply_once(Ecore_Con_Socks *ecs)
{
_ecore_con_proxy_once = ecs;
}
-/**
- * Set a proxy object to be used with all servers created with
ecore_con_server_connect()
- *
- * This function sets a proxy for all ecore_con connections. It will always be
used.
- * @param ecs The proxy object
- * @see ecore_con_socks_apply_once()
- * @since 1.2
- * @note ecore-con supports setting this through environment variables like so:
- * ECORE_CON_SOCKS_V4=[user@]server-port:lookup
- * ECORE_CON_SOCKS_V5=[user@]server-port:lookup
- * user is the OPTIONAL string that would be passed to the proxy as the
username
- * server is the IP_ADDRESS of the proxy server
- * port is the port to connect to on the proxy server
- * lookup is 1 if the proxy should perform all DNS lookups, otherwise 0 or
omitted
- */
EAPI void
ecore_con_socks_apply_always(Ecore_Con_Socks *ecs)
{
_ecore_con_proxy_global = ecs;
}
-/** @} */
--
