summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/server/udp/method
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-12 16:55:07 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-12 16:56:48 +0000
commitb1ab272be03c859b8c3b71eb88267f3b9d562b51 (patch)
treedf8a1818eff763bf76266a4323f92f1a09409d1a /pages/develop/api/efl/net/server/udp/method
parente3401bceb2a041fc39682a834ca107feac2c8642 (diff)
api: Use the latest API generation code
Diffstat (limited to 'pages/develop/api/efl/net/server/udp/method')
-rw-r--r--pages/develop/api/efl/net/server/udp/method/constructor.txt14
-rw-r--r--pages/develop/api/efl/net/server/udp/method/destructor.txt14
-rw-r--r--pages/develop/api/efl/net/server/udp/method/multicast_groups_get.txt18
-rw-r--r--pages/develop/api/efl/net/server/udp/method/multicast_join.txt30
-rw-r--r--pages/develop/api/efl/net/server/udp/method/multicast_leave.txt18
-rw-r--r--pages/develop/api/efl/net/server/udp/method/process_incoming_data.txt22
-rw-r--r--pages/develop/api/efl/net/server/udp/method/serve.txt22
-rw-r--r--pages/develop/api/efl/net/server/udp/method/socket_activate.txt42
8 files changed, 90 insertions, 90 deletions
diff --git a/pages/develop/api/efl/net/server/udp/method/constructor.txt b/pages/develop/api/efl/net/server/udp/method/constructor.txt
index 723a923..e924607 100644
--- a/pages/develop/api/efl/net/server/udp/method/constructor.txt
+++ b/pages/develop/api/efl/net/server/udp/method/constructor.txt
@@ -1,4 +1,11 @@
1~~Title: Efl.Net.Server.Udp.constructor~~ 1~~Title: Efl.Net.Server.Udp.constructor~~
2===== Description =====
3
4%%Call the object's constructor.%%
5
6%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
7{{page>:develop:api-include:efl:net:server:udp:method:constructor:description&nouser&nolink&nodate}}
8
2//Overridden from [[:develop:api:efl:net:server:ip:method:constructor|Efl.Object.constructor]].//===== Signature ===== 9//Overridden from [[:develop:api:efl:net:server:ip:method:constructor|Efl.Object.constructor]].//===== Signature =====
3 10
4<code> 11<code>
@@ -13,13 +20,6 @@ constructor {
13Efl_Object *efl_constructor(Eo *obj); 20Efl_Object *efl_constructor(Eo *obj);
14</code> 21</code>
15 22
16===== Description =====
17
18%%Call the object's constructor.%%
19
20%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
21{{page>:develop:api-include:efl:net:server:udp:method:constructor:description&nouser&nolink&nodate}}
22
23===== Implemented by ===== 23===== Implemented by =====
24 24
25 * [[:develop:api:efl:object:method:constructor|Efl.Object.constructor]] 25 * [[:develop:api:efl:object:method:constructor|Efl.Object.constructor]]
diff --git a/pages/develop/api/efl/net/server/udp/method/destructor.txt b/pages/develop/api/efl/net/server/udp/method/destructor.txt
index 5d59fda..be761fc 100644
--- a/pages/develop/api/efl/net/server/udp/method/destructor.txt
+++ b/pages/develop/api/efl/net/server/udp/method/destructor.txt
@@ -1,4 +1,11 @@
1~~Title: Efl.Net.Server.Udp.destructor~~ 1~~Title: Efl.Net.Server.Udp.destructor~~
2===== Description =====
3
4%%Call the object's destructor.%%
5
6%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
7{{page>:develop:api-include:efl:net:server:udp:method:destructor:description&nouser&nolink&nodate}}
8
2//Overridden from [[:develop:api:efl:net:server:fd:method:destructor|Efl.Object.destructor]].//===== Signature ===== 9//Overridden from [[:develop:api:efl:net:server:fd:method:destructor|Efl.Object.destructor]].//===== Signature =====
3 10
4<code> 11<code>
@@ -11,13 +18,6 @@ destructor {}
11void efl_destructor(Eo *obj); 18void efl_destructor(Eo *obj);
12</code> 19</code>
13 20
14===== Description =====
15
16%%Call the object's destructor.%%
17
18%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
19{{page>:develop:api-include:efl:net:server:udp:method:destructor:description&nouser&nolink&nodate}}
20
21===== Implemented by ===== 21===== Implemented by =====
22 22
23 * [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]] 23 * [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]]
diff --git a/pages/develop/api/efl/net/server/udp/method/multicast_groups_get.txt b/pages/develop/api/efl/net/server/udp/method/multicast_groups_get.txt
index 69fb22f..82b6e5e 100644
--- a/pages/develop/api/efl/net/server/udp/method/multicast_groups_get.txt
+++ b/pages/develop/api/efl/net/server/udp/method/multicast_groups_get.txt
@@ -1,4 +1,13 @@
1~~Title: Efl.Net.Server.Udp.multicast_groups_get~~ 1~~Title: Efl.Net.Server.Udp.multicast_groups_get~~
2===== Description =====
3
4%%Returns the multicast groups this server has joined.%%
5
6%%The iterator is only valid until a new group is joined or left using %%[[:develop:api:efl:net:server:udp:method:multicast_join|Efl.Net.Server.Udp.multicast_join]]%% or %%[[:develop:api:efl:net:server:udp:method:multicast_leave|Efl.Net.Server.Udp.multicast_leave]]%%.%%
7
8//Since 1.19//
9{{page>:develop:api-include:efl:net:server:udp:method:multicast_groups_get:description&nouser&nolink&nodate}}
10
2===== Signature ===== 11===== Signature =====
3 12
4<code> 13<code>
@@ -13,15 +22,6 @@ multicast_groups_get {
13Eina_Iterator *efl_net_server_udp_multicast_groups_get(Eo *obj); 22Eina_Iterator *efl_net_server_udp_multicast_groups_get(Eo *obj);
14</code> 23</code>
15 24
16===== Description =====
17
18%%Returns the multicast groups this server has joined.%%
19
20%%The iterator is only valid until a new group is joined or left using %%[[:develop:api:efl:net:server:udp:method:multicast_join|Efl.Net.Server.Udp.multicast_join]]%% or %%[[:develop:api:efl:net:server:udp:method:multicast_leave|Efl.Net.Server.Udp.multicast_leave]]%%.%%
21
22//Since 1.19//
23{{page>:develop:api-include:efl:net:server:udp:method:multicast_groups_get:description&nouser&nolink&nodate}}
24
25===== Implemented by ===== 25===== Implemented by =====
26 26
27 * **Efl.Net.Server.Udp.multicast_groups_get** 27 * **Efl.Net.Server.Udp.multicast_groups_get**
diff --git a/pages/develop/api/efl/net/server/udp/method/multicast_join.txt b/pages/develop/api/efl/net/server/udp/method/multicast_join.txt
index cfedc12..e184f74 100644
--- a/pages/develop/api/efl/net/server/udp/method/multicast_join.txt
+++ b/pages/develop/api/efl/net/server/udp/method/multicast_join.txt
@@ -1,4 +1,19 @@
1~~Title: Efl.Net.Server.Udp.multicast_join~~ 1~~Title: Efl.Net.Server.Udp.multicast_join~~
2===== Description =====
3
4%%Joins a multicast group.%%
5
6%%The multicast address should be in the format:%%
7
8%%IP@INTERFACE%%
9
10%%With '@INTERFACE' being optional, such as:%%
11
12%%224.0.0.1 - use any interface (ie: 0.0.0.0) 224.0.0.1@0.0.0.0 224.0.0.1@192.168.0.1 - use the interface assigned to 192.168.0.1 ff02::1@0 - use any interface ff02::1@1 - use loopback interface (idx=1)%%
13
14//Since 1.19//
15{{page>:develop:api-include:efl:net:server:udp:method:multicast_join:description&nouser&nolink&nodate}}
16
2===== Signature ===== 17===== Signature =====
3 18
4<code> 19<code>
@@ -20,21 +35,6 @@ Eina_Error efl_net_server_udp_multicast_join(Eo *obj, const char *address);
20 35
21 * **address** //(in)// - %%Multicast group address%% 36 * **address** //(in)// - %%Multicast group address%%
22 37
23===== Description =====
24
25%%Joins a multicast group.%%
26
27%%The multicast address should be in the format:%%
28
29%%IP@INTERFACE%%
30
31%%With '@INTERFACE' being optional, such as:%%
32
33%%224.0.0.1 - use any interface (ie: 0.0.0.0) 224.0.0.1@0.0.0.0 224.0.0.1@192.168.0.1 - use the interface assigned to 192.168.0.1 ff02::1@0 - use any interface ff02::1@1 - use loopback interface (idx=1)%%
34
35//Since 1.19//
36{{page>:develop:api-include:efl:net:server:udp:method:multicast_join:description&nouser&nolink&nodate}}
37
38===== Implemented by ===== 38===== Implemented by =====
39 39
40 * **Efl.Net.Server.Udp.multicast_join** 40 * **Efl.Net.Server.Udp.multicast_join**
diff --git a/pages/develop/api/efl/net/server/udp/method/multicast_leave.txt b/pages/develop/api/efl/net/server/udp/method/multicast_leave.txt
index b4bdbde..7a988b9 100644
--- a/pages/develop/api/efl/net/server/udp/method/multicast_leave.txt
+++ b/pages/develop/api/efl/net/server/udp/method/multicast_leave.txt
@@ -1,4 +1,13 @@
1~~Title: Efl.Net.Server.Udp.multicast_leave~~ 1~~Title: Efl.Net.Server.Udp.multicast_leave~~
2===== Description =====
3
4%%Leaves a multicast group.%%
5
6%%This reverses the effect of %%[[:develop:api:efl:net:server:udp:method:multicast_join|Efl.Net.Server.Udp.multicast_join]]%%.%%
7
8//Since 1.19//
9{{page>:develop:api-include:efl:net:server:udp:method:multicast_leave:description&nouser&nolink&nodate}}
10
2===== Signature ===== 11===== Signature =====
3 12
4<code> 13<code>
@@ -20,15 +29,6 @@ Eina_Error efl_net_server_udp_multicast_leave(Eo *obj, const char *address);
20 29
21 * **address** //(in)// - %%Multicast group address%% 30 * **address** //(in)// - %%Multicast group address%%
22 31
23===== Description =====
24
25%%Leaves a multicast group.%%
26
27%%This reverses the effect of %%[[:develop:api:efl:net:server:udp:method:multicast_join|Efl.Net.Server.Udp.multicast_join]]%%.%%
28
29//Since 1.19//
30{{page>:develop:api-include:efl:net:server:udp:method:multicast_leave:description&nouser&nolink&nodate}}
31
32===== Implemented by ===== 32===== Implemented by =====
33 33
34 * **Efl.Net.Server.Udp.multicast_leave** 34 * **Efl.Net.Server.Udp.multicast_leave**
diff --git a/pages/develop/api/efl/net/server/udp/method/process_incoming_data.txt b/pages/develop/api/efl/net/server/udp/method/process_incoming_data.txt
index 76df6a9..6379daa 100644
--- a/pages/develop/api/efl/net/server/udp/method/process_incoming_data.txt
+++ b/pages/develop/api/efl/net/server/udp/method/process_incoming_data.txt
@@ -1,4 +1,15 @@
1~~Title: Efl.Net.Server.Udp.process_incoming_data~~ 1~~Title: Efl.Net.Server.Udp.process_incoming_data~~
2===== Description =====
3
4%%When the socket has data to be read, process it.%%
5
6%%By default this method will call accept() and then decide if %%[[:develop:api:efl:net:server:fd:method:client_add|Efl.Net.Server.Fd.client_add]]%% or %%[[:develop:api:efl:net:server:fd:method:client_reject|Efl.Net.Server.Fd.client_reject]]%% must be executed, however it may be replaced with something else, such as in SOCK_DGRAM (UDP) there is no accept(), only recvfrom().%%
7
8%%It is called straight from %%[[:develop:api:efl:loop:fd|Efl.Loop.Fd]]%% "read" event handler and is provided as a method to allow easy extending of the class for various purposes.%%
9
10//Since 1.19//
11{{page>:develop:api-include:efl:net:server:udp:method:process_incoming_data:description&nouser&nolink&nodate}}
12
2//Overridden from [[:develop:api:efl:net:server:fd:method:process_incoming_data|Efl.Net.Server.Fd.process_incoming_data]].//===== Signature ===== 13//Overridden from [[:develop:api:efl:net:server:fd:method:process_incoming_data|Efl.Net.Server.Fd.process_incoming_data]].//===== Signature =====
3 14
4<code> 15<code>
@@ -11,17 +22,6 @@ process_incoming_data @protected {}
11void efl_net_server_fd_process_incoming_data(Eo *obj); 22void efl_net_server_fd_process_incoming_data(Eo *obj);
12</code> 23</code>
13 24
14===== Description =====
15
16%%When the socket has data to be read, process it.%%
17
18%%By default this method will call accept() and then decide if %%[[:develop:api:efl:net:server:fd:method:client_add|Efl.Net.Server.Fd.client_add]]%% or %%[[:develop:api:efl:net:server:fd:method:client_reject|Efl.Net.Server.Fd.client_reject]]%% must be executed, however it may be replaced with something else, such as in SOCK_DGRAM (UDP) there is no accept(), only recvfrom().%%
19
20%%It is called straight from %%[[:develop:api:efl:loop:fd|Efl.Loop.Fd]]%% "read" event handler and is provided as a method to allow easy extending of the class for various purposes.%%
21
22//Since 1.19//
23{{page>:develop:api-include:efl:net:server:udp:method:process_incoming_data:description&nouser&nolink&nodate}}
24
25===== Implemented by ===== 25===== Implemented by =====
26 26
27 * [[:develop:api:efl:net:server:fd:method:process_incoming_data|Efl.Net.Server.Fd.process_incoming_data]] 27 * [[:develop:api:efl:net:server:fd:method:process_incoming_data|Efl.Net.Server.Fd.process_incoming_data]]
diff --git a/pages/develop/api/efl/net/server/udp/method/serve.txt b/pages/develop/api/efl/net/server/udp/method/serve.txt
index a54ff43..d494a3d 100644
--- a/pages/develop/api/efl/net/server/udp/method/serve.txt
+++ b/pages/develop/api/efl/net/server/udp/method/serve.txt
@@ -1,4 +1,15 @@
1~~Title: Efl.Net.Server.Udp.serve~~ 1~~Title: Efl.Net.Server.Udp.serve~~
2===== Description =====
3
4%%Starts serving requests.%%
5
6%%This method starts the server, resolving address and then proceeding to the actual listen(2)/bind(2) equivalent..%%
7
8%%Once the connection is fully setup, "serving" event is dispatched.%%
9
10//Since 1.19//
11{{page>:develop:api-include:efl:net:server:udp:method:serve:description&nouser&nolink&nodate}}
12
2//Overridden from [[:develop:api:efl:net:server:fd:method:serve|Efl.Net.Server.serve]].//===== Signature ===== 13//Overridden from [[:develop:api:efl:net:server:fd:method:serve|Efl.Net.Server.serve]].//===== Signature =====
3 14
4<code> 15<code>
@@ -20,17 +31,6 @@ Eina_Error efl_net_server_serve(Eo *obj, const char *address);
20 31
21 * **address** //(in)// - %%Address to run server on%% 32 * **address** //(in)// - %%Address to run server on%%
22 33
23===== Description =====
24
25%%Starts serving requests.%%
26
27%%This method starts the server, resolving address and then proceeding to the actual listen(2)/bind(2) equivalent..%%
28
29%%Once the connection is fully setup, "serving" event is dispatched.%%
30
31//Since 1.19//
32{{page>:develop:api-include:efl:net:server:udp:method:serve:description&nouser&nolink&nodate}}
33
34===== Implemented by ===== 34===== Implemented by =====
35 35
36 * [[:develop:api:efl:net:server:method:serve|Efl.Net.Server.serve]] 36 * [[:develop:api:efl:net:server:method:serve|Efl.Net.Server.serve]]
diff --git a/pages/develop/api/efl/net/server/udp/method/socket_activate.txt b/pages/develop/api/efl/net/server/udp/method/socket_activate.txt
index 0afbcbd..5a1d339 100644
--- a/pages/develop/api/efl/net/server/udp/method/socket_activate.txt
+++ b/pages/develop/api/efl/net/server/udp/method/socket_activate.txt
@@ -1,25 +1,4 @@
1~~Title: Efl.Net.Server.Udp.socket_activate~~ 1~~Title: Efl.Net.Server.Udp.socket_activate~~
2//Overridden from [[:develop:api:efl:net:server:fd:method:socket_activate|Efl.Net.Server.Fd.socket_activate]].//===== Signature =====
3
4<code>
5socket_activate {
6 params {
7 @in address: free(string, free);
8 }
9 return: Eina.Error;
10}
11</code>
12
13===== C signature =====
14
15<code c>
16Eina_Error efl_net_server_fd_socket_activate(Eo *obj, const char *address);
17</code>
18
19===== Parameters =====
20
21 * **address** //(in)// - %%The address to validate the next available socket. It doesn't serve as search, only as validation!%%
22
23===== Description ===== 2===== Description =====
24 3
25%%If this method is called use an already activated socket.%% 4%%If this method is called use an already activated socket.%%
@@ -43,6 +22,27 @@ Eina_Error efl_net_server_fd_socket_activate(Eo *obj, const char *address);
43//Since 1.19// 22//Since 1.19//
44{{page>:develop:api-include:efl:net:server:udp:method:socket_activate:description&nouser&nolink&nodate}} 23{{page>:develop:api-include:efl:net:server:udp:method:socket_activate:description&nouser&nolink&nodate}}
45 24
25//Overridden from [[:develop:api:efl:net:server:fd:method:socket_activate|Efl.Net.Server.Fd.socket_activate]].//===== Signature =====
26
27<code>
28socket_activate {
29 params {
30 @in address: free(string, free);
31 }
32 return: Eina.Error;
33}
34</code>
35
36===== C signature =====
37
38<code c>
39Eina_Error efl_net_server_fd_socket_activate(Eo *obj, const char *address);
40</code>
41
42===== Parameters =====
43
44 * **address** //(in)// - %%The address to validate the next available socket. It doesn't serve as search, only as validation!%%
45
46===== Implemented by ===== 46===== Implemented by =====
47 47
48 * [[:develop:api:efl:net:server:fd:method:socket_activate|Efl.Net.Server.Fd.socket_activate]] 48 * [[:develop:api:efl:net:server:fd:method:socket_activate|Efl.Net.Server.Fd.socket_activate]]