luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 06:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

outputstream: Clarify docs of flush()

Browse Source 
After questioning the semantics of flush on IRC, it seemed necessary to
clarify what flushing is supposed to do. The Linux man page for fflush()
seemed to cover it perfectly, so I just copied it.

I did not add the "via the underlying write mechanism" part as that in
my opinion is not something subclasses should need to guarantee.
This commit is contained in:
Benjamin Otte 2011-12-05 22:40:18 +01:00
parent fd1e9938b3
commit 482f226270
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gio/goutputstream.c
View File

@ -296,8 +296,9 @@ g_output_stream_write_all (GOutputStream *stream,
* @cancellable: (allow-none): optional cancellable object * @cancellable: (allow-none): optional cancellable object
* @error: location to store the error occurring, or %NULL to ignore * @error: location to store the error occurring, or %NULL to ignore
* *
* Flushed any outstanding buffers in the stream. Will block during * Forces a write of all user-space buffered data for the given
* the operation. Closing the stream will implicitly cause a flush. * @stream. Will block during the operation. Closing the stream will
* implicitly cause a flush.
* *
* This function is optional for inherited classes. * This function is optional for inherited classes.
* *
@ -939,7 +940,8 @@ g_output_stream_splice_finish (GOutputStream *stream,
* @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: (closure): the data to pass to callback function * @user_data: (closure): the data to pass to callback function
* *
* Flushes a stream asynchronously. * Forces an asynchronous write of all user-space buffered data for
* the given @stream.
* For behaviour details see g_output_stream_flush(). * For behaviour details see g_output_stream_flush().
* *
* When the operation is finished @callback will be * When the operation is finished @callback will be