Package org.gnome.gio

Class IOStream

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.IOStream

All Implemented Interfaces:

Proxy, AutoCloseable, AutoCloseable

Direct Known Subclasses:

FileIOStream, IOStream.IOStreamImpl, SimpleIOStream, SocketConnection, TlsConnection

@Generated("io.github.jwharm.JavaGI")
public abstract class IOStream
extends GObject
implements AutoCloseable

GIOStream represents an object that has both read and write streams. Generally the two streams act as separate input and output streams, but they share some common resources and state. For instance, for seekable streams, both streams may use the same position.

Examples of GIOStream objects are SocketConnection, which represents a two-way network connection; and FileIOStream, which represents a file handle opened in read-write mode.

To do the actual reading and writing you need to get the substreams with getInputStream() and getOutputStream().

The GIOStream object owns the input and the output streams, not the other way around, so keeping the substreams alive will not keep the GIOStream object alive. If the GIOStream object is freed it will be closed, thus closing the substreams, so even if the substreams stay alive they will always return G_IO_ERROR_CLOSED for all operations.

To close a stream use close(org.gnome.gio.Cancellable) which will close the common stream object and also the individual substreams. You can also close the substreams themselves. In most cases this only marks the substream as closed, so further I/O on it fails but common state in the GIOStream may still be open. However, some streams may support ‘half-closed’ states where one direction of the stream is actually shut down.

Operations on GIOStreams cannot be started while another operation on the GIOStream or its substreams is in progress. Specifically, an application can read from the InputStream and write to the OutputStream simultaneously (either in separate threads, or as asynchronous operations in the same thread), but an application cannot start any GIOStream operation while there is a GIOStream, GInputStream or GOutputStream operation in progress, and an application can’t start any GInputStream or GOutputStream operation while there is a GIOStream operation in progress.

This is a product of individual stream operations being associated with a given GLib.MainContext (the thread-default context at the time the operation was started), rather than entire streams being associated with a single GMainContext.

GIO may run operations on GIOStreams from other (worker) threads, and this may be exposed to application code in the behaviour of wrapper streams, such as BufferedInputStream or TlsConnection. With such wrapper APIs, application code may only run operations on the base (wrapped) stream when the wrapper stream is idle. Note that the semantics of such operations may not be well-defined due to the state the wrapper stream leaves the base stream in (though they are guaranteed not to crash).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IOStream.Builder<B extends IOStream.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	IOStream.IOStreamClass
static class	IOStream.IOStreamImpl	The IOStreamImpl type represents a native instance of the abstract IOStream class.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
IOStream(MemorySegment address)	Create a IOStream proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected IOStream	asParent()	Returns this instance as if it were its parent type.
static IOStream.Builder<? extends IOStream.Builder>	builder()	A IOStream.Builder object constructs a IOStream with the specified properties.
void	clearPending()	Clears the pending flag on this IOStream.
boolean	close(@Nullable Cancellable cancellable)	Closes the stream, releasing resources related to it.
void	closeAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Requests an asynchronous close of the stream, releasing resources related to it.
boolean	closeFinish(AsyncResult result)	Closes a stream.
protected boolean	closeFn(@Nullable Cancellable cancellable)
InputStream	getInputStream()	Gets the input stream for this object.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
OutputStream	getOutputStream()	Gets the output stream for this object.
static Type	getType()	Get the GType of the IOStream class
boolean	hasPending()	Checks if a stream has pending actions.
boolean	isClosed()	Checks if a stream is closed.
boolean	setPending()	Sets this IOStream to have actions pending.
void	spliceAsync(IOStream stream2, Set<IOStreamSpliceFlags> flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously splice the output stream of this IOStream to the input stream of stream2, and splice the output stream of stream2 to the input stream of this IOStream.
void	spliceAsync(IOStream stream2, IOStreamSpliceFlags flags, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously splice the output stream of this IOStream to the input stream of stream2, and splice the output stream of stream2 to the input stream of this IOStream.
static boolean	spliceFinish(AsyncResult result)	Finishes an asynchronous io stream splice operation.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.jwharm.javagi.gio.AutoCloseable

close

Constructor Details

IOStream

public IOStream(MemorySegment address)

Create a IOStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the IOStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected IOStream asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

spliceFinish

public static boolean spliceFinish(AsyncResult result)
                            throws GErrorException

Finishes an asynchronous io stream splice operation.

Parameters:

result - a GAsyncResult.

Returns:

true on success, false otherwise.

Throws:

GErrorException - see GError

clearPending

public void clearPending()

Clears the pending flag on this IOStream.

close

public boolean close(@Nullable
 @Nullable Cancellable cancellable)
              throws GErrorException

Closes the stream, releasing resources related to it. This will also close the individual input and output streams, if they are not already closed.

Once the stream is closed, all other operations will return IOErrorEnum.CLOSED. Closing a stream multiple times will not return an error.

Closing a stream will automatically flush any outstanding buffers in the stream.

Streams will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible.

Some streams might keep the backing store of the stream (e.g. a file descriptor) open after the stream is closed. See the documentation for the individual stream for details.

On failure the first error that happened will be reported, but the close operation will finish as much as possible. A stream that failed to close will still return IOErrorEnum.CLOSED for all operations. Still, it is important to check and report the error to the user, otherwise there might be a loss of data as all data might not be written.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IOErrorEnum.CANCELLED will be returned. Cancelling a close will still leave the stream closed, but some streams can use a faster close that doesn't block to e.g. check errors.

The default implementation of this method just calls close on the individual input/output streams.

Specified by:

close in interface AutoCloseable

Parameters:

cancellable - optional GCancellable object, null to ignore

Returns:

true on success, false on failure

Throws:

GErrorException - see GError

closeAsync

public void closeAsync(int ioPriority,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable 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 g_io_stream_close_finish() to get the result of the operation.

For behaviour details see g_io_stream_close().

The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all.

Parameters:

ioPriority - the io priority of the request

cancellable - optional cancellable object

callback - a GAsyncReadyCallback to call when the request is satisfied

closeFinish

public boolean closeFinish(AsyncResult result)
                    throws GErrorException

Closes a stream.

Parameters:

result - a GAsyncResult

Returns:

true if stream was successfully closed, false otherwise.

Throws:

GErrorException - see GError

getInputStream

public InputStream getInputStream()

Gets the input stream for this object. This is used for reading.

Returns:

a GInputStream, owned by the GIOStream. Do not free.

getOutputStream

public OutputStream getOutputStream()

Gets the output stream for this object. This is used for writing.

Returns:

a GOutputStream, owned by the GIOStream. Do not free.

hasPending

public boolean hasPending()

Checks if a stream has pending actions.

Returns:

true if this IOStream has pending actions.

isClosed

public boolean isClosed()

Checks if a stream is closed.

Returns:

true if the stream is closed.

setPending

public boolean setPending()
                   throws GErrorException

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

Returns:

true if pending was previously unset and is now set.

Throws:

GErrorException - see GError

spliceAsync

public void spliceAsync(IOStream stream2,
 Set<IOStreamSpliceFlags> flags,
 int ioPriority,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously splice the output stream of this IOStream to the input stream of stream2, and splice the output stream of stream2 to the input stream of this IOStream.

When the operation is finished callback will be called. You can then call g_io_stream_splice_finish() to get the result of the operation.

Parameters:

stream2 - a GIOStream.

flags - a set of GIOStreamSpliceFlags.

ioPriority - the io priority of the request.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback to call when the request is satisfied

spliceAsync

public void spliceAsync(IOStream stream2,
 IOStreamSpliceFlags flags,
 int ioPriority,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously splice the output stream of this IOStream to the input stream of stream2, and splice the output stream of stream2 to the input stream of this IOStream.

When the operation is finished callback will be called. You can then call g_io_stream_splice_finish() to get the result of the operation.

Parameters:

stream2 - a GIOStream.

flags - a set of GIOStreamSpliceFlags.

ioPriority - the io priority of the request.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback to call when the request is satisfied

closeFn

protected boolean closeFn(@Nullable
 @Nullable Cancellable cancellable)
                   throws GErrorException

Throws:

GErrorException

builder

public static IOStream.Builder<? extends IOStream.Builder> builder()

A IOStream.Builder object constructs a IOStream with the specified properties. Use the various set...() methods to set properties, and finish construction with IOStream.Builder.build().