summaryrefslogtreecommitdiff
path: root/src/lib/ecore_con
diff options
context:
space:
mode:
authorSrivardhan Hebbar <sri.hebbar@samsung.com>2015-02-16 11:57:35 +0100
committerCedric BAIL <cedric@osg.samsung.com>2015-02-16 11:57:38 +0100
commit3da02b46004b0b6d3ccfb5556ca1900a8c2e2a4f (patch)
tree3a61e89e9fc9be04bbef65cc4a86e810ab2a3e50 /src/lib/ecore_con
parentc972994e01aafc2e9408cbd8abea00a35f139e32 (diff)
ecore_con: updatet documentation about Ecore_Con events.
Summary: Ordered events into server side events, client side events and update the text. Reviewers: cedric Reviewed By: cedric Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D1976 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib/ecore_con')
-rw-r--r--src/lib/ecore_con/Ecore_Con.h23
1 files changed, 14 insertions, 9 deletions
diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h
index 3c3daaaeb0..41a1e90b2f 100644
--- a/src/lib/ecore_con/Ecore_Con.h
+++ b/src/lib/ecore_con/Ecore_Con.h
@@ -73,6 +73,9 @@
73 * @defgroup Ecore_Con_Events_Group Ecore Connection Events Functions 73 * @defgroup Ecore_Con_Events_Group Ecore Connection Events Functions
74 * @ingroup Ecore_Con_Group 74 * @ingroup Ecore_Con_Group
75 * 75 *
76 * The Ecore Con events can be catagorized into Server side events
77 * and Client side events.
78 * Server side events:
76 * @li ECORE_CON_CLIENT_ADD: Whenever a client connection is made to an 79 * @li ECORE_CON_CLIENT_ADD: Whenever a client connection is made to an
77 * @c Ecore_Con_Server, an event of this type is emitted, allowing the 80 * @c Ecore_Con_Server, an event of this type is emitted, allowing the
78 * retrieval of the client's ip with @ref ecore_con_client_ip_get and 81 * retrieval of the client's ip with @ref ecore_con_client_ip_get and
@@ -81,6 +84,15 @@
81 * @c Ecore_Con_Server, an event of this type is emitted. The contents of 84 * @c Ecore_Con_Server, an event of this type is emitted. The contents of
82 * the data with this event are variable, but if the client object in the data 85 * the data with this event are variable, but if the client object in the data
83 * is non-null, it must be freed with @ref ecore_con_client_del. 86 * is non-null, it must be freed with @ref ecore_con_client_del.
87 * @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a server object receives
88 * data, then an event of this type is emitted. The data will contain
89 * the size and contents of the message sent by the client. It should be noted that
90 * data within this object is transient, so it must be duplicated in order to be
91 * retained. This event will continue to occur until the client has stopped sending its
92 * message, so a good option for storing this data is an Eina_Strbuf. Once the message has
93 * been received in full, the client object must be freed with ecore_con_client_free.
94 *
95 * Client side events:
84 * @li ECORE_CON_EVENT_SERVER_ADD: Whenever a server object is created 96 * @li ECORE_CON_EVENT_SERVER_ADD: Whenever a server object is created
85 * with @ref ecore_con_server_connect, an event of this type is emitted, 97 * with @ref ecore_con_server_connect, an event of this type is emitted,
86 * allowing for data to be serialized and sent to the server using 98 * allowing for data to be serialized and sent to the server using
@@ -91,15 +103,8 @@
91 * type is emitted. The contents of the data with this event are variable, 103 * type is emitted. The contents of the data with this event are variable,
92 * but if the server object in the data is non-null, it must be freed 104 * but if the server object in the data is non-null, it must be freed
93 * with @ref ecore_con_server_del. 105 * with @ref ecore_con_server_del.
94 * @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a client connects to your server 106 * @li ECORE_CON_EVENT_SERVER_DATA: Whenever client object receives
95 * object and sends data, an event of this type is emitted. The data will contain both 107 * data from the server, an event of this type is emitted. The data will contain both
96 * the size and contents of the message sent by the client. It should be noted that
97 * data within this object is transient, so it must be duplicated in order to be
98 * retained. This event will continue to occur until the client has stopped sending its
99 * message, so a good option for storing this data is an Eina_Strbuf. Once the message has
100 * been received in full, the client object must be freed with ecore_con_client_free.
101 * @li ECORE_CON_EVENT_SERVER_DATA: Whenever your server object connects to its destination
102 * and receives data, an event of this type is emitted. The data will contain both
103 * the size and contents of the message sent by the server. It should be noted that 108 * the size and contents of the message sent by the server. It should be noted that
104 * data within this object is transient, so it must be duplicated in order to be 109 * data within this object is transient, so it must be duplicated in order to be
105 * retained. This event will continue to occur until the server has stopped sending its 110 * retained. This event will continue to occur until the server has stopped sending its