Ecore inter-process communication functions. More...
Typedefs | |
typedef struct _Ecore_Ipc_Server | Ecore_Ipc_Server |
An IPC connection handle. | |
typedef struct _Ecore_Ipc_Client | Ecore_Ipc_Client |
An IPC connection handle. | |
Functions | |
EAPI int | ecore_ipc_init (void) |
Initialises the Ecore IPC library. | |
EAPI int | ecore_ipc_shutdown (void) |
Shuts down the Ecore IPC library. | |
EAPI Ecore_Ipc_Server * | ecore_ipc_server_add (Ecore_Ipc_Type type, const char *name, int port, const void *data) |
Creates an IPC server that listens for connections. | |
EAPI Ecore_Ipc_Server * | ecore_ipc_server_connect (Ecore_Ipc_Type type, char *name, int port, const void *data) |
Creates an IPC server object to represent the IPC server listening on the given port. | |
EAPI void * | ecore_ipc_server_del (Ecore_Ipc_Server *svr) |
Closes the connection and frees the given IPC server. | |
EAPI void * | ecore_ipc_server_data_get (Ecore_Ipc_Server *svr) |
Retrieves the data associated with the given IPC server. | |
EAPI Eina_Bool | ecore_ipc_server_connected_get (Ecore_Ipc_Server *svr) |
Retrieves whether the given IPC server is currently connected. | |
EAPI Eina_List * | ecore_ipc_server_clients_get (Ecore_Ipc_Server *svr) |
Retrieves the list of clients for this server. | |
EAPI int | ecore_ipc_server_send (Ecore_Ipc_Server *svr, int major, int minor, int ref, int ref_to, int response, const void *data, int size) |
Sends a message to the given IPC server. | |
EAPI void | ecore_ipc_server_client_limit_set (Ecore_Ipc_Server *svr, int client_limit, char reject_excess_clients) |
Sets a limit on the number of clients that can be handled concurrently by the given server, and a policy on what to do if excess clients try to connect. | |
EAPI void | ecore_ipc_server_data_size_max_set (Ecore_Ipc_Server *srv, int size) |
Sets the max data payload size for an Ipc message in bytes. | |
EAPI int | ecore_ipc_server_data_size_max_get (Ecore_Ipc_Server *srv) |
Gets the max data payload size for an Ipc message in bytes. | |
EAPI const char * | ecore_ipc_server_ip_get (Ecore_Ipc_Server *svr) |
Gets the IP address of a server that has been connected to. | |
EAPI void | ecore_ipc_server_flush (Ecore_Ipc_Server *svr) |
Flushes all pending data to the given server. | |
EAPI int | ecore_ipc_client_send (Ecore_Ipc_Client *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size) |
Sends a message to the given IPC client. | |
EAPI Ecore_Ipc_Server * | ecore_ipc_client_server_get (Ecore_Ipc_Client *cl) |
Retrieves the IPC server that the given IPC client is connected to. | |
EAPI void * | ecore_ipc_client_del (Ecore_Ipc_Client *cl) |
Closes the connection and frees memory allocated to the given IPC client. | |
EAPI void | ecore_ipc_client_data_set (Ecore_Ipc_Client *cl, const void *data) |
Sets the IPC data associated with the given IPC client to data . | |
EAPI void * | ecore_ipc_client_data_get (Ecore_Ipc_Client *cl) |
Retrieves the data that has been associated with the given IPC client. | |
EAPI void | ecore_ipc_client_data_size_max_set (Ecore_Ipc_Client *cl, int size) |
Sets the max data payload size for an Ipc message in bytes. | |
EAPI int | ecore_ipc_client_data_size_max_get (Ecore_Ipc_Client *cl) |
Gets the max data payload size for an Ipc message in bytes. | |
EAPI const char * | ecore_ipc_client_ip_get (Ecore_Ipc_Client *cl) |
Gets the IP address of a client that has been connected to. | |
EAPI void | ecore_ipc_client_flush (Ecore_Ipc_Client *cl) |
Flushes all pending data to the given client. | |
EAPI int | ecore_ipc_ssl_available_get (void) |
Returns if SSL support is available. |
Detailed Description
Ecore inter-process communication functions.
Function Documentation
EAPI int ecore_ipc_client_data_size_max_get | ( | Ecore_Ipc_Client * | cl | ) |
Gets the max data payload size for an Ipc message in bytes.
- Parameters:
-
cl The given client.
- Returns:
- The maximum data payload size in bytes on success,
-1
on failure.
EAPI void ecore_ipc_client_data_size_max_set | ( | Ecore_Ipc_Client * | cl, |
int | size | ||
) |
Sets the max data payload size for an Ipc message in bytes.
- Parameters:
-
cl The given client. size The maximum data payload size in bytes.
EAPI void ecore_ipc_client_flush | ( | Ecore_Ipc_Client * | cl | ) |
Flushes all pending data to the given client.
Will return when done.
- Parameters:
-
cl The given client.
References ecore_con_client_flush().
EAPI const char* ecore_ipc_client_ip_get | ( | Ecore_Ipc_Client * | cl | ) |
Gets the IP address of a client that has been connected to.
- Parameters:
-
cl The given client.
- Returns:
- A pointer to an internal string that contains the IP address of the connected server 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 knownNULL
is returned.
References ecore_con_client_ip_get().
EAPI void ecore_ipc_server_client_limit_set | ( | Ecore_Ipc_Server * | svr, |
int | client_limit, | ||
char | reject_excess_clients | ||
) |
Sets a limit on the number of clients that can be handled concurrently by the given server, and a policy on what to do if excess clients try to connect.
Beware that if you set this once ecore is already running, you may already have pending CLIENT_ADD events in your event queue. Those clients have already connected and will not be affected by this call. Only clients subsequently trying to connect will be affected.
- Parameters:
-
svr The given server. client_limit The maximum number of clients to handle concurrently. -1 means unlimited (default). 0 effectively disables the server. reject_excess_clients Set to 1 to automatically disconnect excess clients as soon as they connect if you are already handling client_limit clients. Set to 0 (default) to just hold off on the "accept()" system call until the number of active clients drops. This causes the kernel to queue up to 4096 connections (or your kernel's limit, whichever is lower).
References ecore_con_server_client_limit_set().
EAPI int ecore_ipc_server_data_size_max_get | ( | Ecore_Ipc_Server * | svr | ) |
Gets the max data payload size for an Ipc message in bytes.
- Parameters:
-
svr The given server.
- Returns:
- The maximum data payload in bytes.
EAPI void ecore_ipc_server_data_size_max_set | ( | Ecore_Ipc_Server * | svr, |
int | size | ||
) |
Sets the max data payload size for an Ipc message in bytes.
- Parameters:
-
svr The given server. size The maximum data payload size in bytes.
EAPI void ecore_ipc_server_flush | ( | Ecore_Ipc_Server * | svr | ) |
Flushes all pending data to the given server.
Will return when done.
- Parameters:
-
svr The given server.
References ecore_con_server_flush().
EAPI const char* ecore_ipc_server_ip_get | ( | Ecore_Ipc_Server * | svr | ) |
Gets the IP address of a server that has been connected to.
- Parameters:
-
svr The given server.
- Returns:
- A pointer to an internal string that contains the IP address of the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation. This string should not be modified or trusted to stay valid after deletion for the
svr
object. If no IP is known NULL is returned.
References ecore_con_server_ip_get().