Package org.gnome.gio

Class UnixFDMessage

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.SocketControlMessage

org.gnome.gio.UnixFDMessage

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class UnixFDMessage
extends SocketControlMessage

This SocketControlMessage contains a UnixFDList. It may be sent using Socket.sendMessage(org.gnome.gio.SocketAddress, org.gnome.gio.OutputVector[], org.gnome.gio.SocketControlMessage[], int, org.gnome.gio.Cancellable) and received using Socket.receiveMessage(io.github.jwharm.javagi.base.Out<org.gnome.gio.SocketAddress>, org.gnome.gio.InputVector[], io.github.jwharm.javagi.base.Out<org.gnome.gio.SocketControlMessage[]>, io.github.jwharm.javagi.base.Out<java.lang.Integer>, org.gnome.gio.Cancellable) over UNIX sockets (ie: sockets in the G_SOCKET_FAMILY_UNIX family). The file descriptors are copied between processes by the kernel.

For an easier way to send and receive file descriptors over stream-oriented UNIX sockets, see UnixConnection.sendFd(int, org.gnome.gio.Cancellable) and UnixConnection.receiveFd(org.gnome.gio.Cancellable).

Note that <gio/gunixfdmessage.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	UnixFDMessage.Builder<B extends UnixFDMessage.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	UnixFDMessage.UnixFDMessageClass

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

SocketControlMessage.SocketControlMessageClass, SocketControlMessage.SocketControlMessageImpl

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
UnixFDMessage()	Creates a new GUnixFDMessage containing an empty file descriptor list.
UnixFDMessage(MemorySegment address)	Create a UnixFDMessage proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
boolean	appendFd(int fd)	Adds a file descriptor to this UnixFDMessage.
protected UnixFDMessage	asParent()	Returns this instance as if it were its parent type.
static UnixFDMessage.Builder<? extends UnixFDMessage.Builder>	builder()	A UnixFDMessage.Builder object constructs a UnixFDMessage with the specified properties.
UnixFDList	getFdList()	Gets the GUnixFDList contained in this UnixFDMessage.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the UnixFDMessage class
int[]	stealFds()	Returns the array of file descriptors that is contained in this object.
static UnixFDMessage	withFdList(UnixFDList fdList)	Creates a new GUnixFDMessage containing list.

Methods inherited from class org.gnome.gio.SocketControlMessage

deserialize, getLevel, getMsgType, getSize, serialize

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

Constructor Details

UnixFDMessage

public UnixFDMessage(MemorySegment address)

Create a UnixFDMessage proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

UnixFDMessage

public UnixFDMessage()
              throws UnsupportedPlatformException

Creates a new GUnixFDMessage containing an empty file descriptor list.

Throws:

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

Method Details

getType

public static Type getType()

Get the GType of the UnixFDMessage class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected UnixFDMessage 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 SocketControlMessage

withFdList

public static UnixFDMessage withFdList(UnixFDList fdList)

Creates a new GUnixFDMessage containing list.

Parameters:

fdList - a GUnixFDList

Returns:

a new GUnixFDMessage

Throws:

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

appendFd

public boolean appendFd(int fd)
                 throws GErrorException

Adds a file descriptor to this UnixFDMessage.

The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in this UnixFDMessage will be closed when this UnixFDMessage is finalized.

A possible cause of failure is exceeding the per-process or system-wide file descriptor limit.

Parameters:

fd - a valid open file descriptor

Returns:

true in case of success, else false (and error is set)

Throws:

GErrorException - see GError

getFdList

public UnixFDList getFdList()

Gets the GUnixFDList contained in this UnixFDMessage. This function does not return a reference to the caller, but the returned list is valid for the lifetime of this UnixFDMessage.

Returns:

the GUnixFDList from this UnixFDMessage

stealFds

public int[] stealFds()

Returns the array of file descriptors that is contained in this object.

After this call, the descriptors are no longer contained in this UnixFDMessage. Further calls will return an empty list (unless more descriptors have been added).

The return result of this function must be freed with g_free(). The caller is also responsible for closing all of the file descriptors.

If length is non-null then it is set to the number of file descriptors in the returned array. The returned array is also terminated with -1.

This function never returns null. In case there are no file descriptors contained in this UnixFDMessage, an empty array is returned.

Returns:

an array of file descriptors

builder

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

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