Package org.gnome.gio

Class SocketAddress

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.SocketAddress

All Implemented Interfaces:

Proxy, SocketConnectable

Direct Known Subclasses:

InetSocketAddress, NativeSocketAddress, SocketAddress.SocketAddressImpl, UnixSocketAddress

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

GSocketAddress is the equivalent of struct sockaddr) and its subtypes in the BSD sockets API. This is an abstract class; use InetSocketAddress for internet sockets, or UnixSocketAddress for UNIX domain sockets.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

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

SocketConnectable.SocketConnectableIface, SocketConnectable.SocketConnectableImpl

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected SocketAddress	asParent()	Returns this instance as if it were its parent type.
static SocketAddress.Builder<? extends SocketAddress.Builder>	builder()	A SocketAddress.Builder object constructs a SocketAddress with the specified properties.
static SocketAddress	fromNative(MemorySegment native_, long len)	Creates a GSocketAddress subclass corresponding to the native struct sockaddr native_.
SocketFamily	getFamily()	Gets the socket family type of this SocketAddress.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
long	getNativeSize()	Gets the size of this SocketAddress's native struct sockaddr.
static Type	getType()	Get the GType of the SocketAddress class
boolean	toNative(@Nullable MemorySegment dest, long destlen)	Converts a GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind().

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.base.Proxy

handle

Methods inherited from interface org.gnome.gio.SocketConnectable

enumerate, proxyEnumerate, toString_

Constructor Details

SocketAddress

public SocketAddress(MemorySegment address)

Create a SocketAddress 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 SocketAddress class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected SocketAddress 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

fromNative

public static SocketAddress fromNative(MemorySegment native_,
 long len)

Creates a GSocketAddress subclass corresponding to the native struct sockaddr native_.

Parameters:

native_ - a pointer to a struct sockaddr

len - the size of the memory location pointed to by native_

Returns:

a new GSocketAddress if native_ could successfully be converted, otherwise null

getFamily

public SocketFamily getFamily()

Gets the socket family type of this SocketAddress.

Returns:

the socket family type of this SocketAddress

getNativeSize

public long getNativeSize()

Gets the size of this SocketAddress's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native().

Returns:

the size of the native struct sockaddr that this SocketAddress represents

toNative

public boolean toNative(@Nullable
 @Nullable MemorySegment dest,
 long destlen)
                 throws GErrorException

Converts a GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind().

If not enough space is available, a IOErrorEnum.NO_SPACE error is returned. If the address type is not known on the system then a IOErrorEnum.NOT_SUPPORTED error is returned.

Parameters:

dest - a pointer to a memory location that will contain the native struct sockaddr

destlen - the size of dest. Must be at least as large as g_socket_address_get_native_size()

Returns:

true if dest was filled in, false on error

Throws:

GErrorException - see GError

builder

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

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