aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/net/dialer/tcp
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/net/dialer/tcp')
-rw-r--r--pages/develop/api/efl/net/dialer/tcp/method/close.txt22
-rw-r--r--pages/develop/api/efl/net/dialer/tcp/method/constructor.txt14
-rw-r--r--pages/develop/api/efl/net/dialer/tcp/method/destructor.txt14
-rw-r--r--pages/develop/api/efl/net/dialer/tcp/method/dial.txt22
-rw-r--r--pages/develop/api/efl/net/dialer/tcp/property/address_dial.txt26
-rw-r--r--pages/develop/api/efl/net/dialer/tcp/property/connected.txt26
-rw-r--r--pages/develop/api/efl/net/dialer/tcp/property/proxy.txt42
-rw-r--r--pages/develop/api/efl/net/dialer/tcp/property/timeout_dial.txt26
8 files changed, 96 insertions, 96 deletions
diff --git a/pages/develop/api/efl/net/dialer/tcp/method/close.txt b/pages/develop/api/efl/net/dialer/tcp/method/close.txt
index 3d279a240..15c5e5610 100644
--- a/pages/develop/api/efl/net/dialer/tcp/method/close.txt
+++ b/pages/develop/api/efl/net/dialer/tcp/method/close.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Net.Dialer.Tcp.close~~
+===== Description =====
+
+%%Closes the Input/Output object.%%
+
+%%This operation will be executed immediately and may or may not block the caller thread for some time. The details of blocking behavior is to be defined by the implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
+
+%%You can understand this method as close(2) libc function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:dialer:tcp:method:close:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:net:socket:fd:method:close|Efl.Io.Closer.close]].//===== Signature =====
<code>
@@ -13,17 +24,6 @@ close @pure_virtual {
Eina_Error efl_io_closer_close(Eo *obj);
</code>
-===== Description =====
-
-%%Closes the Input/Output object.%%
-
-%%This operation will be executed immediately and may or may not block the caller thread for some time. The details of blocking behavior is to be defined by the implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
-
-%%You can understand this method as close(2) libc function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:dialer:tcp:method:close:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]]
diff --git a/pages/develop/api/efl/net/dialer/tcp/method/constructor.txt b/pages/develop/api/efl/net/dialer/tcp/method/constructor.txt
index 54941eb57..17625bcd2 100644
--- a/pages/develop/api/efl/net/dialer/tcp/method/constructor.txt
+++ b/pages/develop/api/efl/net/dialer/tcp/method/constructor.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Net.Dialer.Tcp.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:dialer:tcp:method:constructor:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:net:socket: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:dialer:tcp: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/dialer/tcp/method/destructor.txt b/pages/develop/api/efl/net/dialer/tcp/method/destructor.txt
index c8058d007..54ed6d52f 100644
--- a/pages/develop/api/efl/net/dialer/tcp/method/destructor.txt
+++ b/pages/develop/api/efl/net/dialer/tcp/method/destructor.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Net.Dialer.Tcp.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:dialer:tcp:method:destructor:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:net:socket: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:dialer:tcp: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/dialer/tcp/method/dial.txt b/pages/develop/api/efl/net/dialer/tcp/method/dial.txt
index cc862b6ed..a05698978 100644
--- a/pages/develop/api/efl/net/dialer/tcp/method/dial.txt
+++ b/pages/develop/api/efl/net/dialer/tcp/method/dial.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Net.Dialer.Tcp.dial~~
+===== Description =====
+
+%%Dials to the remote peer.%%
+
+%%This method starts the connection process, resolving address and then proceeding to the actual connection.%%
+
+%%Once the connection is fully setup, "connected" event is dispatched.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:dialer:tcp:method:dial:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]].//===== Signature =====
<code>
@@ -20,17 +31,6 @@ Eina_Error efl_net_dialer_dial(Eo *obj, const char *address);
* **address** //(in)// - %%Remote address%%
-===== Description =====
-
-%%Dials to the remote peer.%%
-
-%%This method starts the connection process, resolving address and then proceeding to the actual connection.%%
-
-%%Once the connection is fully setup, "connected" event is dispatched.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:dialer:tcp:method:dial:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]
diff --git a/pages/develop/api/efl/net/dialer/tcp/property/address_dial.txt b/pages/develop/api/efl/net/dialer/tcp/property/address_dial.txt
index 754b29af7..90821b564 100644
--- a/pages/develop/api/efl/net/dialer/tcp/property/address_dial.txt
+++ b/pages/develop/api/efl/net/dialer/tcp/property/address_dial.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Net.Dialer.Tcp.address_dial~~
+===== Values =====
+
+ * **address** - %%Remote address%%
+===== Description =====
+
+%%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%%
+
+%%If the resolved address is desired, then listen to "resolved" event and use the %%[[:develop:api:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]]%% property.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:dialer:tcp:property:address_dial:description&nouser&nolink&nodate}}
+
+
//Overridden from [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]] **(get, set)**.//===== Signature =====
<code>
@@ -23,19 +36,6 @@ const char *efl_net_dialer_address_dial_get(const Eo *obj);
void efl_net_dialer_address_dial_set(Eo *obj, const char *address);
</code>
-===== Values =====
-
- * **address** - %%Remote address%%
-===== Description =====
-
-%%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%%
-
-%%If the resolved address is desired, then listen to "resolved" event and use the %%[[:develop:api:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]]%% property.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:dialer:tcp:property:address_dial:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]]
diff --git a/pages/develop/api/efl/net/dialer/tcp/property/connected.txt b/pages/develop/api/efl/net/dialer/tcp/property/connected.txt
index 85a69f5f4..6c1362e04 100644
--- a/pages/develop/api/efl/net/dialer/tcp/property/connected.txt
+++ b/pages/develop/api/efl/net/dialer/tcp/property/connected.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Net.Dialer.Tcp.connected~~
+===== Values =====
+
+ * **connected** - %%%%''true''%% if the socket is connected, %%''false''%% otherwise%%
+===== Description =====
+
+%%Returns whenever the socket is connected or not.%%
+
+%%Whenever this property becomes true, "connected" event should be dispatched.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:dialer:tcp:property:connected:description&nouser&nolink&nodate}}
+
+
//Overridden from [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]] **(get, set)**.//===== Signature =====
<code>
@@ -23,19 +36,6 @@ Eina_Bool efl_net_dialer_connected_get(const Eo *obj);
void efl_net_dialer_connected_set(Eo *obj, Eina_Bool connected);
</code>
-===== Values =====
-
- * **connected** - %%%%''true''%% if the socket is connected, %%''false''%% otherwise%%
-===== Description =====
-
-%%Returns whenever the socket is connected or not.%%
-
-%%Whenever this property becomes true, "connected" event should be dispatched.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:dialer:tcp:property:connected:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]]
diff --git a/pages/develop/api/efl/net/dialer/tcp/property/proxy.txt b/pages/develop/api/efl/net/dialer/tcp/property/proxy.txt
index f318acaf5..612d34a1d 100644
--- a/pages/develop/api/efl/net/dialer/tcp/property/proxy.txt
+++ b/pages/develop/api/efl/net/dialer/tcp/property/proxy.txt
@@ -1,4 +1,25 @@
~~Title: Efl.Net.Dialer.Tcp.proxy~~
+===== Values =====
+
+ * **proxy_url** - %%May be empty or NULL to unset%%
+===== Description =====
+
+%%Controls/retrieves if the dialer should use a proxy.%%
+
+%%The proxy is an URL in the form:%%
+
+%%- protocol://username:password@proxyserver:port%%
+
+%%Where protocol is defined per class, such as a TCP or UDP dialer will use 'socks4', 'socks4a', 'socks5' or 'socks5h'; while http and websocket will want those or 'http'.%%
+
+%%Whenever appropriate dialers may use system proxy if the proxy is NULL (the default). To forcefully disable proxy, use an empty string ("").%%
+
+%%- http://username:password@proxyserver:port - http://username@proxyserver:port - http://proxyserver:port - http://proxyserver (default port) - socks5://username:password@proxyserver:port (SOCKSv5) - socks5h://username@proxyserver:port (let socks server to resolve domain) - socks5://proxyserver:port - socks5://proxyserver (default port 1080) - socks4a://proxyserver:port (SOCKSv4 and let socks server to resolve domain) - socks4://proxyserver:port (SOCKSv4)%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:dialer:tcp:property:proxy:description&nouser&nolink&nodate}}
+
+
//Overridden from [[:develop:api:efl:net:dialer:property:proxy|Efl.Net.Dialer.proxy]] **(get, set)**.//===== Signature =====
<code>
@@ -23,27 +44,6 @@ const char *efl_net_dialer_proxy_get(const Eo *obj);
void efl_net_dialer_proxy_set(Eo *obj, const char *proxy_url);
</code>
-===== Values =====
-
- * **proxy_url** - %%May be empty or NULL to unset%%
-===== Description =====
-
-%%Controls/retrieves if the dialer should use a proxy.%%
-
-%%The proxy is an URL in the form:%%
-
-%%- protocol://username:password@proxyserver:port%%
-
-%%Where protocol is defined per class, such as a TCP or UDP dialer will use 'socks4', 'socks4a', 'socks5' or 'socks5h'; while http and websocket will want those or 'http'.%%
-
-%%Whenever appropriate dialers may use system proxy if the proxy is NULL (the default). To forcefully disable proxy, use an empty string ("").%%
-
-%%- http://username:password@proxyserver:port - http://username@proxyserver:port - http://proxyserver:port - http://proxyserver (default port) - socks5://username:password@proxyserver:port (SOCKSv5) - socks5h://username@proxyserver:port (let socks server to resolve domain) - socks5://proxyserver:port - socks5://proxyserver (default port 1080) - socks4a://proxyserver:port (SOCKSv4 and let socks server to resolve domain) - socks4://proxyserver:port (SOCKSv4)%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:dialer:tcp:property:proxy:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* [[:develop:api:efl:net:dialer:property:proxy|Efl.Net.Dialer.proxy]]
diff --git a/pages/develop/api/efl/net/dialer/tcp/property/timeout_dial.txt b/pages/develop/api/efl/net/dialer/tcp/property/timeout_dial.txt
index e3d4ea9f9..d574e3427 100644
--- a/pages/develop/api/efl/net/dialer/tcp/property/timeout_dial.txt
+++ b/pages/develop/api/efl/net/dialer/tcp/property/timeout_dial.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Net.Dialer.Tcp.timeout_dial~~
+===== Values =====
+
+ * **seconds** - %%Timeout value is seconds%%
+===== Description =====
+
+%%The timeout in seconds to use for dialing/connecting.%%
+
+%%This should be set before dialing.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:net:dialer:tcp:property:timeout_dial:description&nouser&nolink&nodate}}
+
+
//Overridden from [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]] **(get, set)**.//===== Signature =====
<code>
@@ -23,19 +36,6 @@ double efl_net_dialer_timeout_dial_get(const Eo *obj);
void efl_net_dialer_timeout_dial_set(Eo *obj, double seconds);
</code>
-===== Values =====
-
- * **seconds** - %%Timeout value is seconds%%
-===== Description =====
-
-%%The timeout in seconds to use for dialing/connecting.%%
-
-%%This should be set before dialing.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:net:dialer:tcp:property:timeout_dial:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]]