summaryrefslogtreecommitdiff
path: root/src/lib/ecore_con
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-19 15:44:22 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-19 15:44:22 +0100
commit5541f8ead1f92c8d8b04a12b3f700acb86dcda15 (patch)
tree093aba779970bf546c2894a3452e2b67662c18ff /src/lib/ecore_con
parent69b9f0044b4a397f2748695210192a75d813820d (diff)
ecore_con: convert docs
Diffstat (limited to 'src/lib/ecore_con')
-rw-r--r--src/lib/ecore_con/ecore_con_client.eo9
-rw-r--r--src/lib/ecore_con/ecore_con_server.eo61
-rw-r--r--src/lib/ecore_con/efl_network_url.eo8
3 files changed, 39 insertions, 39 deletions
diff --git a/src/lib/ecore_con/ecore_con_client.eo b/src/lib/ecore_con/ecore_con_client.eo
index e1e3c06bca..db6859c2c8 100644
--- a/src/lib/ecore_con/ecore_con_client.eo
+++ b/src/lib/ecore_con/ecore_con_client.eo
@@ -2,15 +2,12 @@ class Ecore.Con.Client (Ecore.Con.Base) {
2 eo_prefix: ecore_con_client_obj; 2 eo_prefix: ecore_con_client_obj;
3 methods { 3 methods {
4 @property server { 4 @property server {
5 /*@ 5 [[Controls the server representing the socket the client has
6 * Controls the server representing the socket the client has 6 connected to.]]
7 * connected to.
8 *
9 */
10 get { 7 get {
11 } 8 }
12 values { 9 values {
13 svr: Ecore.Con.Server *; /*@ The server the client is connected to. */ 10 svr: Ecore.Con.Server *; [[The server the client is connected to.]]
14 } 11 }
15 } 12 }
16 } 13 }
diff --git a/src/lib/ecore_con/ecore_con_server.eo b/src/lib/ecore_con/ecore_con_server.eo
index 6e404e6afc..23cfd67381 100644
--- a/src/lib/ecore_con/ecore_con_server.eo
+++ b/src/lib/ecore_con/ecore_con_server.eo
@@ -2,57 +2,62 @@ class Ecore.Con.Server (Ecore.Con.Base) {
2 eo_prefix: ecore_con_server_obj; 2 eo_prefix: ecore_con_server_obj;
3 methods { 3 methods {
4 @property name { 4 @property name {
5 /*@ 5 [[Retrieves the name of server.
6 * Retrieves the name of server. 6
7 * 7 The name returned is the name used to connect on this server.
8 * The name returned is the name used to connect on this server. 8 ]]
9 */
10 set { 9 set {
11 legacy: null; 10 legacy: null;
12 } 11 }
13 get { 12 get {
14 } 13 }
15 values { 14 values {
16 name: const(char) *; /*@ The name of the server. */ 15 name: const(char) *; [[The name of the server.]]
17 } 16 }
18 } 17 }
19 @property client_limit { 18 @property client_limit {
20 /*@ 19 [[Sets a limit on the number of clients that can be handled concurrently
21 * Sets a limit on the number of clients that can be handled concurrently 20 by the given server, and a policy on what to do if excess clients
22 * by the given server, and a policy on what to do if excess clients try to 21 try to connect.
23 * connect. 22
24 * 23 Beware that if you set this once ecore is already running, you may
25 * 24 already have pending CLIENT_ADD events in your event queue. Those
26 * Beware that if you set this once ecore is already running, you may 25 clients have already connected and will not be affected by this call.
27 * already have pending CLIENT_ADD events in your event queue. Those 26 Only clients subsequently trying to connect will be affected.
28 * clients have already connected and will not be affected by this call. 27 ]]
29 * Only clients subsequently trying to connect will be affected.
30 */
31 set { 28 set {
32 } 29 }
33 get { 30 get {
34 legacy: null; 31 legacy: null;
35 } 32 }
36 values { 33 values {
37 client_limit: int; /*@ The maximum number of clients to handle concurrently. -1 means unlimited (default). 0 effectively disables the server. */ 34 client_limit: int; [[The maximum number of clients to handle
38 reject_excess_clients: char; /*@ Set to 1 to automatically disconnect excess clients as soon as they connect if you are already handling client_limit clients. Set to 0 (default) to just hold off on the "accept()" system call until the number of active clients drops. This causes the kernel to queue up to 4096 connections (or your kernel's limit, whichever is lower). */ 35 concurrently. -1 means unlimited (default).
36 0 effectively disables the server.]]
37 reject_excess_clients: char; [[Set to 1 to automatically disconnect excess clients as
38 soon as they connect if you are already handling
39 client_limit clients. Set to 0 (default) to just
40 hold off on the "accept()" system call until the
41 number of active clients drops. This causes the
42 kernel to queue up to 4096 connections (or your
43 kernel's limit, whichever is lower).
44 ]]
39 } 45 }
40 } 46 }
41 /* FIXME: Should this return an iterator? */ 47 /* FIXME: Should this return an iterator? */
42 @property clients { 48 @property clients {
43 /*@ 49 [[Retrieves the current list of clients.
44 * Retrieves the current list of clients. 50
45 * 51 Each node in the returned list points to an @Ecore_Con_Client. This
46 * 52 list cannot be modified or freed. It can also change if new clients
47 * Each node in the returned list points to an @ref Ecore_Con_Client. This list 53 are connected or disconnected, and will become invalid when the
48 * cannot be modified or freed. It can also change if new clients are connected 54 server is deleted/freed.
49 * or disconnected, and will become invalid when the server is deleted/freed. 55 ]]
50 */
51 get { 56 get {
52 } 57 }
53 values { 58 values {
54 // FIXME: Ecore.Con.Client is needed, but that introduces a cycle 59 // FIXME: Ecore.Con.Client is needed, but that introduces a cycle
55 clients: const(list<const(Ecore.Con.Base) *>) *; /*@ The list of clients on this server. */ 60 clients: const(list<const(Ecore.Con.Base) *>) *; [[The list of clients on this server.]]
56 } 61 }
57 } 62 }
58 @property connection_type { 63 @property connection_type {
diff --git a/src/lib/ecore_con/efl_network_url.eo b/src/lib/ecore_con/efl_network_url.eo
index 4f6f02d2d6..eecdfd498f 100644
--- a/src/lib/ecore_con/efl_network_url.eo
+++ b/src/lib/ecore_con/efl_network_url.eo
@@ -3,16 +3,14 @@ class Efl.Network.Url (Eo.Base) {
3 eo_prefix: efl_network_url; 3 eo_prefix: efl_network_url;
4 methods { 4 methods {
5 @property url { 5 @property url {
6 /*@ 6 [[Controls the URL to send the request to.]]
7 * Controls the URL to send the request to.
8 */
9 set { 7 set {
10 return: bool (false); /*@ true on success, false on error. */ 8 return: bool (false); [[true on success, false on error.]]
11 } 9 }
12 get { 10 get {
13 } 11 }
14 values { 12 values {
15 url: const(char) *; /*@ The URL */ 13 url: const(char) *; [[The URL]]
16 } 14 }
17 } 15 }
18 } 16 }