summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/socket/fd.txt
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.txt
parent7dd88611a2938001370bdbac9b72b4a25854a2d0 (diff)
Updated Unified API docs with latest generator
Diffstat (limited to 'pages/develop/api/efl/net/socket/fd.txt')
-rw-r--r--pages/develop/api/efl/net/socket/fd.txt219
1 files changed, 219 insertions, 0 deletions
diff --git a/pages/develop/api/efl/net/socket/fd.txt b/pages/develop/api/efl/net/socket/fd.txt
new file mode 100644
index 0000000..fc09eae
--- /dev/null
+++ b/pages/develop/api/efl/net/socket/fd.txt
@@ -0,0 +1,219 @@
1~~Title: Efl.Net.Socket.Fd~~
2====== Efl.Net.Socket.Fd (class) ======
3
4===== Description =====
5
6%%A base implementation for sockets over filedescriptors (fd)%%
7
8%%This is the common class and takes an existing FD, usually created by an dialer or server.%%
9
10%%%%[[:develop:api:mixin:efl:io:closer:property:close_on_exec|Efl.Io.Closer.close_on_exec]]%% and %%[[:develop:api:mixin:efl:io:closer:property:close_on_destructor|Efl.Io.Closer.close_on_destructor]]%% are respected and default to %%''true''%%.%%
11
12//Since 1.19//
13
14{{page>:develop:api-include:efl:net:socket:fd:description&nouser&nolink&nodate}}
15
16===== Inheritance =====
17
18 => [[:develop:api:efl:loop:fd|Efl.Loop.Fd]] //(class)// => [[:develop:api:efl:loop_user|Efl.Loop_User]] //(class)// => [[:develop:api:efl:object|Efl.Object]] //(class)//
19++++ Inheritance graph |
20
21<graphviz>
22digraph hierarchy {
23 bgcolor = "transparent"
24 size = "6"
25 rankdir = "TB"
26
27 node [shape = "box"]
28 edge [color = "gray35"]
29
30 efl_net_socket_fd [fillcolor = "black", label = "Efl.Net.Socket.Fd", color = "gray15", fontcolor = "white", style = "filled"]
31 efl_loop_fd [fillcolor = "gray15", label = "Efl.Loop.Fd", color = "gray15", fontcolor = "white", style = "filled"]
32 efl_loop_user [fillcolor = "gray15", label = "Efl.Loop_User", color = "gray15", fontcolor = "white", style = "filled"]
33 efl_object [fillcolor = "gray15", label = "Efl.Object", color = "gray15", fontcolor = "white", style = "filled"]
34 efl_io_reader_fd [fillcolor = "gray15", label = "Efl.Io.Reader.Fd", color = "deepskyblue", fontcolor = "white", style = "filled"]
35 efl_io_reader [fillcolor = "gray15", label = "Efl.Io.Reader", color = "cornflowerblue", fontcolor = "white", style = "filled"]
36 efl_io_writer_fd [fillcolor = "gray15", label = "Efl.Io.Writer.Fd", color = "deepskyblue", fontcolor = "white", style = "filled"]
37 efl_io_writer [fillcolor = "gray15", label = "Efl.Io.Writer", color = "cornflowerblue", fontcolor = "white", style = "filled"]
38 efl_io_closer_fd [fillcolor = "gray15", label = "Efl.Io.Closer.Fd", color = "deepskyblue", fontcolor = "white", style = "filled"]
39 efl_io_closer [fillcolor = "gray15", label = "Efl.Io.Closer", color = "deepskyblue", fontcolor = "white", style = "filled"]
40 efl_object [fillcolor = "gray15", label = "Efl.Object", color = "gray15", fontcolor = "white", style = "filled"]
41 efl_net_socket [fillcolor = "gray15", label = "Efl.Net.Socket", color = "cornflowerblue", fontcolor = "white", style = "filled"]
42 efl_io_reader [fillcolor = "gray15", label = "Efl.Io.Reader", color = "cornflowerblue", fontcolor = "white", style = "filled"]
43 efl_io_writer [fillcolor = "gray15", label = "Efl.Io.Writer", color = "cornflowerblue", fontcolor = "white", style = "filled"]
44 efl_io_closer [fillcolor = "gray15", label = "Efl.Io.Closer", color = "deepskyblue", fontcolor = "white", style = "filled"]
45
46 efl_net_socket_fd -> efl_loop_fd
47 efl_loop_fd -> efl_loop_user
48 efl_loop_user -> efl_object
49 efl_net_socket_fd -> efl_io_reader_fd
50 efl_io_reader_fd -> efl_io_reader
51 efl_net_socket_fd -> efl_io_writer_fd
52 efl_io_writer_fd -> efl_io_writer
53 efl_net_socket_fd -> efl_io_closer_fd
54 efl_io_closer_fd -> efl_io_closer
55 efl_io_closer_fd -> efl_object
56 efl_net_socket_fd -> efl_net_socket
57 efl_net_socket -> efl_io_reader
58 efl_net_socket -> efl_io_writer
59 efl_net_socket -> efl_io_closer
60}
61</graphviz>
62
63++++
64
65++++ Full hierarchy |
66
67 * [[:develop:api:efl:loop:fd|Efl.Loop.Fd]] //(class)//
68 * [[:develop:api:efl:loop_user|Efl.Loop_User]] //(class)//
69 * [[:develop:api:efl:object|Efl.Object]] //(class)//
70 * [[:develop:api:efl:io:reader:fd|Efl.Io.Reader.Fd]] //(mixin)//
71 * [[:develop:api:efl:io:reader|Efl.Io.Reader]] //(interface)//
72 * [[:develop:api:efl:io:writer:fd|Efl.Io.Writer.Fd]] //(mixin)//
73 * [[:develop:api:efl:io:writer|Efl.Io.Writer]] //(interface)//
74 * [[:develop:api:efl:io:closer:fd|Efl.Io.Closer.Fd]] //(mixin)//
75 * [[:develop:api:efl:io:closer|Efl.Io.Closer]] //(mixin)//
76 * [[:develop:api:efl:object|Efl.Object]] //(class)//
77 * [[:develop:api:efl:net:socket|Efl.Net.Socket]] //(interface)//
78 * [[:develop:api:efl:io:reader|Efl.Io.Reader]] //(interface)//
79 * [[:develop:api:efl:io:writer|Efl.Io.Writer]] //(interface)//
80 * [[:develop:api:efl:io:closer|Efl.Io.Closer]] //(mixin)//
81
82
83++++
84===== Members =====
85
86**[[:develop:api:efl:net:socket:fd:property:family|family]]** //**(get, set)**// ''protected set''
87<code c>
88int efl_net_socket_fd_family_get(const Eo *obj);
89void efl_net_socket_fd_family_set(Eo *obj, int family);
90</code>
91
92%%The address family (AF_*) family of this socket.%%\\
93\\
94
95==== Inherited ====
96
97[[:develop:api:efl:io:closer:fd|Efl.Io.Closer.Fd]].**[[:develop:api:efl:io:closer:fd:property:closer_fd|closer_fd]]** //**(get, set)**// ''protected set''
98\\
99[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:io:closer:fd:property:close_on_destructor|close_on_destructor]]** //**(get, set)**// //[Overridden in [[:develop:api:efl:io:closer:fd|Efl.Io.Closer.Fd]]]//
100\\
101[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:io:closer:fd:property:close_on_exec|close_on_exec]]** //**(get, set)**// //[Overridden in [[:develop:api:efl:io:closer:fd|Efl.Io.Closer.Fd]]]//
102\\
103[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:net:socket:fd:method:close|close]]** //[Overridden here]//
104\\
105[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:net:socket:fd:property:closed|closed]]** //**(get, set)**// //[Overridden here]//
106\\
107[[:develop:api:efl:io:reader:fd|Efl.Io.Reader.Fd]].**[[:develop:api:efl:io:reader:fd:property:reader_fd|reader_fd]]** //**(get, set)**// ''protected set''
108\\
109[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:net:socket:fd:method:read|read]]** //[Overridden here]//
110\\
111[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:net:socket:fd:property:can_read|can_read]]** //**(get, set)**// //[Overridden here]// ''protected set''
112\\
113[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:net:socket:fd:property:eos|eos]]** //**(get, set)**// //[Overridden here]// ''protected set''
114\\
115[[:develop:api:efl:io:writer:fd|Efl.Io.Writer.Fd]].**[[:develop:api:efl:io:writer:fd:property:writer_fd|writer_fd]]** //**(get, set)**// ''protected set''
116\\
117[[:develop:api:efl:io:writer|Efl.Io.Writer]].**[[:develop:api:efl:net:socket:fd:method:write|write]]** //[Overridden here]//
118\\
119[[:develop:api:efl:io:writer|Efl.Io.Writer]].**[[:develop:api:efl:net:socket:fd:property:can_write|can_write]]** //**(get, set)**// //[Overridden here]// ''protected set''
120\\
121[[:develop:api:efl:loop:fd|Efl.Loop.Fd]].**[[:develop:api:efl:loop:fd:property:fd_file|fd_file]]** //**(get, set)**//
122\\
123[[:develop:api:efl:loop:fd|Efl.Loop.Fd]].**[[:develop:api:efl:net:socket:fd:property:fd|fd]]** //**(get, set)**// //[Overridden here]//
124\\
125[[:develop:api:efl:loop_user|Efl.Loop_User]].**[[:develop:api:efl:loop_user:property:loop|loop]]** //**(get)**//
126\\
127[[:develop:api:efl:net:socket|Efl.Net.Socket]].**[[:develop:api:efl:net:socket:fd:property:address_local|address_local]]** //**(get, set)**// //[Overridden here]// ''protected set''
128\\
129[[:develop:api:efl:net:socket|Efl.Net.Socket]].**[[:develop:api:efl:net:socket:fd:property:address_remote|address_remote]]** //**(get, set)**// //[Overridden here]// ''protected set''
130\\
131[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:loop:fd:property:parent|parent]]** //**(get, set)**// //[Overridden in [[:develop:api:efl:loop:fd|Efl.Loop.Fd]]]//
132\\
133[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:net:socket:fd:method:constructor|constructor]]** //[Overridden here]//
134\\
135[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:net:socket:fd:method:destructor|destructor]]** //[Overridden here]//
136\\
137[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:net:socket:fd:method:finalize|finalize]]** //[Overridden here]//
138\\
139[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]**
140\\
141[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:composite_attach|composite_attach]]**
142\\
143[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:composite_detach|composite_detach]]**
144\\
145[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]**
146\\
147[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:debug_name_override|debug_name_override]]**
148\\
149[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:del|del]]**
150\\
151[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_callback_forwarder_add|event_callback_forwarder_add]]**
152\\
153[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]**
154\\
155[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]**
156\\
157[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_freeze|event_freeze]]**
158\\
159[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]**
160\\
161[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]**
162\\
163[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_thaw|event_thaw]]**
164\\
165[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:name_find|name_find]]**
166\\
167[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:provider_find|provider_find]]**
168\\
169[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**//
170\\
171[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**//
172\\
173[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**//
174\\
175[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**//
176\\
177[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**//
178\\
179[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:name|name]]** //**(get, set)**//
180\\
181
182===== Events =====
183
184==== Inherited ====
185
186[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:io:closer:event:closed|closed]]**
187\\
188[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:io:closer:event:closed|closed]]**
189\\
190[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:event:can_read_changed|can_read,changed]]**
191\\
192[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:event:can_read_changed|can_read,changed]]**
193\\
194[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:event:eos|eos]]**
195\\
196[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:event:eos|eos]]**
197\\
198[[:develop:api:efl:io:writer|Efl.Io.Writer]].**[[:develop:api:efl:io:writer:event:can_write_changed|can_write,changed]]**
199\\
200[[:develop:api:efl:io:writer|Efl.Io.Writer]].**[[:develop:api:efl:io:writer:event:can_write_changed|can_write,changed]]**
201\\
202[[:develop:api:efl:loop:fd|Efl.Loop.Fd]].**[[:develop:api:efl:loop:fd:event:error|error]]**
203\\
204[[:develop:api:efl:loop:fd|Efl.Loop.Fd]].**[[:develop:api:efl:loop:fd:event:read|read]]**
205\\
206[[:develop:api:efl:loop:fd|Efl.Loop.Fd]].**[[:develop:api:efl:loop:fd:event:write|write]]**
207\\
208[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:callback_add|callback,add]]**
209\\
210[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:callback_add|callback,add]]**
211\\
212[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:callback_del|callback,del]]**
213\\
214[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:callback_del|callback,del]]**
215\\
216[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:del|del]]**
217\\
218[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:del|del]]**
219\\