Functions to communicate with and/or set options on a client. More...
Typedefs | |
typedef struct _Ecore_Con_Client | Ecore_Con_Client |
A connection handle to a client. |
Functions | |
EAPI int | ecore_con_client_send (Ecore_Con_Client *cl, const void *data, int size) |
Sends the given data to the given client. | |
EAPI Ecore_Con_Server * | ecore_con_client_server_get (Ecore_Con_Client *cl) |
Retrieves the server representing the socket the client has connected to. | |
EAPI Eina_Bool | ecore_con_client_connected_get (Ecore_Con_Client *cl) |
Returns whether the client is still connected. | |
EAPI void | ecore_con_client_timeout_set (Ecore_Con_Client *cl, double timeout) |
Set the time after which the client will be disconnected when inactive. | |
EAPI double | ecore_con_client_timeout_get (Ecore_Con_Client *cl) |
Get the default time after which the client will be disconnected when inactive. | |
EAPI void * | ecore_con_client_del (Ecore_Con_Client *cl) |
Closes the connection and frees memory allocated to the given client. | |
EAPI void | ecore_con_client_data_set (Ecore_Con_Client *cl, const void *data) |
Sets the data associated with the given client to data . | |
EAPI void * | ecore_con_client_data_get (Ecore_Con_Client *cl) |
Retrieves the data associated with the given client. | |
EAPI const char * | ecore_con_client_ip_get (Ecore_Con_Client *cl) |
Gets the IP address of a client that has connected. | |
EAPI int | ecore_con_client_port_get (Ecore_Con_Client *cl) |
Return the port that the client has connected to. | |
EAPI double | ecore_con_client_uptime_get (Ecore_Con_Client *cl) |
Check how long a client has been connected. | |
EAPI void | ecore_con_client_flush (Ecore_Con_Client *cl) |
Flushes all pending data to the given client. | |
EAPI int | ecore_con_server_fd_get (Ecore_Con_Server *svr) |
Get the fd that the server is connected to. | |
EAPI int | ecore_con_client_fd_get (Ecore_Con_Client *cl) |
Get the fd that the client is connected to. | |
EAPI int | ecore_con_ssl_available_get (void) |
Returns if SSL support is available. | |
EAPI int | ecore_ipc_ssl_available_get (void) |
Returns if SSL support is available. |
Detailed Description
Functions to communicate with and/or set options on a client.
Functions that operate on Ecore connection client objects.
This set of functions, as explained in Ecore Connection Server Functions, is used to send data to a client, or to set options and get information about this client. Most of them should be used on the server, applied on the client object.
If you need to implement a client, the way to connect to a server is described in Ecore Connection Server Functions.
An example of usage of these functions can be found at:
Function Documentation
EAPI Eina_Bool ecore_con_client_connected_get | ( | Ecore_Con_Client * | cl | ) |
Returns whether the client is still connected.
- Parameters
-
cl The given client.
- Returns
EINA_TRUE
if connected,EINA_FALSE
otherwise.
- Examples:
- ecore_con_server_simple_example.c.
EAPI void * ecore_con_client_data_get | ( | Ecore_Con_Client * | cl | ) |
Retrieves the data associated with the given client.
- Parameters
-
cl The given client.
- Returns
- The data associated with
cl
.
- Examples:
- ecore_con_server_simple_example.c.
EAPI void ecore_con_client_data_set | ( | Ecore_Con_Client * | cl, |
const void * | data | ||
) |
Sets the data associated with the given client to data
.
- Parameters
-
cl The given client. data What to set the data to.
- Examples:
- ecore_con_server_simple_example.c.
EAPI void * ecore_con_client_del | ( | Ecore_Con_Client * | cl | ) |
Closes the connection and frees memory allocated to the given client.
- Parameters
-
cl The given client.
- Returns
- Data associated with the client.
- Examples:
- ecore_con_server_simple_example.c.
Referenced by ecore_ipc_client_del().
EAPI int ecore_con_client_fd_get | ( | Ecore_Con_Client * | cl | ) |
Get the fd that the client is connected to.
- Parameters
-
cl The client object
- Returns
- The fd, or -1 on failure
This function returns the fd which is used by the underlying client connection. It should not be tampered with unless you REALLY know what you are doing.
- Since
- 1.1
References ecore_main_fd_handler_fd_get().
EAPI void ecore_con_client_flush | ( | Ecore_Con_Client * | cl | ) |
Flushes all pending data to the given client.
- Parameters
-
cl The given client.
This function will block until all data is sent to the server.
- Examples:
- ecore_con_server_simple_example.c.
Referenced by ecore_ipc_client_flush().
EAPI const char * ecore_con_client_ip_get | ( | Ecore_Con_Client * | cl | ) |
Gets the IP address of a client that has connected.
- Parameters
-
cl The given client.
- Returns
- A pointer to an internal string that contains the IP address of the connected client in the form "XXX.YYY.ZZZ.AAA" IP notation.
The returned string should not be modified, freed or trusted to stay valid after deletion for the cl
object. If no IP is known NULL
is returned.
- Examples:
- ecore_con_server_example.c, and ecore_con_server_simple_example.c.
Referenced by ecore_ipc_client_ip_get().
EAPI int ecore_con_client_port_get | ( | Ecore_Con_Client * | cl | ) |
Return the port that the client has connected to.
- Parameters
-
cl The client
- Returns
- The port that
cl
has connected to, or -1 on error Use this function to return the port on which a given client has connected.
- Examples:
- ecore_con_server_simple_example.c.
EAPI int ecore_con_client_send | ( | Ecore_Con_Client * | cl, |
const void * | data, | ||
int | size | ||
) |
Sends the given data to the given client.
- Parameters
-
cl The given client. data The given data. size Length of the data, in bytes, to send.
- Returns
- The number of bytes sent.
0
will be returned if there is an error.
This function will send the given data to the client as soon as the program is back to the main loop. Thus, this function returns immediately (non-blocking). If the data needs to be sent now, call ecore_con_client_flush() after this one.
- Examples:
- ecore_con_server_example.c, and ecore_con_server_simple_example.c.
References ECORE_CON_REMOTE_CORK, ECORE_CON_REMOTE_UDP, ECORE_FD_READ, ECORE_FD_WRITE, and ecore_main_fd_handler_active_set().
Referenced by ecore_ipc_client_send().
EAPI Ecore_Con_Server * ecore_con_client_server_get | ( | Ecore_Con_Client * | cl | ) |
Retrieves the server representing the socket the client has connected to.
- Parameters
-
cl The given client.
- Returns
- The server that the client connected to.
- Examples:
- ecore_con_server_simple_example.c.
Referenced by ecore_ipc_client_del(), and ecore_ipc_client_server_get().
EAPI double ecore_con_client_timeout_get | ( | Ecore_Con_Client * | cl | ) |
Get the default time after which the client will be disconnected when inactive.
- Parameters
-
cl The client object
- Returns
- The timeout, in seconds, to disconnect after
This function is used to get the idle timeout for a client. A value of < 1 means the idle timeout is disabled.
- See Also
- ecore_con_client_timeout_set()
EAPI void ecore_con_client_timeout_set | ( | Ecore_Con_Client * | cl, |
double | timeout | ||
) |
Set the time after which the client will be disconnected when inactive.
- Parameters
-
cl The client object timeout The timeout, in seconds, to disconnect after
This function is used by the server to set the idle timeout on a specific client. If the client becomes idle for a time higher than this value, it will be disconnected. A value of < 1 disables the idle timeout.
This timeout is not affected by the one set by ecore_con_server_timeout_set(). A client will be disconnected whenever the client or the server timeout is reached. That means, the lower timeout value will be used for that client if ecore_con_server_timeout_set() is used on the server.
- Examples:
- ecore_con_server_example.c, and ecore_con_server_simple_example.c.
EAPI double ecore_con_client_uptime_get | ( | Ecore_Con_Client * | cl | ) |
Check how long a client has been connected.
- Parameters
-
cl The client to check
- Returns
- The total time, in seconds, that the client has been connected to the server
This function is used to find out how long a client has been connected for.
- Examples:
- ecore_con_server_simple_example.c.
References ecore_time_get().
EAPI int ecore_con_server_fd_get | ( | Ecore_Con_Server * | svr | ) |
Get the fd that the server is connected to.
- Parameters
-
svr The server object
- Returns
- The fd, or -1 on failure
This function returns the fd which is used by the underlying server connection. It should not be tampered with unless you REALLY know what you are doing.
- Note
- This function is only valid for servers created with ecore_con_server_connect()
- Warning
- Seriously. Don't use this unless you know what you are doing.
- Since
- 1.1
References ecore_main_fd_handler_fd_get().
EAPI int ecore_con_ssl_available_get | ( | void | ) |
Returns if SSL support is available.
- Returns
- 1 if SSL is available and provided by gnutls, 2 if provided by openssl, 0 if it is not available.
Referenced by ecore_ipc_ssl_available_get().
EAPI int ecore_ipc_ssl_available_get | ( | void | ) |
Returns if SSL support is available.
- Returns
- 1 if SSL is available, 0 if it is not.
References ecore_con_ssl_available_get().