summaryrefslogtreecommitdiff
path: root/src/lib/ecore_ipc
diff options
context:
space:
mode:
authorPierre Le Magourou <pierre.lemagourou@openwide.fr>2014-10-16 17:43:21 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:32:27 +0200
commit1c0390bf0889aab75af1bcff01319e813029ee7b (patch)
tree7ca1cf1d137e4dbee4b099986aac27a8d99b2818 /src/lib/ecore_ipc
parentacfd5a82567c39baf1ad5afb4add97653c05cb0c (diff)
ecore_ipc: update missing API documentation.
Diffstat (limited to 'src/lib/ecore_ipc')
-rw-r--r--src/lib/ecore_ipc/Ecore_Ipc.h90
1 files changed, 66 insertions, 24 deletions
diff --git a/src/lib/ecore_ipc/Ecore_Ipc.h b/src/lib/ecore_ipc/Ecore_Ipc.h
index 71cfa17ed9..a3e38710b4 100644
--- a/src/lib/ecore_ipc/Ecore_Ipc.h
+++ b/src/lib/ecore_ipc/Ecore_Ipc.h
@@ -30,8 +30,11 @@
30#endif 30#endif
31 31
32/** 32/**
33 * @file Ecore_Ipc.h 33 * @defgroup Ecore_IPC_Group Ecore_IPC - Ecore inter-process communication functions.
34 * @brief Ecore inter-process communication functions. 34 * @ingroup Ecore
35 *
36 *
37 * @{
35 */ 38 */
36 39
37#ifdef __cplusplus 40#ifdef __cplusplus
@@ -217,6 +220,11 @@ EAPI unsigned long long _ecore_ipc_swap_64(unsigned long long v) EINA_DEPRECATED
217 } \ 220 } \
218 return d 221 return d
219 222
223/**
224 * @typedef Ecore_Ipc_Type
225 *
226 * Enum containing IPC types.
227 */
220typedef enum _Ecore_Ipc_Type 228typedef enum _Ecore_Ipc_Type
221{ 229{
222 ECORE_IPC_LOCAL_USER, 230 ECORE_IPC_LOCAL_USER,
@@ -233,50 +241,81 @@ typedef struct _Ecore_Ipc_Event_Server_Del Ecore_Ipc_Event_Server_Del;
233typedef struct _Ecore_Ipc_Event_Client_Data Ecore_Ipc_Event_Client_Data; 241typedef struct _Ecore_Ipc_Event_Client_Data Ecore_Ipc_Event_Client_Data;
234typedef struct _Ecore_Ipc_Event_Server_Data Ecore_Ipc_Event_Server_Data; 242typedef struct _Ecore_Ipc_Event_Server_Data Ecore_Ipc_Event_Server_Data;
235 243
244/**
245 * @struct _Ecore_Ipc_Event_Client_Add
246 *
247 * An IPC structure for client_add event.
248 */
236struct _Ecore_Ipc_Event_Client_Add 249struct _Ecore_Ipc_Event_Client_Add
237{ 250{
238 Ecore_Ipc_Client *client; 251 Ecore_Ipc_Client *client; /**< An IPC connection handle */
239}; 252};
240 253
254/**
255 * @struct _Ecore_Ipc_Event_Client_Del
256 *
257 * An IPC structure for client_del event.
258 */
241struct _Ecore_Ipc_Event_Client_Del 259struct _Ecore_Ipc_Event_Client_Del
242{ 260{
243 Ecore_Ipc_Client *client; 261 Ecore_Ipc_Client *client; /**< An IPC connection handle */
244}; 262};
245 263
264/**
265 * @struct _Ecore_Ipc_Event_Server_Add
266 *
267 * An IPC structure for server_add event.
268 */
246struct _Ecore_Ipc_Event_Server_Add 269struct _Ecore_Ipc_Event_Server_Add
247{ 270{
248 Ecore_Ipc_Server *server; 271 Ecore_Ipc_Server *server; /**< An IPC connection handle */
249}; 272};
250 273
274/**
275 * @struct _Ecore_Ipc_Event_Server_Del
276 *
277 * An IPC structure for server_del event.
278 */
251struct _Ecore_Ipc_Event_Server_Del 279struct _Ecore_Ipc_Event_Server_Del
252{ 280{
253 Ecore_Ipc_Server *server; 281 Ecore_Ipc_Server *server; /**< An IPC connection handle */
282
254}; 283};
255 284
285/**
286 * @struct _Ecore_Ipc_Event_Client_Data
287 *
288 * An IPC structure for client_data event.
289 */
256struct _Ecore_Ipc_Event_Client_Data 290struct _Ecore_Ipc_Event_Client_Data
257{ 291{
258 Ecore_Ipc_Client *client; 292 Ecore_Ipc_Client *client; /**< An IPC connection handle */
259 /* FIXME: this needs to become an ipc message */ 293 /* FIXME: this needs to become an ipc message */
260 int major; 294 int major; /**< The message major opcode number */
261 int minor; 295 int minor; /**< The message minor opcode number */
262 int ref; 296 int ref; /**< The message reference number */
263 int ref_to; 297 int ref_to; /**< Reference number of the message it refers to */
264 int response; 298 int response; /**< Requires response */
265 void *data; 299 void *data; /**< The message data */
266 int size; 300 int size; /**< The data length (in bytes) */
267}; 301};
268 302
303/**
304 * @struct _Ecore_Ipc_Event_Server_Data
305 *
306 * An IPC structure for server_data event.
307 */
269struct _Ecore_Ipc_Event_Server_Data 308struct _Ecore_Ipc_Event_Server_Data
270{ 309{
271 Ecore_Ipc_Server *server; 310 Ecore_Ipc_Server *server; /**< An IPC connection handle */
272 /* FIXME: this needs to become an ipc message */ 311 /* FIXME: this needs to become an ipc message */
273 int major; 312 int major; /**< The message major opcode number */
274 int minor; 313 int minor; /**< The message minor opcode number */
275 int ref; 314 int ref; /**< The message reference number */
276 int ref_to; 315 int ref_to; /**< Reference number of the message it refers to */
277 int response; 316 int response; /**< Requires response */
278 void *data; 317 void *data; /**< The message data */
279 int size; 318 int size; /**< The data length (in bytes) */
280}; 319};
281 320
282EAPI extern int ECORE_IPC_EVENT_CLIENT_ADD; 321EAPI extern int ECORE_IPC_EVENT_CLIENT_ADD;
@@ -325,4 +364,7 @@ EAPI int ecore_ipc_ssl_available_get(void);
325} 364}
326#endif 365#endif
327 366
367/**
368 * @}
369 */
328#endif 370#endif