aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/io/buffered_stream/method
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/io/buffered_stream/method')
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/clear.txt18
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/close.txt22
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/destructor.txt14
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/discard.txt26
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/eos_mark.txt24
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/finalize.txt10
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/flush.txt26
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/read.txt22
-rw-r--r--pages/develop/api/efl/io/buffered_stream/method/write.txt22
9 files changed, 92 insertions, 92 deletions
diff --git a/pages/develop/api/efl/io/buffered_stream/method/clear.txt b/pages/develop/api/efl/io/buffered_stream/method/clear.txt
index 3ec1b8bb3..d2c1576d7 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/clear.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/clear.txt
@@ -1,4 +1,13 @@
~~Title: Efl.Io.Buffered_Stream.clear~~
+===== Description =====
+
+%%Clears the incoming queue. Same as reading all data.%%
+
+%%This is equivalent as calling %%[[:develop:api:efl:io:buffered_stream:method:discard|Efl.Io.Buffered_Stream.discard]]%% with %%[[:develop:api:efl:io:buffered_stream:property:pending_read|Efl.Io.Buffered_Stream.pending_read]]%% amount of bytes.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:buffered_stream:method:clear:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -11,15 +20,6 @@ clear {}
void efl_io_buffered_stream_clear(Eo *obj);
</code>
-===== Description =====
-
-%%Clears the incoming queue. Same as reading all data.%%
-
-%%This is equivalent as calling %%[[:develop:api:efl:io:buffered_stream:method:discard|Efl.Io.Buffered_Stream.discard]]%% with %%[[:develop:api:efl:io:buffered_stream:property:pending_read|Efl.Io.Buffered_Stream.pending_read]]%% amount of bytes.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:buffered_stream:method:clear:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Io.Buffered_Stream.clear**
diff --git a/pages/develop/api/efl/io/buffered_stream/method/close.txt b/pages/develop/api/efl/io/buffered_stream/method/close.txt
index 21c2fefbb..d34d4a66c 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/close.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/close.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Buffered_Stream.close~~
+===== Description =====
+
+%%Closes the Input/Output object.%%
+
+%%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.%%
+
+%%You can understand this method as close(2) libc function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:buffered_stream:method:close:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]].//===== Signature =====
<code>
@@ -13,17 +24,6 @@ close @pure_virtual {
Eina_Error efl_io_closer_close(Eo *obj);
</code>
-===== Description =====
-
-%%Closes the Input/Output object.%%
-
-%%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.%%
-
-%%You can understand this method as close(2) libc function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:buffered_stream:method:close:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]]
diff --git a/pages/develop/api/efl/io/buffered_stream/method/destructor.txt b/pages/develop/api/efl/io/buffered_stream/method/destructor.txt
index bd3946a8f..3c121a60c 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/destructor.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/destructor.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Io.Buffered_Stream.destructor~~
+===== Description =====
+
+%%Call the object's destructor.%%
+
+%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
+{{page>:develop:api-include:efl:io:buffered_stream:method:destructor:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]].//===== Signature =====
<code>
@@ -11,13 +18,6 @@ destructor {}
void efl_destructor(Eo *obj);
</code>
-===== Description =====
-
-%%Call the object's destructor.%%
-
-%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
-{{page>:develop:api-include:efl:io:buffered_stream:method:destructor:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]]
diff --git a/pages/develop/api/efl/io/buffered_stream/method/discard.txt b/pages/develop/api/efl/io/buffered_stream/method/discard.txt
index 973b65e5a..477f29fde 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/discard.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/discard.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Io.Buffered_Stream.discard~~
+===== Description =====
+
+%%Discards the given number of bytes.%%
+
+%%This has the same effect as reading and discarding the given amount of bytes, without executing the actual copy.%%
+
+%%It's often paired with %%[[:develop:api:efl:io:buffered_stream:property:slice|Efl.Io.Buffered_Stream.slice]]%%, if users read the information from the slice and once they're done, that data must be discarded.%%
+
+%%As an example, some protocols provide messages with a "size" header, then %%[[:develop:api:efl:io:buffered_stream:property:slice|Efl.Io.Buffered_Stream.slice]]%% is used to peek into the available memory to see if there is a "size" and if the rest of the slice is the full payload, in this case the slice may be handled to some processing function. When the function is done, that amount of data must be discarded -- with this function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:buffered_stream:method:discard:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -19,19 +32,6 @@ void efl_io_buffered_stream_discard(Eo *obj, size_t amount);
* **amount** //(in)// - %%Bytes to discard%%
-===== Description =====
-
-%%Discards the given number of bytes.%%
-
-%%This has the same effect as reading and discarding the given amount of bytes, without executing the actual copy.%%
-
-%%It's often paired with %%[[:develop:api:efl:io:buffered_stream:property:slice|Efl.Io.Buffered_Stream.slice]]%%, if users read the information from the slice and once they're done, that data must be discarded.%%
-
-%%As an example, some protocols provide messages with a "size" header, then %%[[:develop:api:efl:io:buffered_stream:property:slice|Efl.Io.Buffered_Stream.slice]]%% is used to peek into the available memory to see if there is a "size" and if the rest of the slice is the full payload, in this case the slice may be handled to some processing function. When the function is done, that amount of data must be discarded -- with this function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:buffered_stream:method:discard:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Io.Buffered_Stream.discard**
diff --git a/pages/develop/api/efl/io/buffered_stream/method/eos_mark.txt b/pages/develop/api/efl/io/buffered_stream/method/eos_mark.txt
index 294caeee9..1a0249d3e 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/eos_mark.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/eos_mark.txt
@@ -1,16 +1,4 @@
~~Title: Efl.Io.Buffered_Stream.eos_mark~~
-===== Signature =====
-
-<code>
-eos_mark {}
-</code>
-
-===== C signature =====
-
-<code c>
-void efl_io_buffered_stream_eos_mark(Eo *obj);
-</code>
-
===== Description =====
%%Marks this end-of-stream, signals nothing else will be written.%%
@@ -24,6 +12,18 @@ void efl_io_buffered_stream_eos_mark(Eo *obj);
//Since 1.19//
{{page>:develop:api-include:efl:io:buffered_stream:method:eos_mark:description&nouser&nolink&nodate}}
+===== Signature =====
+
+<code>
+eos_mark {}
+</code>
+
+===== C signature =====
+
+<code c>
+void efl_io_buffered_stream_eos_mark(Eo *obj);
+</code>
+
===== Implemented by =====
* **Efl.Io.Buffered_Stream.eos_mark**
diff --git a/pages/develop/api/efl/io/buffered_stream/method/finalize.txt b/pages/develop/api/efl/io/buffered_stream/method/finalize.txt
index 5ee138578..0505914fa 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/finalize.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/finalize.txt
@@ -1,4 +1,9 @@
~~Title: Efl.Io.Buffered_Stream.finalize~~
+===== Description =====
+
+%%Called at the end of #eo_add. Should not be called, just overridden.%%
+{{page>:develop:api-include:efl:io:buffered_stream:method:finalize:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]].//===== Signature =====
<code>
@@ -13,11 +18,6 @@ finalize {
Efl_Object *efl_finalize(Eo *obj);
</code>
-===== Description =====
-
-%%Called at the end of #eo_add. Should not be called, just overridden.%%
-{{page>:develop:api-include:efl:io:buffered_stream:method:finalize:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]]
diff --git a/pages/develop/api/efl/io/buffered_stream/method/flush.txt b/pages/develop/api/efl/io/buffered_stream/method/flush.txt
index d4227f5f9..246e83c18 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/flush.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/flush.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Io.Buffered_Stream.flush~~
+===== Description =====
+
+%%Forces writing all pending data to destination.%%
+
+%%It will return %%''true''%% if %%[[:develop:api:efl:io:buffered_stream:property:pending_read|Efl.Io.Buffered_Stream.pending_read]]%% drops to zero, %%''false''%% otherwise and more calls to flush must be made.%%
+
+%%If the %%[[:develop:api:efl:io:buffered_stream:property:inner_io|Efl.Io.Buffered_Stream.inner_io]]%% is implements %%[[:develop:api:efl:io:closer|Efl.Io.Closer]]%% and it was closed, or the wrapper itself was closed, this function will do nothing and returns %%''true''%%.%%
+
+%%@note this function may block the main loop execution until operations complete! This is bad for usability, as user interface or other operations may freeze. A better approach is to operate asynchronously and wait for "write,finished" event.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:buffered_stream:method:flush:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -22,19 +35,6 @@ Eina_Bool efl_io_buffered_stream_flush(Eo *obj, Eina_Bool may_block, Eina_Bool i
* **may_block** //(in)// - %%If %%''true''%%, then %%[[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]%% and %%[[:develop:api:efl:io:writer:property:can_write|Efl.Io.Writer.can_write]]%% are not checked and the call may block.%%
* **ignore_line_delimiter** //(in)// - %%Forces flush ignoring line delimiters%%
-===== Description =====
-
-%%Forces writing all pending data to destination.%%
-
-%%It will return %%''true''%% if %%[[:develop:api:efl:io:buffered_stream:property:pending_read|Efl.Io.Buffered_Stream.pending_read]]%% drops to zero, %%''false''%% otherwise and more calls to flush must be made.%%
-
-%%If the %%[[:develop:api:efl:io:buffered_stream:property:inner_io|Efl.Io.Buffered_Stream.inner_io]]%% is implements %%[[:develop:api:efl:io:closer|Efl.Io.Closer]]%% and it was closed, or the wrapper itself was closed, this function will do nothing and returns %%''true''%%.%%
-
-%%@note this function may block the main loop execution until operations complete! This is bad for usability, as user interface or other operations may freeze. A better approach is to operate asynchronously and wait for "write,finished" event.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:buffered_stream:method:flush:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Io.Buffered_Stream.flush**
diff --git a/pages/develop/api/efl/io/buffered_stream/method/read.txt b/pages/develop/api/efl/io/buffered_stream/method/read.txt
index 5abceeb70..0ed10633d 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/read.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/read.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Buffered_Stream.read~~
+===== Description =====
+
+%%Reads data into a pre-allocated buffer.%%
+
+%%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.%%
+
+%%You can understand this method as read(2) libc function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:buffered_stream:method:read:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]].//===== Signature =====
<code>
@@ -20,17 +31,6 @@ Eina_Error efl_io_reader_read(Eo *obj, Eina_Rw_Slice rw_slice);
* **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.%%
-===== Description =====
-
-%%Reads data into a pre-allocated buffer.%%
-
-%%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.%%
-
-%%You can understand this method as read(2) libc function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:buffered_stream:method:read:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]
diff --git a/pages/develop/api/efl/io/buffered_stream/method/write.txt b/pages/develop/api/efl/io/buffered_stream/method/write.txt
index c50180a5b..99fc3ccb8 100644
--- a/pages/develop/api/efl/io/buffered_stream/method/write.txt
+++ b/pages/develop/api/efl/io/buffered_stream/method/write.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Buffered_Stream.write~~
+===== Description =====
+
+%%Writes data from a pre-populated buffer.%%
+
+%%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.%%
+
+%%You can understand this method as write(2) libc function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:buffered_stream:method:write:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]].//===== Signature =====
<code>
@@ -22,17 +33,6 @@ Eina_Error efl_io_writer_write(Eo *obj, Eina_Slice slice, Eina_Slice *remaining)
* **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.%%
* **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.%%
-===== Description =====
-
-%%Writes data from a pre-populated buffer.%%
-
-%%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.%%
-
-%%You can understand this method as write(2) libc function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:buffered_stream:method:write:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]]