gpollableoutputstream: Add vfunc documentation for writev_nonblocking

This was missing from the original merge request.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
This commit is contained in:
Philip Withnall
2019-03-07 17:36:06 +00:00
parent 6837c34c84
commit d6aa393578

View File

@@ -49,6 +49,8 @@ typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface;
* @create_source: Creates a #GSource to poll the stream * @create_source: Creates a #GSource to poll the stream
* @write_nonblocking: Does a non-blocking write or returns * @write_nonblocking: Does a non-blocking write or returns
* %G_IO_ERROR_WOULD_BLOCK * %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. * The interface for pollable output streams.
* *
@@ -61,6 +63,12 @@ typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface;
* implementation may return %TRUE when the stream is not actually * implementation may return %TRUE when the stream is not actually
* writable. * 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 * Since: 2.28
*/ */
struct _GPollableOutputStreamInterface struct _GPollableOutputStreamInterface