11 # ifdef EFL_ECORE_IPC_BUILD
13 # define EAPI __declspec(dllexport)
18 # define EAPI __declspec(dllimport)
23 # define EAPI __attribute__ ((visibility("default")))
34 * @brief Ecore inter-process communication functions.
41 typedef struct _Ecore_Ipc_Server Ecore_Ipc_Server; /**< An IPC connection handle */
42 typedef struct _Ecore_Ipc_Client Ecore_Ipc_Client; /**< An IPC connection handle */
44 EAPI unsigned short _ecore_ipc_swap_16(unsigned short v);
45 EAPI unsigned int _ecore_ipc_swap_32(unsigned int v);
46 EAPI unsigned long long _ecore_ipc_swap_64(unsigned long long v);
48 #ifdef WORDS_BIGENDIAN
49 #define ECORE_IPC_SWAP2NET64(x) _ecore_ipc_swap_64(x)
50 #define ECORE_IPC_SWAP2CPU64(x) _ecore_ipc_swap_64(x)
51 #define ECORE_IPC_SWAP2NET32(x) _ecore_ipc_swap_32(x)
52 #define ECORE_IPC_SWAP2CPU32(x) _ecore_ipc_swap_32(x)
53 #define ECORE_IPC_SWAP2NET16(x) _ecore_ipc_swap_16(x)
54 #define ECORE_IPC_SWAP2CPU16(x) _ecore_ipc_swap_16(x)
55 #define ECORE_IPC_SWAP2NET8(x) (x)
56 #define ECORE_IPC_SWAP2CPU8(x) (x)
58 #define ECORE_IPC_SWAP2NET64(x) (x)
59 #define ECORE_IPC_SWAP2CPU64(x) (x)
60 #define ECORE_IPC_SWAP2NET32(x) (x)
61 #define ECORE_IPC_SWAP2CPU32(x) (x)
62 #define ECORE_IPC_SWAP2NET16(x) (x)
63 #define ECORE_IPC_SWAP2CPU16(x) (x)
64 #define ECORE_IPC_SWAP2NET8(x) (x)
65 #define ECORE_IPC_SWAP2CPU8(x) (x)
68 /* 1, 2, 4 and 8 byte datatypes */
70 #define ECORE_IPC_GET64(v)\
72 p->v = ECORE_IPC_SWAP2CPU64(*(long long *)(ptr)); \
75 #define ECORE_IPC_GET32(v)\
77 p->v = ECORE_IPC_SWAP2CPU32(*(int *)(ptr)); \
80 #define ECORE_IPC_GET16(v)\
82 p->v = ECORE_IPC_SWAP2CPU16(*(short *)(ptr)); \
85 #define ECORE_IPC_GET8(v) \
87 p->v = ECORE_IPC_SWAP2CPU8(*(char *)(ptr)); \
91 #define ECORE_IPC_PUT64(v)\
93 *(long long *)(ptr) = ECORE_IPC_SWAP2NET64(p->v); \
96 #define ECORE_IPC_PUT32(v)\
98 *(int *)(ptr) = ECORE_IPC_SWAP2NET32(p->v); \
101 #define ECORE_IPC_PUT16(v)\
103 *(short *)(ptr) = ECORE_IPC_SWAP2NET16(p->v); \
106 #define ECORE_IPC_PUT8(v) \
108 *(char *)(ptr) = ECORE_IPC_SWAP2NET8(p->v); \
112 #define ECORE_IPC_PAD8() ptr += 1
113 #define ECORE_IPC_PAD16() ptr += 2
114 #define ECORE_IPC_PAD32() ptr += 4
115 #define ECORE_IPC_PAD64() ptr += 8
117 /* counting data when encoding lists */
118 #define ECORE_IPC_CNT8() len += 1
119 #define ECORE_IPC_CNT16() len += 2
120 #define ECORE_IPC_CNT32() len += 4
121 #define ECORE_IPC_CNT64() len += 8
124 #define ECORE_IPC_CHEKS() if (*((unsigned char *)d + s - 1) != 0) return 0;
125 #define ECORE_IPC_GETS(v) \
127 if (ptr < ((unsigned char *)d + s)) \
129 p->v = (char *)ptr; \
130 ptr += strlen(p->v) + 1; \
133 #define ECORE_IPC_PUTS(v, l)\
135 strcpy((char *)ptr, p->v); \
139 /* handy to calculate what sized block we need to alloc */
140 #define ECORE_IPC_SLEN(l, v) ((l = strlen(p->v)) + 1)
141 #define ECORE_IPC_CNTS(v) len += strlen(p->v) + 1
143 /* saves typing function headers */
144 #define ECORE_IPC_DEC_STRUCT_PROTO(x) static int x(void *d, int s, void *pp)
145 #define ECORE_IPC_ENC_STRUCT_PROTO(x) static void *x(void *pp, int *s)
146 #define ECORE_IPC_DEC_EINA_LIST_PROTO(x) static Eina_List *x(void *d, int s)
147 #define ECORE_IPC_ENC_EINA_LIST_PROTO(x) static void *x(Eina_List *lp, int *s)
150 /* decoder setup - saves typing. requires data packet of exact size, or fail */
151 #define ECORE_IPC_DEC_STRUCT_HEAD_EXACT(typ, x) \
153 unsigned char *ptr; \
155 if (!d) return 0; if (s != (x)) return 0; \
157 /* decoder setup - saves typing. requires data packet of a minimum size */
158 #define ECORE_IPC_DEC_STRUCT_HEAD_MIN(typ, x) \
160 unsigned char *ptr; \
162 if (!d) return 0; if (s < (x)) return 0; \
164 /* footer for the hell of it */
165 #define ECORE_IPC_DEC_STRUCT_FOOT() return 1
166 /* header for encoder - gives native strct type and size of flattened packet */
167 #define ECORE_IPC_ENC_STRUCT_HEAD(typ, sz) \
169 unsigned char *d, *ptr; \
172 if(!pp) return NULL; \
176 if (!d) return NULL; \
179 /* footer for the hell of it */
180 #define ECORE_IPC_ENC_STRUCT_FOOT() return d
182 #define ECORE_IPC_DEC_EINA_LIST_HEAD(typ) \
183 unsigned char *ptr; \
188 while(ptr < (unsigned char *)(d + s)) \
190 p = malloc(sizeof(typ));
192 #define ECORE_IPC_DEC_EINA_LIST_FOOT() \
193 l = eina_list_append(l, p); \
196 #define ECORE_IPC_ENC_EINA_LIST_HEAD_START(typ) \
199 unsigned char *d, *ptr; \
203 for (l = lp; l; l = l->next) \
206 #define ECORE_IPC_ENC_EINA_LIST_HEAD_FINISH() \
209 if(!d) return NULL; \
212 for (l = lp; l; l = l->next) \
216 #define ECORE_IPC_ENC_EINA_LIST_FOOT() \
220 typedef enum _Ecore_Ipc_Type
222 ECORE_IPC_LOCAL_USER,
223 ECORE_IPC_LOCAL_SYSTEM,
224 ECORE_IPC_REMOTE_SYSTEM,
225 ECORE_IPC_USE_SSL = (1 << 4),
226 ECORE_IPC_NO_PROXY = (1 << 5)
229 typedef struct _Ecore_Ipc_Event_Client_Add Ecore_Ipc_Event_Client_Add;
230 typedef struct _Ecore_Ipc_Event_Client_Del Ecore_Ipc_Event_Client_Del;
231 typedef struct _Ecore_Ipc_Event_Server_Add Ecore_Ipc_Event_Server_Add;
232 typedef struct _Ecore_Ipc_Event_Server_Del Ecore_Ipc_Event_Server_Del;
233 typedef struct _Ecore_Ipc_Event_Client_Data Ecore_Ipc_Event_Client_Data;
234 typedef struct _Ecore_Ipc_Event_Server_Data Ecore_Ipc_Event_Server_Data;
236 struct _Ecore_Ipc_Event_Client_Add
238 Ecore_Ipc_Client *client;
241 struct _Ecore_Ipc_Event_Client_Del
243 Ecore_Ipc_Client *client;
246 struct _Ecore_Ipc_Event_Server_Add
248 Ecore_Ipc_Server *server;
251 struct _Ecore_Ipc_Event_Server_Del
253 Ecore_Ipc_Server *server;
256 struct _Ecore_Ipc_Event_Client_Data
258 Ecore_Ipc_Client *client;
259 /* FIXME: this needs to become an ipc message */
269 struct _Ecore_Ipc_Event_Server_Data
271 Ecore_Ipc_Server *server;
272 /* FIXME: this needs to become an ipc message */
282 EAPI extern int ECORE_IPC_EVENT_CLIENT_ADD;
283 EAPI extern int ECORE_IPC_EVENT_CLIENT_DEL;
284 EAPI extern int ECORE_IPC_EVENT_SERVER_ADD;
285 EAPI extern int ECORE_IPC_EVENT_SERVER_DEL;
286 EAPI extern int ECORE_IPC_EVENT_CLIENT_DATA;
287 EAPI extern int ECORE_IPC_EVENT_SERVER_DATA;
289 EAPI int ecore_ipc_init(void);
290 EAPI int ecore_ipc_shutdown(void);
292 /* FIXME: need to add protocol type parameter */
293 EAPI Ecore_Ipc_Server *ecore_ipc_server_add(Ecore_Ipc_Type type, const char *name, int port, const void *data);
295 /* FIXME: need to add protocol type parameter */
296 EAPI Ecore_Ipc_Server *ecore_ipc_server_connect(Ecore_Ipc_Type type, char *name, int port, const void *data);
297 EAPI void *ecore_ipc_server_del(Ecore_Ipc_Server *svr);
298 EAPI void *ecore_ipc_server_data_get(Ecore_Ipc_Server *svr);
299 EAPI Eina_Bool ecore_ipc_server_connected_get(Ecore_Ipc_Server *svr);
300 EAPI Eina_List *ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr);
301 /* FIXME: this needs to become an ipc message */
302 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);
303 EAPI void ecore_ipc_server_client_limit_set(Ecore_Ipc_Server *svr, int client_limit, char reject_excess_clients);
304 EAPI void ecore_ipc_server_data_size_max_set(Ecore_Ipc_Server *srv, int size);
305 EAPI int ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *srv);
306 EAPI const char *ecore_ipc_server_ip_get(Ecore_Ipc_Server *svr);
307 EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr);
309 /* FIXME: this needs to become an ipc message */
310 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);
311 EAPI Ecore_Ipc_Server *ecore_ipc_client_server_get(Ecore_Ipc_Client *cl);
312 EAPI void *ecore_ipc_client_del(Ecore_Ipc_Client *cl);
313 EAPI void ecore_ipc_client_data_set(Ecore_Ipc_Client *cl, const void *data);
314 EAPI void *ecore_ipc_client_data_get(Ecore_Ipc_Client *cl);
315 EAPI void ecore_ipc_client_data_size_max_set(Ecore_Ipc_Client *cl, int size);
316 EAPI int ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl);
317 EAPI const char *ecore_ipc_client_ip_get(Ecore_Ipc_Client *cl);
318 EAPI void ecore_ipc_client_flush(Ecore_Ipc_Client *cl);
320 EAPI int ecore_ipc_ssl_available_get(void);
321 /* FIXME: need to add a callback to "ok" large ipc messages greater than */
322 /* a certain size (seurity/DOS attack safety) */