Package org.gnome.gio

Class SocketAddressEnumerator

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.SocketAddressEnumerator

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

ProxyAddressEnumerator, SocketAddressEnumerator.SocketAddressEnumeratorImpl

@Generated("io.github.jwharm.JavaGI")
public abstract class SocketAddressEnumerator
extends GObject

GSocketAddressEnumerator is an enumerator type for SocketAddress instances. It is returned by enumeration functions such as SocketConnectable.enumerate(), which returns a GSocketAddressEnumerator to list each SocketAddress which could be used to connect to that SocketConnectable.

Enumeration is typically a blocking operation, so the asynchronous methods nextAsync(org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) and nextFinish(org.gnome.gio.AsyncResult) should be used where possible.

Each GSocketAddressEnumerator can only be enumerated once. Once next(org.gnome.gio.Cancellable) has returned NULL, further enumeration with that GSocketAddressEnumerator is not possible, and it can be unreffed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SocketAddressEnumerator.Builder<B extends SocketAddressEnumerator.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	SocketAddressEnumerator.SocketAddressEnumeratorClass	Class structure for GSocketAddressEnumerator.
static class	SocketAddressEnumerator.SocketAddressEnumeratorImpl	The SocketAddressEnumeratorImpl type represents a native instance of the abstract SocketAddressEnumerator class.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected SocketAddressEnumerator	asParent()	Returns this instance as if it were its parent type.
static SocketAddressEnumerator.Builder<? extends SocketAddressEnumerator.Builder>	builder()	A SocketAddressEnumerator.Builder object constructs a SocketAddressEnumerator with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the SocketAddressEnumerator class
SocketAddress	next(@Nullable Cancellable cancellable)	Retrieves the next GSocketAddress from this SocketAddressEnumerator.
void	nextAsync(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously retrieves the next GSocketAddress from this SocketAddressEnumerator and then calls callback, which must call g_socket_address_enumerator_next_finish() to get the result.
SocketAddress	nextFinish(AsyncResult result)	Retrieves the result of a completed call to g_socket_address_enumerator_next_async().

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

Constructor Details

SocketAddressEnumerator

public SocketAddressEnumerator(MemorySegment address)

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

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

next

public SocketAddress next(@Nullable
 @Nullable Cancellable cancellable)
                   throws GErrorException

Retrieves the next GSocketAddress from this SocketAddressEnumerator. Note that this may block for some amount of time. (Eg, a GNetworkAddress may need to do a DNS lookup before it can return an address.) Use g_socket_address_enumerator_next_async() if you need to avoid blocking.

If this SocketAddressEnumerator is expected to yield addresses, but for some reason is unable to (eg, because of a DNS error), then the first call to g_socket_address_enumerator_next() will return an appropriate error in *error. However, if the first call to g_socket_address_enumerator_next() succeeds, then any further internal errors (other than cancellable being triggered) will be ignored.

Parameters:

cancellable - optional GCancellable object, null to ignore.

Returns:

a GSocketAddress (owned by the caller), or null on error (in which case *error will be set) or if there are no more addresses.

Throws:

GErrorException - see GError

nextAsync

public void nextAsync(@Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously retrieves the next GSocketAddress from this SocketAddressEnumerator and then calls callback, which must call g_socket_address_enumerator_next_finish() to get the result.

It is an error to call this multiple times before the previous callback has finished.

Parameters:

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback to call when the request is satisfied

nextFinish

public SocketAddress nextFinish(AsyncResult result)
                         throws GErrorException

Retrieves the result of a completed call to g_socket_address_enumerator_next_async(). See g_socket_address_enumerator_next() for more information about error handling.

Parameters:

result - a GAsyncResult

Returns:

a GSocketAddress (owned by the caller), or null on error (in which case *error will be set) or if there are no more addresses.

Throws:

GErrorException - see GError

builder

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

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