summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/dialer/unix
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-11-29 12:02:18 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-11-29 12:02:18 +0100
commit005b875e15f138926b07bc0ab226ac880fe34416 (patch)
treee4c715c970d80e5e46a614a3c699753f211ebc3f /pages/develop/api/efl/net/dialer/unix
parenta5b73ce5680864276c941cf8c8947ecb51cf339b (diff)
Update C API reference guide to 1.23
Generated with edocgen.lua from efl.git branch efl-1.23
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, 0 insertions, 243 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
deleted file mode 100644
index e3fe082..0000000
--- a/pages/develop/api/efl/net/dialer/unix/method/close.txt
+++ /dev/null
@@ -1,30 +0,0 @@
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
13//Overridden from [[:develop:api:efl:net:socket:fd:method:close|Efl.Io.Closer.close]].//===== Signature =====
14
15<code>
16close @pure_virtual {
17 return: Eina.Error;
18}
19</code>
20
21===== C signature =====
22
23<code c>
24Eina_Error efl_io_closer_close(Eo *obj);
25</code>
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
deleted file mode 100644
index 1bbd9d7..0000000
--- a/pages/develop/api/efl/net/dialer/unix/method/constructor.txt
+++ /dev/null
@@ -1,26 +0,0 @@
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
9//Overridden from [[:develop:api:efl:net:socket:fd:method:constructor|Efl.Object.constructor]].//===== Signature =====
10
11<code>
12constructor {
13 return: free(Efl.Object, efl_del);
14}
15</code>
16
17===== C signature =====
18
19<code c>
20Efl_Object *efl_constructor(Eo *obj);
21</code>
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
deleted file mode 100644
index e61bd57..0000000
--- a/pages/develop/api/efl/net/dialer/unix/method/destructor.txt
+++ /dev/null
@@ -1,24 +0,0 @@
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
9//Overridden from [[:develop:api:efl:net:socket:fd:method:destructor|Efl.Object.destructor]].//===== Signature =====
10
11<code>
12destructor {}
13</code>
14
15===== C signature =====
16
17<code c>
18void efl_destructor(Eo *obj);
19</code>
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
deleted file mode 100644
index 406c689..0000000
--- a/pages/develop/api/efl/net/dialer/unix/method/dial.txt
+++ /dev/null
@@ -1,37 +0,0 @@
1~~Title: Efl.Net.Dialer.Unix.dial~~
2===== Description =====
3
4%%Dials to the remote peer.%%
5
6%%This method starts the connection process, resolves the address and then proceeds 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
13//Overridden from [[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]].//===== Signature =====
14
15<code>
16dial @pure_virtual {
17 params {
18 @in address: free(string, free) @nonull;
19 }
20 return: Eina.Error;
21}
22</code>
23
24===== C signature =====
25
26<code c>
27Eina_Error efl_net_dialer_dial(Eo *obj, const char *address);
28</code>
29
30===== Parameters =====
31
32 * **address** //(in)// - %%Remote address%%
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
deleted file mode 100644
index d754231..0000000
--- a/pages/develop/api/efl/net/dialer/unix/property/address_dial.txt
+++ /dev/null
@@ -1,42 +0,0 @@
1~~Title: Efl.Net.Dialer.Unix.address_dial~~
2===== Description =====
3
4%%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%%
5
6%%If the resolved address is required, listen to "resolved" event and use the %%[[:develop:api:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]]%% property.%%
7
8//Since 1.19//
9{{page>:develop:api-include:efl:net:dialer:unix:property:address_dial:description&nouser&nolink&nodate}}
10
11===== Values =====
12
13 * **address** - %%Remote address%%
14
15//Overridden from [[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]] **(get, set)**.//===== Signature =====
16
17<code>
18@property address_dial @pure_virtual {
19 get {
20 values {
21 address: free(string, free);
22 }
23 }
24 set @protected {
25 values {
26 address: free(string, free);
27 }
28 }
29}
30</code>
31
32===== C signature =====
33
34<code c>
35const char *efl_net_dialer_address_dial_get(const Eo *obj);
36void efl_net_dialer_address_dial_set(Eo *obj, const char *address);
37</code>
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
deleted file mode 100644
index 8817de6..0000000
--- a/pages/develop/api/efl/net/dialer/unix/property/connected.txt
+++ /dev/null
@@ -1,42 +0,0 @@
1~~Title: Efl.Net.Dialer.Unix.connected~~
2===== Description =====
3
4%%Returns whenever the socket is connected or not.%%
5
6%%Whenever this property becomes true the "connected" event should be dispatched.%%
7
8//Since 1.19//
9{{page>:develop:api-include:efl:net:dialer:unix:property:connected:description&nouser&nolink&nodate}}
10
11===== Values =====
12
13 * **connected** - %%%%''true''%% if the socket is connected, %%''false''%% otherwise%%
14
15//Overridden from [[:develop:api:efl:net:dialer:property:connected|Efl.Net.Dialer.connected]] **(get, set)**.//===== Signature =====
16
17<code>
18@property connected @pure_virtual {
19 get {
20 values {
21 connected: bool;
22 }
23 }
24 set @protected {
25 values {
26 connected: bool;
27 }
28 }
29}
30</code>
31
32===== C signature =====
33
34<code c>
35Eina_Bool efl_net_dialer_connected_get(const Eo *obj);
36void efl_net_dialer_connected_set(Eo *obj, Eina_Bool connected);
37</code>
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
deleted file mode 100644
index bcbe2f5..0000000
--- a/pages/develop/api/efl/net/dialer/unix/property/timeout_dial.txt
+++ /dev/null
@@ -1,42 +0,0 @@
1~~Title: Efl.Net.Dialer.Unix.timeout_dial~~
2===== Description =====
3
4%%The timeout in seconds to use for dialing/connecting.%%
5
6%%This should be set before dialing.%%
7
8//Since 1.19//
9{{page>:develop:api-include:efl:net:dialer:unix:property:timeout_dial:description&nouser&nolink&nodate}}
10
11===== Values =====
12
13 * **seconds** - %%Timeout value is seconds%%
14
15//Overridden from [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]] **(get, set)**.//===== Signature =====
16
17<code>
18@property timeout_dial @pure_virtual {
19 get {
20 values {
21 seconds: double;
22 }
23 }
24 set {
25 values {
26 seconds: double;
27 }
28 }
29}
30</code>
31
32===== C signature =====
33
34<code c>
35double efl_net_dialer_timeout_dial_get(const Eo *obj);
36void efl_net_dialer_timeout_dial_set(Eo *obj, double seconds);
37</code>
38
39===== Implemented by =====
40
41 * [[:develop:api:efl:net:dialer:property:timeout_dial|Efl.Net.Dialer.timeout_dial]]
42