cedric pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=55623537ea7e03bb9782f7336e40e841392c90d8
commit 55623537ea7e03bb9782f7336e40e841392c90d8 Author: Pierre Le Magourou <[email protected]> Date: Fri Oct 3 15:42:43 2014 +0200 ecore_con: update missing Ecore_Con_Eet.h API documentation. --- src/lib/ecore_con/Ecore_Con_Eet.h | 205 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 205 insertions(+) diff --git a/src/lib/ecore_con/Ecore_Con_Eet.h b/src/lib/ecore_con/Ecore_Con_Eet.h index bdf0d2d..95373c4 100644 --- a/src/lib/ecore_con/Ecore_Con_Eet.h +++ b/src/lib/ecore_con/Ecore_Con_Eet.h @@ -31,43 +31,248 @@ # endif #endif +/** + * @defgroup Ecore_Con_Eet_Group Ecore_Con_Eet - Eet connection functions + * @ingroup Ecore + * + * The Ecore Connection Eet library ( @c Ecore_Con_Eet) adds @c Eet data + * serialization features to Ecore Connection objects. Its main aim is to + * provide a way to send @c Eet data streams to another program through sockets + * using @c Ecore_Con objects. + */ + typedef struct _Ecore_Con_Eet Ecore_Con_Eet; typedef struct _Ecore_Con_Reply Ecore_Con_Reply; +/** + * @typedef Ecore_Con_Eet_Data_Cb + * @brief Called when an Ecore_Con_Eet object receives data. + */ typedef void (*Ecore_Con_Eet_Data_Cb)(void *data, Ecore_Con_Reply *reply, const char *protocol_name, void *value); + +/** + * @typedef Ecore_Con_Eet_Raw_Data_Cb + * @brief Called when an Ecore_Con_Eet object receives raw data. + */ typedef void (*Ecore_Con_Eet_Raw_Data_Cb)(void *data, Ecore_Con_Reply *reply, const char *protocol_name, const char *section, void *value, size_t length); + +/** + * @typedef Ecore_Con_Eet_Client_Cb + * @brief Called when a client connects to the server. + */ typedef Eina_Bool (*Ecore_Con_Eet_Client_Cb)(void *data, Ecore_Con_Reply *reply, Ecore_Con_Client *conn); + +/** + * @typedef Ecore_Con_Eet_Server_Cb + * @brief Called when the server has accepted the connection of the client. + */ typedef Eina_Bool (*Ecore_Con_Eet_Server_Cb)(void *data, Ecore_Con_Reply *reply, Ecore_Con_Server *conn); +/** + * Create a Ecore_Con_Eet server. + * + * @param server An existing Ecore_Con_Server that have been previously + * created by the server program with @ref + * ecore_con_server_add. + * + * @return A new Ecore_Con_Eet server. + */ EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server); + +/** + * Create a Ecore_Con_Eet client. + * + * @param server An existing Ecore_Con_Server that have been previously + * returned by a call to @ref ecore_con_server_connect in the + * client program. + * + * @return A new Ecore_Con_Eet client. + */ EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server); + +/** + * Free an existing Ecore_Con_Eet object. + * + * @param server An existing Ecore_Con_Eet object that have been previously + * allocated by a @ref ecore_con_eet_server_new or @ref + * ecore_con_eet_client_new. + * + */ EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece); +/** + * Register an @c Eet data descriptor on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param name The name of the Eet stream to connect. + * @param edd A Eet data descriptor that describes the data organization + * in the Eet stream. + * + */ EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_Descriptor *edd); +/** + * Register a data callback on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param name The name of the Eet stream to connect. + * @param func The function to call as a callback. + * @param data The data to pass to the callback. + * + */ EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Data_Cb func, const void *data); + +/** + * Remove a data callback on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param name The name of the Eet stream to remove callback on. + * + */ EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name); +/** + * Register a raw data callback on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param name The name of the raw Eet stream to connect. + * @param func The function to call as a callback. + * @param data The data to pass to the callback. + * + */ EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Raw_Data_Cb func, const void *data); + +/** + * Remove a raw data callback on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param name The name of the raw Eet stream to remove callback on. + * + */ EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *name); +/** + * Register a client connect callback on a Ecore_Con_Eet object. + * @brief This callback can be registered on the server program to know when a + * client connects. + * + * @param ece An Ecore_Con_Eet object. + * @param func The function to call as a callback. + * @param data The data to pass to the callback. + */ EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); + +/** + * Remove a client connect callback on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param func The callback to remove. + * @param data The data passed to this function at the callback registration. + */ EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); +/** + * Register a client disconnect callback on a Ecore_Con_Eet object. + * @brief This callback can be registered on the server program to know when a + * client disconnects. + * + * @param ece An Ecore_Con_Eet object. + * @param func The function to call as a callback. + * @param data The data to pass to the callback. + */ EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); + +/** + * Remove a client disconnect callback on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param func The callback to remove. + * @param data The data passed to this function at the callback registration. + */ EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); +/** + * Register a server connect callback on a Ecore_Con_Eet object. + * @brief This callback can be registered on the client program to be called + * when it has been connected to the server. + * + * @param ece An Ecore_Con_Eet object. + * @param func The function to call as a callback. + * @param data The data to pass to the callback. + */ EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); + +/** + * Remove a server connect callback on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param func The callback to remove. + * @param data The data passed to this function at the callback registration. + */ EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); +/** + * Register a server disconnect callback on a Ecore_Con_Eet object. + * @brief This callback can be registered on the client program to be called + * when it has been disconnected from the server. + * + * @param ece An Ecore_Con_Eet object. + * @param func The function to call as a callback. + * @param data The data to pass to the callback. + */ EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); + +/** + * Remove a server disconnect callback on a Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param func The callback to remove. + * @param data The data passed to this function at the callback registration. + */ EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); +/** + * Attach data to an Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @param data The data to attach to the Ecore_Con_Eet object. + */ EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data); + +/** + * Get the data attached to an Ecore_Con_Eet object. + * + * @param ece An Ecore_Con_Eet object. + * @return The data attached to the Ecore_Con_Eet object. + */ EAPI void *ecore_con_eet_data_get(Ecore_Con_Eet *ece); +/** + * Get the Ecore_Con_Eet object corresponding to the Ecore_Con_Reply object. + * + * @param reply An Ecore_Con_Reply object. + * @return The corresponding Ecore_Con_Eet object. + */ EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply); + +/** + * Send some data using a protocol type. + * + * @param reply An Ecore_Con_Reply object. + * @param protocol_name The protocol type to use. + * @param value The data to send. + */ EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, void *value); + +/** + * Send some raw data using a protocol type. + * + * @param reply An Ecore_Con_Reply object. + * @param protocol_name The protocol type to use. + * @param section The section to add to the protocol. + * @param value The data to send. + * @param length The data length. + */ EAPI void ecore_con_eet_raw_send(Ecore_Con_Reply *reply, const char *protocol_name, const char *section, void *value, unsigned int length); #endif --
