summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/dialer/unix
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/dialer/unix
parente3401bceb2a041fc39682a834ca107feac2c8642 (diff)
api: Use the latest API generation code
Diffstat (limited to 'pages/develop/api/efl/net/dialer/unix')
-rw-r--r--pages/develop/api/efl/net/dialer/unix/method/close.txt22
-rw-r--r--pages/develop/api/efl/net/dialer/unix/method/constructor.txt14
-rw-r--r--pages/develop/api/efl/net/dialer/unix/method/destructor.txt14
-rw-r--r--pages/develop/api/efl/net/dialer/unix/method/dial.txt22
-rw-r--r--pages/develop/api/efl/net/dialer/unix/property/address_dial.txt26
-rw-r--r--pages/develop/api/efl/net/dialer/unix/property/connected.txt26
-rw-r--r--pages/develop/api/efl/net/dialer/unix/property/timeout_dial.txt26
7 files changed, 75 insertions, 75 deletions
diff --git a/pages/develop/api/efl/net/dialer/unix/method/close.txt b/pages/develop/api/efl/net/dialer/unix/method/close.txt
index 7db9833..e3fe082 100644
--- a/pages/develop/api/efl/net/dialer/unix/method/close.txt
+++ b/pages/develop/api/efl/net/dialer/unix/method/close.txt
@@ -1,4 +1,15 @@
1~~Title: Efl.Net.Dialer.Unix.close~~ 1~~Title: Efl.Net.Dialer.Unix.close~~
2===== Description =====
3
4%%Closes the Input/Output object.%%
5
6%%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.%%
7
8%%You can understand this method as close(2) libc function.%%
9
10//Since 1.19//
11{{page>:develop:api-include:efl:net:dialer:unix:method:close:description&nouser&nolink&nodate}}
12
2//Overridden from [[:develop:api:efl:net:socket:fd:method:close|Efl.Io.Closer.close]].//===== Signature ===== 13//Overridden from [[:develop:api:efl:net:socket:fd:method:close|Efl.Io.Closer.close]].//===== Signature =====
3 14
4<code> 15<code>
@@ -13,17 +24,6 @@ close @pure_virtual {
13Eina_Error efl_io_closer_close(Eo *obj); 24Eina_Error efl_io_closer_close(Eo *obj);
14</code> 25</code>
15 26
16===== Description =====
17
18%%Closes the Input/Output object.%%
19
20%%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.%%
21
22%%You can understand this method as close(2) libc function.%%
23
24//Since 1.19//
25{{page>:develop:api-include:efl:net:dialer:unix:method:close:description&nouser&nolink&nodate}}
26
27===== Implemented by ===== 27===== Implemented by =====
28 28
29 * [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]] 29 * [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]]
diff --git a/pages/develop/api/efl/net/dialer/unix/method/constructor.txt b/pages/develop/api/efl/net/dialer/unix/method/constructor.txt
index 47e9c3d..1bbd9d7 100644
--- a/pages/develop/api/efl/net/dialer/unix/method/constructor.txt
+++ b/pages/develop/api/efl/net/dialer/unix/method/constructor.txt
@@ -1,4 +1,11 @@
1~~Title: Efl.Net.Dialer.Unix.constructor~~ 1~~Title: Efl.Net.Dialer.Unix.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:dialer:unix:method:constructor:description&nouser&nolink&nodate}}
8
2//Overridden from [[:develop:api:efl:net:socket:fd:method:constructor|Efl.Object.constructor]].//===== Signature ===== 9//Overridden from [[:develop:api:efl:net:socket:fd: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:dialer:unix: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/dialer/unix/method/destructor.txt b/pages/develop/api/efl/net/dialer/unix/method/destructor.txt
index 3b68ad7..e61bd57 100644
--- a/pages/develop/api/efl/net/dialer/unix/method/destructor.txt
+++ b/pages/develop/api/efl/net/dialer/unix/method/destructor.txt
@@ -1,4 +1,11 @@
1~~Title: Efl.Net.Dialer.Unix.destructor~~ 1~~Title: Efl.Net.Dialer.Unix.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:dialer:unix:method:destructor:description&nouser&nolink&nodate}}
8
2//Overridden from [[:develop:api:efl:net:socket:fd:method:destructor|Efl.Object.destructor]].//===== Signature ===== 9//Overridden from [[:develop:api:efl:net:socket: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:dialer:unix: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/dialer/unix/method/dial.txt b/pages/develop/api/efl/net/dialer/unix/method/dial.txt
index a334a42..87dba6b 100644
--- a/pages/develop/api/efl/net/dialer/unix/method/dial.txt
+++ b/pages/develop/api/efl/net/dialer/unix/method/dial.txt
@@ -1,4 +1,15 @@
1~~Title: Efl.Net.Dialer.Unix.dial~~ 1~~Title: Efl.Net.Dialer.Unix.dial~~
2===== Description =====
3
4%%Dials to the remote peer.%%
5
6%%This method starts the connection process, resolving address and then proceeding to the actual connection.%%
7
8%%Once the connection is fully setup, "connected" event is dispatched.%%
9
10//Since 1.19//
11{{page>:develop:api-include:efl:net:dialer:unix:method:dial:description&nouser&nolink&nodate}}
12
2//Overridden from [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]].//===== Signature ===== 13//Overridden from [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]].//===== Signature =====
3 14
4<code> 15<code>
@@ -20,17 +31,6 @@ Eina_Error efl_net_dialer_dial(Eo *obj, const char *address);
20 31
21 * **address** //(in)// - %%Remote address%% 32 * **address** //(in)// - %%Remote address%%
22 33
23===== Description =====
24
25%%Dials to the remote peer.%%
26
27%%This method starts the connection process, resolving address and then proceeding to the actual connection.%%
28
29%%Once the connection is fully setup, "connected" event is dispatched.%%
30
31//Since 1.19//
32{{page>:develop:api-include:efl:net:dialer:unix:method:dial:description&nouser&nolink&nodate}}
33
34===== Implemented by ===== 34===== Implemented by =====
35 35
36 * [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]] 36 * [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]
diff --git a/pages/develop/api/efl/net/dialer/unix/property/address_dial.txt b/pages/develop/api/efl/net/dialer/unix/property/address_dial.txt
index 35a6d6d..f967527 100644
--- a/pages/develop/api/efl/net/dialer/unix/property/address_dial.txt
+++ b/pages/develop/api/efl/net/dialer/unix/property/address_dial.txt
@@ -1,4 +1,17 @@
1~~Title: Efl.Net.Dialer.Unix.address_dial~~ 1~~Title: Efl.Net.Dialer.Unix.address_dial~~
2===== Values =====
3
4 * **address** - %%Remote address%%
5===== Description =====
6
7%%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%%
8
9%%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.%%
10
11//Since 1.19//
12{{page>:develop:api-include:efl:net:dialer:unix:property:address_dial:description&nouser&nolink&nodate}}
13
14
2//Overridden from [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]] **(get, set)**.//===== Signature ===== 15//Overridden from [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]] **(get, set)**.//===== Signature =====
3 16
4<code> 17<code>
@@ -23,19 +36,6 @@ const char *efl_net_dialer_address_dial_get(const Eo *obj);
23void efl_net_dialer_address_dial_set(Eo *obj, const char *address); 36void efl_net_dialer_address_dial_set(Eo *obj, const char *address);
24</code> 37</code>
25 38
26===== Values =====
27
28 * **address** - %%Remote address%%
29===== Description =====
30
31%%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%%
32
33%%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.%%
34
35//Since 1.19//
36{{page>:develop:api-include:efl:net:dialer:unix:property:address_dial:description&nouser&nolink&nodate}}
37
38
39===== Implemented by ===== 39===== Implemented by =====
40 40
41 * [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]] 41 * [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]]
diff --git a/pages/develop/api/efl/net/dialer/unix/property/connected.txt b/pages/develop/api/efl/net/dialer/unix/property/connected.txt
index bde3716..217db41 100644
--- a/pages/develop/api/efl/net/dialer/unix/property/connected.txt
+++ b/pages/develop/api/efl/net/dialer/unix/property/connected.txt
@@ -1,4 +1,17 @@
1~~Title: Efl.Net.Dialer.Unix.connected~~ 1~~Title: Efl.Net.Dialer.Unix.connected~~
2===== Values =====
3
4 * **connected** - %%%%''true''%% if the socket is connected, %%''false''%% otherwise%%
5===== Description =====
6
7%%Returns whenever the socket is connected or not.%%
8
9%%Whenever this property becomes true, "connected" event should be dispatched.%%
10
11//Since 1.19//
12{{page>:develop:api-include:efl:net:dialer:unix:property:connected:description&nouser&nolink&nodate}}
13
14
2//Overridden from [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]] **(get, set)**.//===== Signature ===== 15//Overridden from [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]] **(get, set)**.//===== Signature =====
3 16
4<code> 17<code>
@@ -23,19 +36,6 @@ Eina_Bool efl_net_dialer_connected_get(const Eo *obj);
23void efl_net_dialer_connected_set(Eo *obj, Eina_Bool connected); 36void efl_net_dialer_connected_set(Eo *obj, Eina_Bool connected);
24</code> 37</code>
25 38
26===== Values =====
27
28 * **connected** - %%%%''true''%% if the socket is connected, %%''false''%% otherwise%%
29===== Description =====
30
31%%Returns whenever the socket is connected or not.%%
32
33%%Whenever this property becomes true, "connected" event should be dispatched.%%
34
35//Since 1.19//
36{{page>:develop:api-include:efl:net:dialer:unix:property:connected:description&nouser&nolink&nodate}}
37
38
39===== Implemented by ===== 39===== Implemented by =====
40 40
41 * [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]] 41 * [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]]
diff --git a/pages/develop/api/efl/net/dialer/unix/property/timeout_dial.txt b/pages/develop/api/efl/net/dialer/unix/property/timeout_dial.txt
index ad7fe92..695af99 100644
--- a/pages/develop/api/efl/net/dialer/unix/property/timeout_dial.txt
+++ b/pages/develop/api/efl/net/dialer/unix/property/timeout_dial.txt
@@ -1,4 +1,17 @@
1~~Title: Efl.Net.Dialer.Unix.timeout_dial~~ 1~~Title: Efl.Net.Dialer.Unix.timeout_dial~~
2===== Values =====
3
4 * **seconds** - %%Timeout value is seconds%%
5===== Description =====
6
7%%The timeout in seconds to use for dialing/connecting.%%
8
9%%This should be set before dialing.%%
10
11//Since 1.19//
12{{page>:develop:api-include:efl:net:dialer:unix:property:timeout_dial:description&nouser&nolink&nodate}}
13
14
2//Overridden from [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]] **(get, set)**.//===== Signature ===== 15//Overridden from [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]] **(get, set)**.//===== Signature =====
3 16
4<code> 17<code>
@@ -23,19 +36,6 @@ double efl_net_dialer_timeout_dial_get(const Eo *obj);
23void efl_net_dialer_timeout_dial_set(Eo *obj, double seconds); 36void efl_net_dialer_timeout_dial_set(Eo *obj, double seconds);
24</code> 37</code>
25 38
26===== Values =====
27
28 * **seconds** - %%Timeout value is seconds%%
29===== Description =====
30
31%%The timeout in seconds to use for dialing/connecting.%%
32
33%%This should be set before dialing.%%
34
35//Since 1.19//
36{{page>:develop:api-include:efl:net:dialer:unix:property:timeout_dial:description&nouser&nolink&nodate}}
37
38
39===== Implemented by ===== 39===== Implemented by =====
40 40
41 * [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]] 41 * [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]]