summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/socket/fd.txt
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/socket/fd.txt
parente3401bceb2a041fc39682a834ca107feac2c8642 (diff)
api: Use the latest API generation code
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, 110 insertions, 109 deletions
diff --git a/pages/develop/api/efl/net/socket/fd.txt b/pages/develop/api/efl/net/socket/fd.txt
index f987300..58f20b3 100644
--- a/pages/develop/api/efl/net/socket/fd.txt
+++ b/pages/develop/api/efl/net/socket/fd.txt
@@ -83,123 +83,124 @@ digraph hierarchy {
83++++ 83++++
84===== Members ===== 84===== Members =====
85 85
86**[[:develop:api:efl:net:socket:fd:property:family|family]]** //**(get, set)**// ''protected set'' 86**[[:develop:api:efl:net:socket:fd:method:close|close]]**// [Overridden from [[:develop:api:efl:io:closer|Efl.Io.Closer]]]//\\
87> %%Closes the Input/Output object.%%
88<code c>
89Eina_Error efl_io_closer_close(Eo *obj);
90</code>
91\\
92**[[:develop:api:efl:net:socket:fd:method:constructor|constructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
93> %%Call the object's constructor.%%
94<code c>
95Efl_Object *efl_constructor(Eo *obj);
96</code>
97\\
98**[[:develop:api:efl:net:socket:fd:method:destructor|destructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
99> %%Call the object's destructor.%%
100<code c>
101void efl_destructor(Eo *obj);
102</code>
103\\
104**[[:develop:api:efl:net:socket:fd:method:finalize|finalize]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
105> %%Called at the end of #eo_add. Should not be called, just overridden.%%
106<code c>
107Efl_Object *efl_finalize(Eo *obj);
108</code>
109\\
110**[[:develop:api:efl:net:socket:fd:method:read|read]]**// [Overridden from [[:develop:api:efl:io:reader|Efl.Io.Reader]]]//\\
111> %%Reads data into a pre-allocated buffer.%%
112<code c>
113Eina_Error efl_io_reader_read(Eo *obj, Eina_Rw_Slice rw_slice);
114</code>
115\\
116**[[:develop:api:efl:net:socket:fd:method:write|write]]**// [Overridden from [[:develop:api:efl:io:writer|Efl.Io.Writer]]]//\\
117> %%Writes data from a pre-populated buffer.%%
118<code c>
119Eina_Error efl_io_writer_write(Eo *obj, Eina_Slice slice, Eina_Slice *remaining);
120</code>
121\\
122**[[:develop:api:efl:net:socket:fd:property:address_local|address_local]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:net:socket|Efl.Net.Socket]]]// ''protected set''\\
123> %%The local address, similar to getsockname().%%
124<code c>
125const char *efl_net_socket_address_local_get(const Eo *obj);
126void efl_net_socket_address_local_set(Eo *obj, const char *address);
127</code>
128\\
129**[[:develop:api:efl:net:socket:fd:property:address_remote|address_remote]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:net:socket|Efl.Net.Socket]]]// ''protected set''\\
130> %%The remote address, similar to getpeername().%%
131<code c>
132const char *efl_net_socket_address_remote_get(const Eo *obj);
133void efl_net_socket_address_remote_set(Eo *obj, const char *address);
134</code>
135\\
136**[[:develop:api:efl:net:socket:fd:property:can_read|can_read]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:io:reader|Efl.Io.Reader]]]// ''protected set''\\
137> %%If %%''true''%% will notify %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
138<code c>
139Eina_Bool efl_io_reader_can_read_get(const Eo *obj);
140void efl_io_reader_can_read_set(Eo *obj, Eina_Bool can_read);
141</code>
142\\
143**[[:develop:api:efl:net:socket:fd:property:can_write|can_write]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:io:writer|Efl.Io.Writer]]]// ''protected set''\\
144> %%If %%''true''%% will notify %%[[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]]%% can be called without blocking or failing.%%
145<code c>
146Eina_Bool efl_io_writer_can_write_get(const Eo *obj);
147void efl_io_writer_can_write_set(Eo *obj, Eina_Bool can_write);
148</code>
149\\
150**[[:develop:api:efl:net:socket:fd:property:closed|closed]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:io:closer|Efl.Io.Closer]]]//\\
151> %%If true will notify object was closed.%%
152<code c>
153Eina_Bool efl_io_closer_closed_get(const Eo *obj);
154Eina_Bool efl_io_closer_closed_set(Eo *obj, Eina_Bool is_closed);
155</code>
156\\
157**[[:develop:api:efl:net:socket:fd:property:eos|eos]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:io:reader|Efl.Io.Reader]]]// ''protected set''\\
158> %%If %%''true''%% will notify end of stream.%%
159<code c>
160Eina_Bool efl_io_reader_eos_get(const Eo *obj);
161void efl_io_reader_eos_set(Eo *obj, Eina_Bool is_eos);
162</code>
163\\
164**[[:develop:api:efl:net:socket:fd:property:family|family]]** //**(get, set)**// ''protected set''\\
165> %%The address family (AF_*) family of this socket.%%
87<code c> 166<code c>
88int efl_net_socket_fd_family_get(const Eo *obj); 167int efl_net_socket_fd_family_get(const Eo *obj);
89void efl_net_socket_fd_family_set(Eo *obj, int family); 168void efl_net_socket_fd_family_set(Eo *obj, int family);
90</code> 169</code>
91 170\\
92%%The address family (AF_*) family of this socket.%%\\ 171**[[:develop:api:efl:net:socket:fd:property:fd|fd]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:loop:fd|Efl.Loop.Fd]]]//\\
93\\ 172> %%Defines which file descriptor to watch. If it is a file, use file_fd variant.%%
173<code c>
174int efl_loop_fd_get(const Eo *obj);
175void efl_loop_fd_set(Eo *obj, int fd);
176</code>
177\\
94 178
95==== Inherited ==== 179==== Inherited ====
96 180
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'' 181[[:develop:api:efl:io:closer:fd|Efl.Io.Closer.Fd]]\\
98\\ 182> **[[:develop:api:efl:io:closer:fd:property:close_on_destructor|close_on_destructor]]** //**(get, set)**//, **[[:develop:api:efl:io:closer:fd:property:close_on_exec|close_on_exec]]** //**(get, set)**//, **[[:develop:api:efl:io:closer:fd:property:closer_fd|closer_fd]]** //**(get, set)**// ''protected set''\\
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]]]// 183[[:develop:api:efl:io:reader:fd|Efl.Io.Reader.Fd]]\\
100\\ 184> **[[:develop:api:efl:io:reader:fd:property:reader_fd|reader_fd]]** //**(get, set)**// ''protected set''\\
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]]]// 185[[:develop:api:efl:io:writer:fd|Efl.Io.Writer.Fd]]\\
102\\ 186> **[[:develop:api:efl:io:writer:fd:property:writer_fd|writer_fd]]** //**(get, set)**// ''protected set''\\
103[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:net:socket:fd:method:close|close]]** //[Overridden here]// 187[[:develop:api:efl:loop:fd|Efl.Loop.Fd]]\\
104\\ 188> **[[:develop:api:efl:loop:fd:property:fd_file|fd_file]]** //**(get, set)**//, **[[:develop:api:efl:loop:fd:property:parent|parent]]** //**(get, set)**//\\
105[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:net:socket:fd:property:closed|closed]]** //**(get, set)**// //[Overridden here]// 189[[:develop:api:efl:loop_user|Efl.Loop_User]]\\
106\\ 190> **[[:develop:api:efl:loop_user:property:loop|loop]]** //**(get)**//\\
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'' 191[[:develop:api:efl:object|Efl.Object]]\\
108\\ 192> **[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]**, **[[:develop:api:efl:object:method:composite_attach|composite_attach]]**, **[[:develop:api:efl:object:method:composite_detach|composite_detach]]**, **[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]**, **[[:develop:api:efl:object:method:debug_name_override|debug_name_override]]**, **[[:develop:api:efl:object:method:del|del]]**, **[[:develop:api:efl:object:method:event_callback_forwarder_add|event_callback_forwarder_add]]**, **[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]**, **[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]**, **[[:develop:api:efl:object:method:event_freeze|event_freeze]]**, **[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]**, **[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]**, **[[:develop:api:efl:object:method:event_thaw|event_thaw]]**, **[[:develop:api:efl:object:method:name_find|name_find]]**, **[[:develop:api:efl:object:method:provider_find|provider_find]]**, **[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**//, **[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**//, **[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**//, **[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**//, **[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**//, **[[:develop:api:efl:object:property:name|name]]** //**(get, set)**//
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 ===== 193===== Events =====
183 194
184==== Inherited ==== 195==== Inherited ====
185 196
186[[:develop:api:efl:io:closer|Efl.Io.Closer]].**[[:develop:api:efl:io:closer:event:closed|closed]]** 197[[:develop:api:efl:io:closer|Efl.Io.Closer]]\\
187\\ 198> **[[:develop:api:efl:io:closer:event:closed|closed]]**\\
188[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:event:can_read_changed|can_read,changed]]** 199[[:develop:api:efl:io:reader|Efl.Io.Reader]]\\
189\\ 200> **[[:develop:api:efl:io:reader:event:can_read_changed|can_read,changed]]**, **[[:develop:api:efl:io:reader:event:eos|eos]]**\\
190[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:event:eos|eos]]** 201[[:develop:api:efl:io:writer|Efl.Io.Writer]]\\
191\\ 202> **[[:develop:api:efl:io:writer:event:can_write_changed|can_write,changed]]**\\
192[[:develop:api:efl:io:writer|Efl.Io.Writer]].**[[:develop:api:efl:io:writer:event:can_write_changed|can_write,changed]]** 203[[:develop:api:efl:loop:fd|Efl.Loop.Fd]]\\
193\\ 204> **[[:develop:api:efl:loop:fd:event:error|error]]**, **[[:develop:api:efl:loop:fd:event:read|read]]**, **[[:develop:api:efl:loop:fd:event:write|write]]**\\
194[[:develop:api:efl:loop:fd|Efl.Loop.Fd]].**[[:develop:api:efl:loop:fd:event:error|error]]** 205[[:develop:api:efl:object|Efl.Object]]\\
195\\ 206> **[[:develop:api:efl:object:event:callback_add|callback,add]]**, **[[:develop:api:efl:object:event:callback_del|callback,del]]**, **[[:develop:api:efl:object:event:del|del]]** \ No newline at end of file
196[[:develop:api:efl:loop:fd|Efl.Loop.Fd]].**[[:develop:api:efl:loop:fd:event:read|read]]**
197\\
198[[:develop:api:efl:loop:fd|Efl.Loop.Fd]].**[[:develop:api:efl:loop:fd:event:write|write]]**
199\\
200[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:callback_add|callback,add]]**
201\\
202[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:callback_del|callback,del]]**
203\\
204[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:del|del]]**
205\\