Package org.gnome.gio

Class UnixInputStream

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.InputStream

org.gnome.gio.UnixInputStream

All Implemented Interfaces:

Proxy, AutoCloseable, AutoCloseable, FileDescriptorBased, PollableInputStream

@Generated("io.github.jwharm.JavaGI")
public class UnixInputStream
extends InputStream
implements FileDescriptorBased, PollableInputStream

GUnixInputStream implements InputStream for reading from 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/gunixinputstream.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file or the GioUnix-2.0 GIR namespace when using it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnixInputStream.Builder<B extends UnixInputStream.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	UnixInputStream.UnixInputStreamClass

Nested classes/interfaces inherited from class org.gnome.gio.InputStream

InputStream.InputStreamClass, InputStream.InputStreamImpl

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.FileDescriptorBased

FileDescriptorBased.FileDescriptorBasedIface, FileDescriptorBased.FileDescriptorBasedImpl

Nested classes/interfaces inherited from interface org.gnome.gio.PollableInputStream

PollableInputStream.PollableInputStreamImpl, PollableInputStream.PollableInputStreamInterface

Constructor Summary

Constructors

Constructor	Description
UnixInputStream(int fd, boolean closeFd)	Creates a new GUnixInputStream for the given fd.
UnixInputStream(MemorySegment address)	Create a UnixInputStream proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected UnixInputStream	asParent()	Returns this instance as if it were its parent type.
static UnixInputStream.Builder<? extends UnixInputStream.Builder>	builder()	A UnixInputStream.Builder object constructs a UnixInputStream with the specified properties.
boolean	getCloseFd()	Returns whether the file descriptor of this UnixInputStream will be closed when the stream is closed.
int	getFd()	Return the UNIX file descriptor that the stream reads from.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the UnixInputStream class
void	setCloseFd(boolean closeFd)	Sets whether the file descriptor of this UnixInputStream shall be closed when the stream is closed.

Methods inherited from class org.gnome.gio.InputStream

clearPending, close, closeAsync, closeFinish, closeFn, hasPending, isClosed, read, readAll, readAllAsync, readAllFinish, readAsync, readBytes, readBytesAsync, readBytesFinish, readFinish, readFn, setPending, skip, skipAsync, skipFinish

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, 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

Methods inherited from interface org.gnome.gio.PollableInputStream

canPoll, createSource, isReadable, readNonblocking

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

UnixInputStream

public UnixInputStream(MemorySegment address)

Create a UnixInputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

UnixInputStream

public UnixInputStream(int fd,
 boolean closeFd)
                throws UnsupportedPlatformException

Creates a new GUnixInputStream for the given fd.

If closeFd is true, the file descriptor will be closed when the stream is closed.

Parameters:

fd - a UNIX file descriptor

closeFd - true to close the file descriptor when done

Throws:

UnsupportedPlatformException - when run on a platform other than linux or macos

Method Details

getType

public static Type getType()

Get the GType of the UnixInputStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected UnixInputStream 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 InputStream

getCloseFd

public boolean getCloseFd()

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

Returns:

true if the file descriptor is closed when done

getFd

public int getFd()

Return the UNIX file descriptor that the stream reads from.

Specified by:

getFd in interface FileDescriptorBased

Returns:

The file descriptor of this UnixInputStream

setCloseFd

public void setCloseFd(boolean closeFd)

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

Parameters:

closeFd - true to close the file descriptor when done

builder

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

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