summaryrefslogtreecommitdiff
path: root/src/lib/ecore_con/ecore_con_eet_base_eo.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/ecore_con/ecore_con_eet_base_eo.h')
-rw-r--r--src/lib/ecore_con/ecore_con_eet_base_eo.h142
1 files changed, 142 insertions, 0 deletions
diff --git a/src/lib/ecore_con/ecore_con_eet_base_eo.h b/src/lib/ecore_con/ecore_con_eet_base_eo.h
new file mode 100644
index 0000000..6c81768
--- /dev/null
+++ b/src/lib/ecore_con/ecore_con_eet_base_eo.h
@@ -0,0 +1,142 @@
1#ifndef _ECORE_CON_EET_BASE_EO_H_
2#define _ECORE_CON_EET_BASE_EO_H_
3
4#ifndef _ECORE_CON_EET_BASE_EO_CLASS_TYPE
5#define _ECORE_CON_EET_BASE_EO_CLASS_TYPE
6
7typedef Eo Ecore_Con_Eet_Base;
8
9#endif
10
11#ifndef _ECORE_CON_EET_BASE_EO_TYPES
12#define _ECORE_CON_EET_BASE_EO_TYPES
13
14/** Ecore connection reply data structure
15 *
16 * @ingroup Ecore_Con
17 */
18typedef struct _Ecore_Con_Reply Ecore_Con_Reply;
19
20
21#endif
22/**
23 * @brief Ecore Connection Eet Base class.
24 *
25 * This class provides Eet data serialization features to Ecore Connection
26 * objects.
27 *
28 * @ingroup Ecore_Con_Eet_Base
29 */
30#define ECORE_CON_EET_BASE_CLASS ecore_con_eet_base_class_get()
31
32EWAPI const Efl_Class *ecore_con_eet_base_class_get(void);
33
34/**
35 * @brief The server object to which we send and receive.
36 *
37 * @param[in] obj The object.
38 * @param[in] data Server object
39 *
40 * @ingroup Ecore_Con_Eet_Base
41 */
42EOAPI void ecore_con_eet_base_server_set(Eo *obj, Ecore_Con_Server *data);
43
44/**
45 * @brief The server object to which we send and receive.
46 *
47 * @param[in] obj The object.
48 *
49 * @return Server object
50 *
51 * @ingroup Ecore_Con_Eet_Base
52 */
53EOAPI Ecore_Con_Server *ecore_con_eet_base_server_get(const Eo *obj);
54
55/**
56 * @brief A callback function which should be called when data is received by
57 * ecore_con_eet_object.
58 *
59 * @param[in] obj The object.
60 * @param[in] name The name of the eet stream.
61 * @param[in] func The callback function.
62 * @param[in] data The data (if any) that should be passed to callback
63 * function.
64 *
65 * @ingroup Ecore_Con_Eet_Base
66 */
67EOAPI void ecore_con_eet_base_data_callback_set(Eo *obj, const char *name, Ecore_Con_Eet_Data_Cb func, const void *data);
68
69/**
70 * @brief A callback function which should be calledn when raw data is received
71 * by ecore_con_eet_object.
72 *
73 * @param[in] obj The object.
74 * @param[in] name The name of the eet stream.
75 * @param[in] func The callback function.
76 * @param[in] data The data (if any) that should be passed to callback
77 * function.
78 *
79 * @ingroup Ecore_Con_Eet_Base
80 */
81EOAPI void ecore_con_eet_base_raw_data_callback_set(Eo *obj, const char *name, Ecore_Con_Eet_Raw_Data_Cb func, const void *data);
82
83/**
84 * @brief Function to delete the @ref ecore_con_eet_base_data_callback_set.
85 *
86 * @param[in] obj The object.
87 * @param[in] name The name of the eet stream.
88 *
89 * @ingroup Ecore_Con_Eet_Base
90 */
91EOAPI void ecore_con_eet_base_data_callback_del(Eo *obj, const char *name);
92
93/**
94 * @brief Function to delete the @ref ecore_con_eet_base_raw_data_callback_set.
95 *
96 * @param[in] obj The object.
97 * @param[in] name The name of the eet stream.
98 *
99 * @ingroup Ecore_Con_Eet_Base
100 */
101EOAPI void ecore_con_eet_base_raw_data_callback_del(Eo *obj, const char *name);
102
103/**
104 * @brief Function to register a @ref Eet.Data.Descriptor to the ecore_con_eet
105 * object.
106 *
107 * @param[in] obj The object.
108 * @param[in] name The name of the eet stream.
109 * @param[in] edd The Eet.Data.Descriptor that is to be registered.
110 *
111 * @ingroup Ecore_Con_Eet_Base
112 */
113EOAPI void ecore_con_eet_base_register(Eo *obj, const char *name, Eet_Data_Descriptor *edd);
114
115/**
116 * @brief Function to send data.
117 *
118 * @param[in] obj The object.
119 * @param[in] reply Contains the ecore_con_eet object to which the data has to
120 * be sent.
121 * @param[in] name The name of the eet stream.
122 * @param[in] value Actual data
123 *
124 * @ingroup Ecore_Con_Eet_Base
125 */
126EOAPI void ecore_con_eet_base_send(Eo *obj, Ecore_Con_Reply *reply, const char *name, void *value);
127
128/**
129 * @brief Function to send raw data.
130 *
131 * @param[in] obj The object.
132 * @param[in] reply Contains the ecore_con_eet object to which the data has to
133 * be sent.
134 * @param[in] protocol_name The name of the eet stream.
135 * @param[in] section Name of section in the eet descriptor.
136 * @param[in] section_data
137 *
138 * @ingroup Ecore_Con_Eet_Base
139 */
140EOAPI void ecore_con_eet_base_raw_send(Eo *obj, Ecore_Con_Reply *reply, const char *protocol_name, const char *section, Eina_Binbuf *section_data);
141
142#endif