Commit d6aa3935 authored by Philip Withnall's avatar Philip Withnall

gpollableoutputstream: Add vfunc documentation for writev_nonblocking

This was missing from the original merge request.
Signed-off-by: Philip Withnall's avatarPhilip Withnall <withnall@endlessm.com>
parent 6837c34c
......@@ -49,6 +49,8 @@ typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface;
* @create_source: Creates a #GSource to poll the stream
* @write_nonblocking: Does a non-blocking write or returns
* %G_IO_ERROR_WOULD_BLOCK
* @writev_nonblocking: Does a vectored non-blocking write, or returns
* %G_POLLABLE_RETURN_WOULD_BLOCK
*
* The interface for pollable output streams.
*
......@@ -61,6 +63,12 @@ typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface;
* implementation may return %TRUE when the stream is not actually
* writable.
*
* The default implementation of @writev_nonblocking calls
* g_pollable_output_stream_write_nonblocking() for each vector, and converts
* its return value and error (if set) to a #GPollableReturn. You should
* override this where possible to avoid having to allocate a #GError to return
* %G_IO_ERROR_WOULD_BLOCK.
*
* Since: 2.28
*/
struct _GPollableOutputStreamInterface
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment