summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/dialer/unix
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-11 16:59:35 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-11 16:59:49 +0000
commit2782d0c642dcea66ee93d10fa12d78f130e66cdb (patch)
treebd3a7c81cff9903b042a11a1c30efc8760c617ff /pages/develop/api/efl/net/dialer/unix
parent7dd88611a2938001370bdbac9b72b4a25854a2d0 (diff)
Updated Unified API docs with latest generator
Diffstat (limited to 'pages/develop/api/efl/net/dialer/unix')
-rw-r--r--pages/develop/api/efl/net/dialer/unix/method/close.txt30
-rw-r--r--pages/develop/api/efl/net/dialer/unix/method/constructor.txt26
-rw-r--r--pages/develop/api/efl/net/dialer/unix/method/destructor.txt24
-rw-r--r--pages/develop/api/efl/net/dialer/unix/method/dial.txt37
-rw-r--r--pages/develop/api/efl/net/dialer/unix/property/address_dial.txt42
-rw-r--r--pages/develop/api/efl/net/dialer/unix/property/connected.txt42
-rw-r--r--pages/develop/api/efl/net/dialer/unix/property/timeout_dial.txt42
7 files changed, 243 insertions, 0 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
new file mode 100644
index 0000000..7db9833
--- /dev/null
+++ b/pages/develop/api/efl/net/dialer/unix/method/close.txt
@@ -0,0 +1,30 @@
1~~Title: Efl.Net.Dialer.Unix.close~~
2//Overridden from [[:develop:api:efl:net:socket:fd:method:close|Efl.Io.Closer.close]].//===== Signature =====
3
4<code>
5close @pure_virtual {
6 return: Eina.Error;
7}
8</code>
9
10===== C signature =====
11
12<code c>
13Eina_Error efl_io_closer_close(Eo *obj);
14</code>
15
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 =====
28
29 * [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]]
30
diff --git a/pages/develop/api/efl/net/dialer/unix/method/constructor.txt b/pages/develop/api/efl/net/dialer/unix/method/constructor.txt
new file mode 100644
index 0000000..47e9c3d
--- /dev/null
+++ b/pages/develop/api/efl/net/dialer/unix/method/constructor.txt
@@ -0,0 +1,26 @@
1~~Title: Efl.Net.Dialer.Unix.constructor~~
2//Overridden from [[:develop:api:efl:net:socket:fd:method:constructor|Efl.Object.constructor]].//===== Signature =====
3
4<code>
5constructor {
6 return: free(Efl.Object, efl_del);
7}
8</code>
9
10===== C signature =====
11
12<code c>
13Efl_Object *efl_constructor(Eo *obj);
14</code>
15
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 =====
24
25 * [[:develop:api:efl:object:method:constructor|Efl.Object.constructor]]
26
diff --git a/pages/develop/api/efl/net/dialer/unix/method/destructor.txt b/pages/develop/api/efl/net/dialer/unix/method/destructor.txt
new file mode 100644
index 0000000..3b68ad7
--- /dev/null
+++ b/pages/develop/api/efl/net/dialer/unix/method/destructor.txt
@@ -0,0 +1,24 @@
1~~Title: Efl.Net.Dialer.Unix.destructor~~
2//Overridden from [[:develop:api:efl:net:socket:fd:method:destructor|Efl.Object.destructor]].//===== Signature =====
3
4<code>
5destructor {}
6</code>
7
8===== C signature =====
9
10<code c>
11void efl_destructor(Eo *obj);
12</code>
13
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 =====
22
23 * [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]]
24
diff --git a/pages/develop/api/efl/net/dialer/unix/method/dial.txt b/pages/develop/api/efl/net/dialer/unix/method/dial.txt
new file mode 100644
index 0000000..a334a42
--- /dev/null
+++ b/pages/develop/api/efl/net/dialer/unix/method/dial.txt
@@ -0,0 +1,37 @@
1~~Title: Efl.Net.Dialer.Unix.dial~~
2//Overridden from [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]].//===== Signature =====
3
4<code>
5dial @pure_virtual {
6 params {
7 @in address: free(string, free) @nonull;
8 }
9 return: Eina.Error;
10}
11</code>
12
13===== C signature =====
14
15<code c>
16Eina_Error efl_net_dialer_dial(Eo *obj, const char *address);
17</code>
18
19===== Parameters =====
20
21 * **address** //(in)// - %%Remote address%%
22
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 =====
35
36 * [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]
37
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
new file mode 100644
index 0000000..2ded3c2
--- /dev/null
+++ b/pages/develop/api/efl/net/dialer/unix/property/address_dial.txt
@@ -0,0 +1,42 @@
1~~Title: Efl.Net.Dialer.Unix.address_dial~~
2//Overridden from [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]] **(get, set)**.//===== Signature =====
3
4<code>
5@property address_dial @pure_virtual {
6 get {
7 values {
8 address: free(string, free);
9 }
10 }
11 set @protected {
12 values {
13 address: free(string, free);
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22const char *efl_net_dialer_address_dial_get(const Eo *obj);
23void efl_net_dialer_address_dial_set(Eo *obj, const char *address);
24</code>
25
26===== Values =====
27
28 * **address** - %%Remote address%%
29===== Description =====
30
31%%Returns the address given to %%[[:develop:api:interface: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:interface: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 =====
40
41 * [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]]
42
diff --git a/pages/develop/api/efl/net/dialer/unix/property/connected.txt b/pages/develop/api/efl/net/dialer/unix/property/connected.txt
new file mode 100644
index 0000000..bde3716
--- /dev/null
+++ b/pages/develop/api/efl/net/dialer/unix/property/connected.txt
@@ -0,0 +1,42 @@
1~~Title: Efl.Net.Dialer.Unix.connected~~
2//Overridden from [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]] **(get, set)**.//===== Signature =====
3
4<code>
5@property connected @pure_virtual {
6 get {
7 values {
8 connected: bool;
9 }
10 }
11 set @protected {
12 values {
13 connected: bool;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22Eina_Bool efl_net_dialer_connected_get(const Eo *obj);
23void efl_net_dialer_connected_set(Eo *obj, Eina_Bool connected);
24</code>
25
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 =====
40
41 * [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]]
42
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
new file mode 100644
index 0000000..ad7fe92
--- /dev/null
+++ b/pages/develop/api/efl/net/dialer/unix/property/timeout_dial.txt
@@ -0,0 +1,42 @@
1~~Title: Efl.Net.Dialer.Unix.timeout_dial~~
2//Overridden from [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]] **(get, set)**.//===== Signature =====
3
4<code>
5@property timeout_dial @pure_virtual {
6 get {
7 values {
8 seconds: double;
9 }
10 }
11 set {
12 values {
13 seconds: double;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22double efl_net_dialer_timeout_dial_get(const Eo *obj);
23void efl_net_dialer_timeout_dial_set(Eo *obj, double seconds);
24</code>
25
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 =====
40
41 * [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]]
42