aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/net/server/fd/method
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/net/server/fd/method')
-rw-r--r--pages/develop/api/efl/net/server/fd/method/client_add.txt26
-rw-r--r--pages/develop/api/efl/net/server/fd/method/client_announce.txt42
-rw-r--r--pages/develop/api/efl/net/server/fd/method/client_reject.txt18
-rw-r--r--pages/develop/api/efl/net/server/fd/method/constructor.txt14
-rw-r--r--pages/develop/api/efl/net/server/fd/method/destructor.txt14
-rw-r--r--pages/develop/api/efl/net/server/fd/method/finalize.txt10
-rw-r--r--pages/develop/api/efl/net/server/fd/method/process_incoming_data.txt22
-rw-r--r--pages/develop/api/efl/net/server/fd/method/serve.txt22
-rw-r--r--pages/develop/api/efl/net/server/fd/method/socket_activate.txt42
9 files changed, 105 insertions, 105 deletions
diff --git a/pages/develop/api/efl/net/server/fd/method/client_add.txt b/pages/develop/api/efl/net/server/fd/method/client_add.txt
index 529e473fb..2b8e3b7c0 100644
--- a/pages/develop/api/efl/net/server/fd/method/client_add.txt
+++ b/pages/develop/api/efl/net/server/fd/method/client_add.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Net.Server.Fd.client_add~~
+===== Description =====
+
+%%Accepts a new client, should emit "client,add".%%
+
+%%Remember to create the client object with a callback to EFL_IO_CLOSER_EVENT_CLOSED during the construction and decrease %%[[:develop:api:efl:net:server:property:clients_count|Efl.Net.Server.clients_count]]%% as well as unref the client and remove yourself as parent.%%
+
+%%The new clients should have the server as parent and increase the %%[[:develop:api:efl:net:server:property:clients_count|Efl.Net.Server.clients_count]]%%.%%
+
+%%Whenever this function fails, it must close the given client file descriptor.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:server:fd:method:client_add:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -19,19 +32,6 @@ void efl_net_server_fd_client_add(Eo *obj, int client_fd);
* **client_fd** //(in)// - %%The file descriptor of the client socket. It comes preconfigured with close_on_exec. On failure, remember to close this socket%%
-===== Description =====
-
-%%Accepts a new client, should emit "client,add".%%
-
-%%Remember to create the client object with a callback to EFL_IO_CLOSER_EVENT_CLOSED during the construction and decrease %%[[:develop:api:efl:net:server:property:clients_count|Efl.Net.Server.clients_count]]%% as well as unref the client and remove yourself as parent.%%
-
-%%The new clients should have the server as parent and increase the %%[[:develop:api:efl:net:server:property:clients_count|Efl.Net.Server.clients_count]]%%.%%
-
-%%Whenever this function fails, it must close the given client file descriptor.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:server:fd:method:client_add:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Net.Server.Fd.client_add**
diff --git a/pages/develop/api/efl/net/server/fd/method/client_announce.txt b/pages/develop/api/efl/net/server/fd/method/client_announce.txt
index 13818a8f7..163b156a9 100644
--- a/pages/develop/api/efl/net/server/fd/method/client_announce.txt
+++ b/pages/develop/api/efl/net/server/fd/method/client_announce.txt
@@ -1,25 +1,4 @@
~~Title: Efl.Net.Server.Fd.client_announce~~
-//Overridden from [[:develop:api:efl:net:server:method:client_announce|Efl.Net.Server.client_announce]].//===== Signature =====
-
-<code>
-client_announce @protected @pure_virtual {
- params {
- @in client: free(Efl.Net.Socket, efl_del);
- }
- return: bool (false);
-}
-</code>
-
-===== C signature =====
-
-<code c>
-Eina_Bool efl_net_server_client_announce(Eo *obj, Efl_Net_Socket *client);
-</code>
-
-===== Parameters =====
-
- * **client** //(in)// - %%A socket representing the client.%%
-
===== Description =====
%%Implementions should call this method to announce new clients.%%
@@ -49,6 +28,27 @@ Eina_Bool efl_net_server_client_announce(Eo *obj, Efl_Net_Socket *client);
//Since 1.19//
{{page>:develop:api-include:efl:net:server:fd:method:client_announce:description&nouser&nolink&nodate}}
+//Overridden from [[:develop:api:efl:net:server:method:client_announce|Efl.Net.Server.client_announce]].//===== Signature =====
+
+<code>
+client_announce @protected @pure_virtual {
+ params {
+ @in client: free(Efl.Net.Socket, efl_del);
+ }
+ return: bool (false);
+}
+</code>
+
+===== C signature =====
+
+<code c>
+Eina_Bool efl_net_server_client_announce(Eo *obj, Efl_Net_Socket *client);
+</code>
+
+===== Parameters =====
+
+ * **client** //(in)// - %%A socket representing the client.%%
+
===== Implemented by =====
* [[:develop:api:efl:net:server:method:client_announce|Efl.Net.Server.client_announce]]
diff --git a/pages/develop/api/efl/net/server/fd/method/client_reject.txt b/pages/develop/api/efl/net/server/fd/method/client_reject.txt
index 7ce58d51d..c2b9c05f8 100644
--- a/pages/develop/api/efl/net/server/fd/method/client_reject.txt
+++ b/pages/develop/api/efl/net/server/fd/method/client_reject.txt
@@ -1,4 +1,13 @@
~~Title: Efl.Net.Server.Fd.client_reject~~
+===== Description =====
+
+%%Rejects a new client, should emit "client,rejected".%%
+
+%%Must always close the client socket when it's done.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:server:fd:method:client_reject:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -19,15 +28,6 @@ void efl_net_server_fd_client_reject(Eo *obj, int client_fd);
* **client_fd** //(in)// - %%The file descriptor of the client socket. It comes preconfigured with close_on_exec and should be closed once it's not needed anymore%%
-===== Description =====
-
-%%Rejects a new client, should emit "client,rejected".%%
-
-%%Must always close the client socket when it's done.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:server:fd:method:client_reject:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Net.Server.Fd.client_reject**
diff --git a/pages/develop/api/efl/net/server/fd/method/constructor.txt b/pages/develop/api/efl/net/server/fd/method/constructor.txt
index 24763c97c..631790e84 100644
--- a/pages/develop/api/efl/net/server/fd/method/constructor.txt
+++ b/pages/develop/api/efl/net/server/fd/method/constructor.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Net.Server.Fd.constructor~~
+===== Description =====
+
+%%Call the object's constructor.%%
+
+%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
+{{page>:develop:api-include:efl:net:server:fd:method:constructor:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:loop:fd:method:constructor|Efl.Object.constructor]].//===== Signature =====
<code>
@@ -13,13 +20,6 @@ constructor {
Efl_Object *efl_constructor(Eo *obj);
</code>
-===== Description =====
-
-%%Call the object's constructor.%%
-
-%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
-{{page>:develop:api-include:efl:net:server:fd:method:constructor:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:object:method:constructor|Efl.Object.constructor]]
diff --git a/pages/develop/api/efl/net/server/fd/method/destructor.txt b/pages/develop/api/efl/net/server/fd/method/destructor.txt
index daa5ab657..a4c5a5fb0 100644
--- a/pages/develop/api/efl/net/server/fd/method/destructor.txt
+++ b/pages/develop/api/efl/net/server/fd/method/destructor.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Net.Server.Fd.destructor~~
+===== Description =====
+
+%%Call the object's destructor.%%
+
+%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
+{{page>:develop:api-include:efl:net:server:fd:method:destructor:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:loop:fd:method:destructor|Efl.Object.destructor]].//===== Signature =====
<code>
@@ -11,13 +18,6 @@ destructor {}
void efl_destructor(Eo *obj);
</code>
-===== Description =====
-
-%%Call the object's destructor.%%
-
-%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
-{{page>:develop:api-include:efl:net:server:fd:method:destructor:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]]
diff --git a/pages/develop/api/efl/net/server/fd/method/finalize.txt b/pages/develop/api/efl/net/server/fd/method/finalize.txt
index bf1e974d5..29b651122 100644
--- a/pages/develop/api/efl/net/server/fd/method/finalize.txt
+++ b/pages/develop/api/efl/net/server/fd/method/finalize.txt
@@ -1,4 +1,9 @@
~~Title: Efl.Net.Server.Fd.finalize~~
+===== Description =====
+
+%%Called at the end of #eo_add. Should not be called, just overridden.%%
+{{page>:develop:api-include:efl:net:server:fd:method:finalize:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]].//===== Signature =====
<code>
@@ -13,11 +18,6 @@ finalize {
Efl_Object *efl_finalize(Eo *obj);
</code>
-===== Description =====
-
-%%Called at the end of #eo_add. Should not be called, just overridden.%%
-{{page>:develop:api-include:efl:net:server:fd:method:finalize:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]]
diff --git a/pages/develop/api/efl/net/server/fd/method/process_incoming_data.txt b/pages/develop/api/efl/net/server/fd/method/process_incoming_data.txt
index 2c79b0c4c..feabe1dd0 100644
--- a/pages/develop/api/efl/net/server/fd/method/process_incoming_data.txt
+++ b/pages/develop/api/efl/net/server/fd/method/process_incoming_data.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Net.Server.Fd.process_incoming_data~~
+===== Description =====
+
+%%When the socket has data to be read, process it.%%
+
+%%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().%%
+
+%%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.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:server:fd:method:process_incoming_data:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -11,17 +22,6 @@ process_incoming_data @protected {}
void efl_net_server_fd_process_incoming_data(Eo *obj);
</code>
-===== Description =====
-
-%%When the socket has data to be read, process it.%%
-
-%%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().%%
-
-%%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.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:server:fd:method:process_incoming_data:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Net.Server.Fd.process_incoming_data**
diff --git a/pages/develop/api/efl/net/server/fd/method/serve.txt b/pages/develop/api/efl/net/server/fd/method/serve.txt
index f51ae355f..8394b36ff 100644
--- a/pages/develop/api/efl/net/server/fd/method/serve.txt
+++ b/pages/develop/api/efl/net/server/fd/method/serve.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Net.Server.Fd.serve~~
+===== Description =====
+
+%%Starts serving requests.%%
+
+%%This method starts the server, resolving address and then proceeding to the actual listen(2)/bind(2) equivalent..%%
+
+%%Once the connection is fully setup, "serving" event is dispatched.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:server:fd:method:serve:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:net:server:method:serve|Efl.Net.Server.serve]].//===== Signature =====
<code>
@@ -20,17 +31,6 @@ Eina_Error efl_net_server_serve(Eo *obj, const char *address);
* **address** //(in)// - %%Address to run server on%%
-===== Description =====
-
-%%Starts serving requests.%%
-
-%%This method starts the server, resolving address and then proceeding to the actual listen(2)/bind(2) equivalent..%%
-
-%%Once the connection is fully setup, "serving" event is dispatched.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:server:fd:method:serve:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:net:server:method:serve|Efl.Net.Server.serve]]
diff --git a/pages/develop/api/efl/net/server/fd/method/socket_activate.txt b/pages/develop/api/efl/net/server/fd/method/socket_activate.txt
index 825dbc956..d36806023 100644
--- a/pages/develop/api/efl/net/server/fd/method/socket_activate.txt
+++ b/pages/develop/api/efl/net/server/fd/method/socket_activate.txt
@@ -1,25 +1,4 @@
~~Title: Efl.Net.Server.Fd.socket_activate~~
-===== Signature =====
-
-<code>
-socket_activate {
- params {
- @in address: free(string, free);
- }
- return: Eina.Error;
-}
-</code>
-
-===== C signature =====
-
-<code c>
-Eina_Error efl_net_server_fd_socket_activate(Eo *obj, const char *address);
-</code>
-
-===== Parameters =====
-
- * **address** //(in)// - %%The address to validate the next available socket. It doesn't serve as search, only as validation!%%
-
===== Description =====
%%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);
//Since 1.19//
{{page>:develop:api-include:efl:net:server:fd:method:socket_activate:description&nouser&nolink&nodate}}
+===== Signature =====
+
+<code>
+socket_activate {
+ params {
+ @in address: free(string, free);
+ }
+ return: Eina.Error;
+}
+</code>
+
+===== C signature =====
+
+<code c>
+Eina_Error efl_net_server_fd_socket_activate(Eo *obj, const char *address);
+</code>
+
+===== Parameters =====
+
+ * **address** //(in)// - %%The address to validate the next available socket. It doesn't serve as search, only as validation!%%
+
===== Implemented by =====
* **Efl.Net.Server.Fd.socket_activate**