UnixOutputStream

gio.unix_output_stream.UnixOutputStream implements gio.output_stream.OutputStream for writing to a UNIX file descriptor, including asynchronous operations. (If the file descriptor refers to a socket or pipe, this will use poll() to do asynchronous I/O. If it refers to a regular file, it will fall back to doing asynchronous I/O in another thread.)

Note that <gio/gunixoutputstream.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file file or the GioUnix-2.0 GIR namespace when using it.

Constructors

this
this(int fd, bool closeFd)

Creates a new #GUnixOutputStream for the given fd.

Members

Functions

getCloseFd
bool getCloseFd()

Returns whether the file descriptor of stream will be closed when the stream is closed.

getFd
int getFd()

Return the UNIX file descriptor that the stream writes to.

setCloseFd
void setCloseFd(bool closeFd)

Sets whether the file descriptor of stream shall be closed when the stream is closed.

Mixed In Members

From mixin FileDescriptorBasedT!()

getFd
int getFd()

Gets the underlying file descriptor.

From mixin PollableOutputStreamT!()

canPoll
bool canPoll()

Checks if stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns false, then the behavior of other #GPollableOutputStream methods is undefined.

createSource
glib.source.Source createSource(gio.cancellable.Cancellable cancellable)

Creates a #GSource that triggers when stream can be written, or cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type.

isWritable
bool isWritable()

Checks if stream can be written.

writeNonblocking
ptrdiff_t writeNonblocking(ubyte[] buffer, gio.cancellable.Cancellable cancellable)

Attempts to write up to count bytes from buffer to stream, as with gio.output_stream.OutputStream.write. If stream is not currently writable, this will immediately return gio.types.IOErrorEnum.WouldBlock, and you can use gio.pollable_output_stream.PollableOutputStream.createSource to create a #GSource that will be triggered when stream is writable.

writevNonblocking
gio.types.PollableReturn writevNonblocking(gio.types.OutputVector[] vectors, size_t bytesWritten, gio.cancellable.Cancellable cancellable)

Attempts to write the bytes contained in the n_vectors vectors to stream, as with gio.output_stream.OutputStream.writev. If stream is not currently writable, this will immediately return %G_POLLABLE_RETURN_WOULD_BLOCK, and you can use gio.pollable_output_stream.PollableOutputStream.createSource to create a #GSource that will be triggered when stream is writable. error will *not* be set in that case.

Inherited Members

From OutputStream

clearPending
void clearPending()

Clears the pending flag on stream.

close
bool close(gio.cancellable.Cancellable cancellable)

Closes the stream, releasing resources related to it.

closeAsync
void closeAsync(int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.closeFinish to get the result of the operation.

closeFinish
bool closeFinish(gio.async_result.AsyncResult result)

Closes an output stream.

flush
bool flush(gio.cancellable.Cancellable cancellable)

Forces a write of all user-space buffered data for the given stream. Will block during the operation. Closing the stream will implicitly cause a flush.

flushAsync
void flushAsync(int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Forces an asynchronous write of all user-space buffered data for the given stream. For behaviour details see gio.output_stream.OutputStream.flush.

flushFinish
bool flushFinish(gio.async_result.AsyncResult result)

Finishes flushing an output stream.

hasPending
bool hasPending()

Checks if an output stream has pending actions.

isClosed
bool isClosed()

Checks if an output stream has already been closed.

isClosing
bool isClosing()

Checks if an output stream is being closed. This can be used inside e.g. a flush implementation to see if the flush (or other i/o operation) is called from within the closing operation.

setPending
bool setPending()

Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return false and set error.

splice
ptrdiff_t splice(gio.input_stream.InputStream source, gio.types.OutputStreamSpliceFlags flags, gio.cancellable.Cancellable cancellable)

Splices an input stream into an output stream.

spliceAsync
void spliceAsync(gio.input_stream.InputStream source, gio.types.OutputStreamSpliceFlags flags, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Splices a stream asynchronously. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.spliceFinish to get the result of the operation.

spliceFinish
ptrdiff_t spliceFinish(gio.async_result.AsyncResult result)

Finishes an asynchronous stream splice operation.

write
ptrdiff_t write(ubyte[] buffer, gio.cancellable.Cancellable cancellable)

Tries to write count bytes from buffer into the stream. Will block during the operation.

writeAll
bool writeAll(ubyte[] buffer, size_t bytesWritten, gio.cancellable.Cancellable cancellable)

Tries to write count bytes from buffer into the stream. Will block during the operation.

writeAllAsync
void writeAllAsync(ubyte[] buffer, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.writeAllFinish to get the result of the operation.

writeAllFinish
bool writeAllFinish(gio.async_result.AsyncResult result, size_t bytesWritten)

Finishes an asynchronous stream write operation started with gio.output_stream.OutputStream.writeAllAsync.

writeAsync
void writeAsync(ubyte[] buffer, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.writeFinish to get the result of the operation.

writeBytes
ptrdiff_t writeBytes(glib.bytes.Bytes bytes, gio.cancellable.Cancellable cancellable)

A wrapper function for gio.output_stream.OutputStream.write which takes a #GBytes as input. This can be more convenient for use by language bindings or in other cases where the refcounted nature of #GBytes is helpful over a bare pointer interface.

writeBytesAsync
void writeBytesAsync(glib.bytes.Bytes bytes, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

This function is similar to gio.output_stream.OutputStream.writeAsync, but takes a #GBytes as input. Due to the refcounted nature of #GBytes, this allows the stream to avoid taking a copy of the data.

writeBytesFinish
ptrdiff_t writeBytesFinish(gio.async_result.AsyncResult result)

Finishes a stream write-from-#GBytes operation.

writeFinish
ptrdiff_t writeFinish(gio.async_result.AsyncResult result)

Finishes a stream write operation.

writev
bool writev(gio.types.OutputVector[] vectors, size_t bytesWritten, gio.cancellable.Cancellable cancellable)

Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.

writevAll
bool writevAll(gio.types.OutputVector[] vectors, size_t bytesWritten, gio.cancellable.Cancellable cancellable)

Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.

writevAllAsync
void writevAllAsync(gio.types.OutputVector[] vectors, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Request an asynchronous write of the bytes contained in the n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.writevAllFinish to get the result of the operation.

writevAllFinish
bool writevAllFinish(gio.async_result.AsyncResult result, size_t bytesWritten)

Finishes an asynchronous stream write operation started with gio.output_stream.OutputStream.writevAllAsync.

writevAsync
void writevAsync(gio.types.OutputVector[] vectors, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Request an asynchronous write of the bytes contained in n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.writevFinish to get the result of the operation.

writevFinish
bool writevFinish(gio.async_result.AsyncResult result, size_t bytesWritten)

Finishes a stream writev operation.

From FileDescriptorBased

getFd
int getFd()

Gets the underlying file descriptor.

From PollableOutputStream

canPoll
bool canPoll()

Checks if stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns false, then the behavior of other #GPollableOutputStream methods is undefined.

createSource
glib.source.Source createSource(gio.cancellable.Cancellable cancellable)

Creates a #GSource that triggers when stream can be written, or cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type.

isWritable
bool isWritable()

Checks if stream can be written.

writeNonblocking
ptrdiff_t writeNonblocking(ubyte[] buffer, gio.cancellable.Cancellable cancellable)

Attempts to write up to count bytes from buffer to stream, as with gio.output_stream.OutputStream.write. If stream is not currently writable, this will immediately return gio.types.IOErrorEnum.WouldBlock, and you can use gio.pollable_output_stream.PollableOutputStream.createSource to create a #GSource that will be triggered when stream is writable.

writevNonblocking
gio.types.PollableReturn writevNonblocking(gio.types.OutputVector[] vectors, size_t bytesWritten, gio.cancellable.Cancellable cancellable)

Attempts to write the bytes contained in the n_vectors vectors to stream, as with gio.output_stream.OutputStream.writev. If stream is not currently writable, this will immediately return %G_POLLABLE_RETURN_WOULD_BLOCK, and you can use gio.pollable_output_stream.PollableOutputStream.createSource to create a #GSource that will be triggered when stream is writable. error will *not* be set in that case.