Ecore_Con_Client_Group (3) - Linux Manuals

Ecore_Con_Client_Group: Functions that operate on Ecore connection client objects.

NAME

Ecore Connection Client Functions - Functions that operate on Ecore connection client objects.

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 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 char * ecore_con_client_ip_get (Ecore_Con_Client *cl)
Gets the IP address of a cleint that has connected.
EAPI void ecore_con_client_flush (Ecore_Con_Client *cl)
Flushes all pending data to the given client.
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 that operate on Ecore connection client objects.

Function Documentation

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.

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.

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.

References ecore_list_goto(), ecore_list_remove(), and ecore_main_fd_handler_del().

Referenced by ecore_ipc_client_del().

EAPI void ecore_con_client_flush (Ecore_Con_Client * cl)

Flushes all pending data to the given client.

Will return when done.

Parameters:

cl The given client.

Referenced by ecore_ipc_client_flush().

EAPI char* ecore_con_client_ip_get (Ecore_Con_Client * cl)

Gets the IP address of a cleint 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. This string should not be modified or trusted to stay valid after deletion for the cl object. If no IP is known NULL is returned.

Referenced by ecore_ipc_client_ip_get().

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.

References 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.

Referenced by ecore_ipc_client_del(), and ecore_ipc_client_server_get().

EAPI int ecore_con_ssl_available_get (void)

Returns if SSL support is available.

Returns:

1 if SSL is available, 0 if it is not.

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().

Author

Generated automatically by Doxygen for Ecore from the source code.