summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/socket/fd
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/socket/fd
parent7dd88611a2938001370bdbac9b72b4a25854a2d0 (diff)
Updated Unified API docs with latest generator
Diffstat (limited to 'pages/develop/api/efl/net/socket/fd')
-rw-r--r--pages/develop/api/efl/net/socket/fd/method/close.txt30
-rw-r--r--pages/develop/api/efl/net/socket/fd/method/constructor.txt26
-rw-r--r--pages/develop/api/efl/net/socket/fd/method/destructor.txt24
-rw-r--r--pages/develop/api/efl/net/socket/fd/method/finalize.txt24
-rw-r--r--pages/develop/api/efl/net/socket/fd/method/read.txt37
-rw-r--r--pages/develop/api/efl/net/socket/fd/method/write.txt39
-rw-r--r--pages/develop/api/efl/net/socket/fd/property/address_local.txt44
-rw-r--r--pages/develop/api/efl/net/socket/fd/property/address_remote.txt44
-rw-r--r--pages/develop/api/efl/net/socket/fd/property/can_read.txt40
-rw-r--r--pages/develop/api/efl/net/socket/fd/property/can_write.txt40
-rw-r--r--pages/develop/api/efl/net/socket/fd/property/closed.txt50
-rw-r--r--pages/develop/api/efl/net/socket/fd/property/eos.txt40
-rw-r--r--pages/develop/api/efl/net/socket/fd/property/family.txt44
-rw-r--r--pages/develop/api/efl/net/socket/fd/property/fd.txt45
14 files changed, 527 insertions, 0 deletions
diff --git a/pages/develop/api/efl/net/socket/fd/method/close.txt b/pages/develop/api/efl/net/socket/fd/method/close.txt
new file mode 100644
index 0000000..4fd08de
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/method/close.txt
@@ -0,0 +1,30 @@
1~~Title: Efl.Net.Socket.Fd.close~~
2//Overridden from [[:develop:api:efl:io:closer: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:socket:fd: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/socket/fd/method/constructor.txt b/pages/develop/api/efl/net/socket/fd/method/constructor.txt
new file mode 100644
index 0000000..854149e
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/method/constructor.txt
@@ -0,0 +1,26 @@
1~~Title: Efl.Net.Socket.Fd.constructor~~
2//Overridden from [[:develop:api:efl:loop: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:socket:fd: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/socket/fd/method/destructor.txt b/pages/develop/api/efl/net/socket/fd/method/destructor.txt
new file mode 100644
index 0000000..d057015
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/method/destructor.txt
@@ -0,0 +1,24 @@
1~~Title: Efl.Net.Socket.Fd.destructor~~
2//Overridden from [[:develop:api:efl:loop: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:socket:fd: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/socket/fd/method/finalize.txt b/pages/develop/api/efl/net/socket/fd/method/finalize.txt
new file mode 100644
index 0000000..f3accf7
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/method/finalize.txt
@@ -0,0 +1,24 @@
1~~Title: Efl.Net.Socket.Fd.finalize~~
2//Overridden from [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]].//===== Signature =====
3
4<code>
5finalize {
6 return: free(Efl.Object, efl_del);
7}
8</code>
9
10===== C signature =====
11
12<code c>
13Efl_Object *efl_finalize(Eo *obj);
14</code>
15
16===== Description =====
17
18%%Called at the end of #eo_add. Should not be called, just overridden.%%
19{{page>:develop:api-include:efl:net:socket:fd:method:finalize:description&nouser&nolink&nodate}}
20
21===== Implemented by =====
22
23 * [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]]
24
diff --git a/pages/develop/api/efl/net/socket/fd/method/read.txt b/pages/develop/api/efl/net/socket/fd/method/read.txt
new file mode 100644
index 0000000..867ae55
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/method/read.txt
@@ -0,0 +1,37 @@
1~~Title: Efl.Net.Socket.Fd.read~~
2//Overridden from [[:develop:api:efl:io:reader:fd:method:read|Efl.Io.Reader.read]].//===== Signature =====
3
4<code>
5read @pure_virtual {
6 params {
7 @inout rw_slice: Eina.Rw_Slice @nonull;
8 }
9 return: Eina.Error;
10}
11</code>
12
13===== C signature =====
14
15<code c>
16Eina_Error efl_io_reader_read(Eo *obj, Eina_Rw_Slice rw_slice);
17</code>
18
19===== Parameters =====
20
21 * **rw_slice** //(inout)// - %%Provides a pre-allocated memory to be filled up to rw_slice.len. It will be populated and the length will be set to the actually used amount of bytes, which can be smaller than the request.%%
22
23===== Description =====
24
25%%Reads data into a pre-allocated buffer.%%
26
27%%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.%%
28
29%%You can understand this method as read(2) libc function.%%
30
31//Since 1.19//
32{{page>:develop:api-include:efl:net:socket:fd:method:read:description&nouser&nolink&nodate}}
33
34===== Implemented by =====
35
36 * [[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]
37
diff --git a/pages/develop/api/efl/net/socket/fd/method/write.txt b/pages/develop/api/efl/net/socket/fd/method/write.txt
new file mode 100644
index 0000000..25d1f27
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/method/write.txt
@@ -0,0 +1,39 @@
1~~Title: Efl.Net.Socket.Fd.write~~
2//Overridden from [[:develop:api:efl:io:writer:fd:method:write|Efl.Io.Writer.write]].//===== Signature =====
3
4<code>
5write @pure_virtual {
6 params {
7 @inout slice: Eina.Slice @nonull;
8 @out remaining: Eina.Slice @optional;
9 }
10 return: Eina.Error;
11}
12</code>
13
14===== C signature =====
15
16<code c>
17Eina_Error efl_io_writer_write(Eo *obj, Eina_Slice slice, Eina_Slice *remaining);
18</code>
19
20===== Parameters =====
21
22 * **slice** //(inout)// - %%Provides a pre-populated memory to be used up to slice.len. The returned slice will be adapted as length will be set to the actually used amount of bytes, which can be smaller than the request.%%
23 * **remaining** //(out)// - %%Convenience to output the remaining parts of slice that was not written. If the full slice was written, this will be a slice of zero-length.%%
24
25===== Description =====
26
27%%Writes data from a pre-populated buffer.%%
28
29%%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.%%
30
31%%You can understand this method as write(2) libc function.%%
32
33//Since 1.19//
34{{page>:develop:api-include:efl:net:socket:fd:method:write:description&nouser&nolink&nodate}}
35
36===== Implemented by =====
37
38 * [[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]]
39
diff --git a/pages/develop/api/efl/net/socket/fd/property/address_local.txt b/pages/develop/api/efl/net/socket/fd/property/address_local.txt
new file mode 100644
index 0000000..0ae21ca
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/property/address_local.txt
@@ -0,0 +1,44 @@
1~~Title: Efl.Net.Socket.Fd.address_local~~
2//Overridden from [[:develop:api:efl:net:socket:property:address_local|Efl.Net.Socket.address_local]] **(get, set)**.//===== Signature =====
3
4<code>
5@property address_local @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_socket_address_local_get(const Eo *obj);
23void efl_net_socket_address_local_set(Eo *obj, const char *address);
24</code>
25
26===== Values =====
27
28 * **address** - %%Local address%%
29===== Description =====
30
31%%The local address, similar to getsockname().%%
32
33%%The actual value depends on the type of socket, like an IPv4 (ip:port) or IPv6 ([ip]:port) formatted for a TCP/UDP socket, the path if an Unix Local...%%
34
35%%It's always resolved, then if operations are working with domain names or URL, this is the values the kernel reports. It's similar to getsockname() in behavior.%%
36
37//Since 1.19//
38{{page>:develop:api-include:efl:net:socket:fd:property:address_local:description&nouser&nolink&nodate}}
39
40
41===== Implemented by =====
42
43 * [[:develop:api:efl:net:socket:property:address_local|Efl.Net.Socket.address_local]]
44
diff --git a/pages/develop/api/efl/net/socket/fd/property/address_remote.txt b/pages/develop/api/efl/net/socket/fd/property/address_remote.txt
new file mode 100644
index 0000000..2e48b18
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/property/address_remote.txt
@@ -0,0 +1,44 @@
1~~Title: Efl.Net.Socket.Fd.address_remote~~
2//Overridden from [[:develop:api:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]] **(get, set)**.//===== Signature =====
3
4<code>
5@property address_remote @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_socket_address_remote_get(const Eo *obj);
23void efl_net_socket_address_remote_set(Eo *obj, const char *address);
24</code>
25
26===== Values =====
27
28 * **address** - %%Remote address%%
29===== Description =====
30
31%%The remote address, similar to getpeername().%%
32
33%%The actual value depends on the type of socket, like an IPv4 (ip:port) or IPv6 ([ip]:port) formatted for a TCP/UDP socket, the path if an Unix Local...%%
34
35%%It's always resolved, then if operations are working with domain names or URL, this is the values the kernel reports. It's similar to getpeername() in behavior.%%
36
37//Since 1.19//
38{{page>:develop:api-include:efl:net:socket:fd:property:address_remote:description&nouser&nolink&nodate}}
39
40
41===== Implemented by =====
42
43 * [[:develop:api:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]]
44
diff --git a/pages/develop/api/efl/net/socket/fd/property/can_read.txt b/pages/develop/api/efl/net/socket/fd/property/can_read.txt
new file mode 100644
index 0000000..63e6b80
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/property/can_read.txt
@@ -0,0 +1,40 @@
1~~Title: Efl.Net.Socket.Fd.can_read~~
2//Overridden from [[:develop:api:efl:io:reader:fd:property:can_read|Efl.Io.Reader.can_read]] **(set)**.//===== Signature =====
3
4<code>
5@property can_read @pure_virtual {
6 get {
7 values {
8 can_read: bool;
9 }
10 }
11 set @protected {
12 values {
13 can_read: bool;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22Eina_Bool efl_io_reader_can_read_get(const Eo *obj);
23void efl_io_reader_can_read_set(Eo *obj, Eina_Bool can_read);
24</code>
25
26===== Values =====
27
28 * **can_read** - %%%%''true''%% if it can be read without blocking or failing, %%''false''%% otherwise%%
29===== Description =====
30
31%%If %%''true''%% will notify %%[[:develop:api:interface:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
32
33//Since 1.19//
34{{page>:develop:api-include:efl:net:socket:fd:property:can_read:description&nouser&nolink&nodate}}
35
36
37===== Implemented by =====
38
39 * [[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]
40
diff --git a/pages/develop/api/efl/net/socket/fd/property/can_write.txt b/pages/develop/api/efl/net/socket/fd/property/can_write.txt
new file mode 100644
index 0000000..d0e379c
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/property/can_write.txt
@@ -0,0 +1,40 @@
1~~Title: Efl.Net.Socket.Fd.can_write~~
2//Overridden from [[:develop:api:efl:io:writer:fd:property:can_write|Efl.Io.Writer.can_write]] **(set)**.//===== Signature =====
3
4<code>
5@property can_write @pure_virtual {
6 get {
7 values {
8 can_write: bool;
9 }
10 }
11 set @protected {
12 values {
13 can_write: bool;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22Eina_Bool efl_io_writer_can_write_get(const Eo *obj);
23void efl_io_writer_can_write_set(Eo *obj, Eina_Bool can_write);
24</code>
25
26===== Values =====
27
28 * **can_write** - %%%%''true''%% if it can be written without blocking or failure, %%''false''%% otherwise%%
29===== Description =====
30
31%%If %%''true''%% will notify %%[[:develop:api:interface:efl:io:writer:method:write|Efl.Io.Writer.write]]%% can be called without blocking or failing.%%
32
33//Since 1.19//
34{{page>:develop:api-include:efl:net:socket:fd:property:can_write:description&nouser&nolink&nodate}}
35
36
37===== Implemented by =====
38
39 * [[:develop:api:efl:io:writer:property:can_write|Efl.Io.Writer.can_write]]
40
diff --git a/pages/develop/api/efl/net/socket/fd/property/closed.txt b/pages/develop/api/efl/net/socket/fd/property/closed.txt
new file mode 100644
index 0000000..d2bd52d
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/property/closed.txt
@@ -0,0 +1,50 @@
1~~Title: Efl.Net.Socket.Fd.closed~~
2//Overridden from [[:develop:api:efl:io:closer:fd:property:closed|Efl.Io.Closer.closed]] **(get)**.//===== Signature =====
3
4<code>
5@property closed {
6 get {
7 values {
8 is_closed: bool;
9 }
10 }
11 set {
12 values {
13 is_closed: bool;
14 }
15 return: bool;
16 }
17}
18</code>
19
20===== C signature =====
21
22<code c>
23Eina_Bool efl_io_closer_closed_get(const Eo *obj);
24Eina_Bool efl_io_closer_closed_set(Eo *obj, Eina_Bool is_closed);
25</code>
26
27===== Values =====
28
29 * **is_closed** - %%%%''true''%% if closed, %%''false''%% otherwise%%
30===== Description =====
31
32%%If true will notify object was closed.%%
33
34//Since 1.19//
35
36
37{{page>:develop:api-include:efl:net:socket:fd:property:closed:description&nouser&nolink&nodate}}
38
39==== Setter ====
40
41%%If true, calls close()%%
42
43//Since 1.19//
44{{page>:develop:api-include:efl:net:socket:fd:property:closed:getter_description&nouser&nolink&nodate}}
45
46
47===== Implemented by =====
48
49 * [[:develop:api:efl:io:closer:property:closed|Efl.Io.Closer.closed]]
50
diff --git a/pages/develop/api/efl/net/socket/fd/property/eos.txt b/pages/develop/api/efl/net/socket/fd/property/eos.txt
new file mode 100644
index 0000000..878119d
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/property/eos.txt
@@ -0,0 +1,40 @@
1~~Title: Efl.Net.Socket.Fd.eos~~
2//Overridden from [[:develop:api:efl:io:reader:fd:property:eos|Efl.Io.Reader.eos]] **(set)**.//===== Signature =====
3
4<code>
5@property eos @pure_virtual {
6 get {
7 values {
8 is_eos: bool;
9 }
10 }
11 set @protected {
12 values {
13 is_eos: bool;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22Eina_Bool efl_io_reader_eos_get(const Eo *obj);
23void efl_io_reader_eos_set(Eo *obj, Eina_Bool is_eos);
24</code>
25
26===== Values =====
27
28 * **is_eos** - %%%%''true''%% if end of stream, %%''false''%% otherwise%%
29===== Description =====
30
31%%If %%''true''%% will notify end of stream.%%
32
33//Since 1.19//
34{{page>:develop:api-include:efl:net:socket:fd:property:eos:description&nouser&nolink&nodate}}
35
36
37===== Implemented by =====
38
39 * [[:develop:api:efl:io:reader:property:eos|Efl.Io.Reader.eos]]
40
diff --git a/pages/develop/api/efl/net/socket/fd/property/family.txt b/pages/develop/api/efl/net/socket/fd/property/family.txt
new file mode 100644
index 0000000..f78c19d
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/property/family.txt
@@ -0,0 +1,44 @@
1~~Title: Efl.Net.Socket.Fd.family~~
2===== Signature =====
3
4<code>
5@property family {
6 get {
7 values {
8 family: int;
9 }
10 }
11 set @protected {
12 values {
13 family: int;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22int efl_net_socket_fd_family_get(const Eo *obj);
23void efl_net_socket_fd_family_set(Eo *obj, int family);
24</code>
25
26===== Values =====
27
28 * **family** - %%Address family%%
29===== Description =====
30
31%%The address family (AF_*) family of this socket.%%
32
33%%It will be one of AF_INET (IPv4), AF_INET6 (IPv6), AF_UNIX...%%
34
35%%It must be set before the %%[[:develop:api:class:efl:loop:fd:property:fd|Efl.Loop.Fd.fd.set]]%% is called with a valid file descriptor.%%
36
37//Since 1.19//
38{{page>:develop:api-include:efl:net:socket:fd:property:family:description&nouser&nolink&nodate}}
39
40
41===== Implemented by =====
42
43 * **Efl.Net.Socket.Fd.family**
44
diff --git a/pages/develop/api/efl/net/socket/fd/property/fd.txt b/pages/develop/api/efl/net/socket/fd/property/fd.txt
new file mode 100644
index 0000000..9155d21
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd/property/fd.txt
@@ -0,0 +1,45 @@
1~~Title: Efl.Net.Socket.Fd.fd~~
2//Overridden from [[:develop:api:efl:loop:fd:property:fd|Efl.Loop.Fd.fd]] **(set)**.//===== Signature =====
3
4<code>
5@property fd {
6 get {
7 values {
8 fd: int;
9 }
10 }
11 set {
12 values {
13 fd: int;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22int efl_loop_fd_get(const Eo *obj);
23void efl_loop_fd_set(Eo *obj, int fd);
24</code>
25
26===== Values =====
27
28 * **fd** - %%The file descriptor.%%
29===== Description =====
30
31%%Defines which file descriptor to watch. If it is a file, use file_fd variant.%%
32
33
34{{page>:develop:api-include:efl:net:socket:fd:property:fd:description&nouser&nolink&nodate}}
35
36==== Setter ====
37
38%%Defines the fd to watch on.%%
39{{page>:develop:api-include:efl:net:socket:fd:property:fd:getter_description&nouser&nolink&nodate}}
40
41
42===== Implemented by =====
43
44 * [[:develop:api:efl:loop:fd:property:fd|Efl.Loop.Fd.fd]]
45