IPC Client Functions

Functions that deal with IPC client objects. More...

Functions

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

Detailed Description

Functions that deal with IPC client objects.


Function Documentation

Retrieves the data that has been associated with the given IPC client.

Parameters:
clThe given client.
Returns:
The data associated with the 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.

Parameters:
clThe given IPC client.
dataThe data to associate with the IPC client.
EAPI void* ecore_ipc_client_del ( Ecore_Ipc_Client cl)

Closes the connection and frees memory allocated to the given IPC client.

Parameters:
clThe given client.
Returns:
Data associated with the client.

References ecore_con_client_del(), ecore_con_client_server_get(), and ecore_con_server_data_get().

Referenced by ecore_ipc_server_del().

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.

Parameters:
clThe given IPC client.
majorMajor opcode of the message.
minorMinor opcode of the message.
refReference number of the message.
ref_toReference number of the message this message refers to.
responseRequires response.
dataThe data to send as part of the message.
sizeLength of the data, in bytes, to send.
Returns:
The number of bytes sent. 0 will be returned if there is an error.
Todo:

This function needs to become an IPC message.

Make sure ref_to and response parameters are described correctly.

References ecore_con_client_send().

Retrieves the IPC server that the given IPC client is connected to.

Parameters:
clThe given IPC client.
Returns:
The IPC server the IPC client is connected to.

References ecore_con_client_server_get(), and ecore_con_server_data_get().