Package org.gnome.gio

Class SocketConnection

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.IOStream

org.gnome.gio.SocketConnection

All Implemented Interfaces:

Proxy, AutoCloseable, AutoCloseable

Direct Known Subclasses:

TcpConnection, UnixConnection

@Generated("io.github.jwharm.JavaGI")
public class SocketConnection
extends IOStream

GSocketConnection is a IOStream for a connected socket. They can be created either by SocketClient when connecting to a host, or by SocketListener when accepting a new client.

The type of the GSocketConnection object returned from these calls depends on the type of the underlying socket that is in use. For instance, for a TCP/IP connection it will be a TcpConnection.

Choosing what type of object to construct is done with the socket connection factory, and it is possible for third parties to register custom socket connection types for specific combination of socket family/type/protocol using factoryRegisterType(org.gnome.glib.Type, org.gnome.gio.SocketFamily, org.gnome.gio.SocketType, int).

To close a GSocketConnection, use IOStream.close(org.gnome.gio.Cancellable). Closing both substreams of the IOStream separately will not close the underlying Socket.

Nested Class Summary

Nested Classes

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

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

IOStream.IOStreamClass, IOStream.IOStreamImpl

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected SocketConnection	asParent()	Returns this instance as if it were its parent type.
static SocketConnection.Builder<? extends SocketConnection.Builder>	builder()	A SocketConnection.Builder object constructs a SocketConnection with the specified properties.
boolean	connect(SocketAddress address, @Nullable Cancellable cancellable)	Connect this SocketConnection to the specified remote address.
void	connectAsync(SocketAddress address, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously connect this SocketConnection to the specified remote address.
boolean	connectFinish(AsyncResult result)	Gets the result of a g_socket_connection_connect_async() call.
static Type	factoryLookupType(SocketFamily family, SocketType type, int protocolId)	Looks up the GType to be used when creating socket connections on sockets with the specified family, type and protocolId.
static void	factoryRegisterType(Type gType, SocketFamily family, SocketType type, int protocol)	Looks up the GType to be used when creating socket connections on sockets with the specified family, type and protocol.
SocketAddress	getLocalAddress()	Try to get the local address of a socket connection.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
SocketAddress	getRemoteAddress()	Try to get the remote address of a socket connection.
Socket	getSocket()	Gets the underlying GSocket object of the connection.
static Type	getType()	Get the GType of the SocketConnection class
boolean	isConnected()	Checks if this SocketConnection is connected.

Methods inherited from class org.gnome.gio.IOStream

clearPending, close, closeAsync, closeFinish, closeFn, getInputStream, getOutputStream, hasPending, isClosed, setPending, spliceAsync, spliceAsync, spliceFinish

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

Constructor Details

SocketConnection

public SocketConnection(MemorySegment address)

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

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected SocketConnection 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 IOStream

factoryLookupType

public static Type factoryLookupType(SocketFamily family,
 SocketType type,
 int protocolId)

Looks up the GType to be used when creating socket connections on sockets with the specified family, type and protocolId.

If no type is registered, the GSocketConnection base type is returned.

Parameters:

family - a GSocketFamily

type - a GSocketType

protocolId - a protocol id

Returns:

a GType

factoryRegisterType

public static void factoryRegisterType(Type gType,
 SocketFamily family,
 SocketType type,
 int protocol)

Looks up the GType to be used when creating socket connections on sockets with the specified family, type and protocol.

If no type is registered, the GSocketConnection base type is returned.

Parameters:

gType - a GType, inheriting from G_TYPE_SOCKET_CONNECTION

family - a GSocketFamily

type - a GSocketType

protocol - a protocol id

connect

public boolean connect(SocketAddress address,
 @Nullable
 @Nullable Cancellable cancellable)
                throws GErrorException

Connect this SocketConnection to the specified remote address.

Parameters:

address - a GSocketAddress specifying the remote address.

cancellable - a GCancellable or null

Returns:

true if the connection succeeded, false on error

Throws:

GErrorException - see GError

connectAsync

public void connectAsync(SocketAddress address,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously connect this SocketConnection to the specified remote address.

This clears the GSocket:blocking flag on this SocketConnection's underlying socket if it is currently set.

If GSocket:timeout is set, the operation will time out and return IOErrorEnum.TIMED_OUT after that period. Otherwise, it will continue indefinitely until operating system timeouts (if any) are hit.

Use g_socket_connection_connect_finish() to retrieve the result.

Parameters:

address - a GSocketAddress specifying the remote address.

cancellable - a GCancellable or null

callback - a GAsyncReadyCallback

connectFinish

public boolean connectFinish(AsyncResult result)
                      throws GErrorException

Gets the result of a g_socket_connection_connect_async() call.

Parameters:

result - the GAsyncResult

Returns:

true if the connection succeeded, false on error

Throws:

GErrorException - see GError

getLocalAddress

public SocketAddress getLocalAddress()
                              throws GErrorException

Try to get the local address of a socket connection.

Returns:

a GSocketAddress or null on error. Free the returned object with g_object_unref().

Throws:

GErrorException - see GError

getRemoteAddress

public SocketAddress getRemoteAddress()
                               throws GErrorException

Try to get the remote address of a socket connection.

Since GLib 2.40, when used with g_socket_client_connect() or g_socket_client_connect_async(), during emission of SocketClientEvent.CONNECTING, this function will return the remote address that will be used for the connection. This allows applications to print e.g. "Connecting to example.com (10.42.77.3)...".

Returns:

a GSocketAddress or null on error. Free the returned object with g_object_unref().

Throws:

GErrorException - see GError

getSocket

public Socket getSocket()

Gets the underlying GSocket object of the connection. This can be useful if you want to do something unusual on it not supported by the GSocketConnection APIs.

Returns:

a GSocket or null on error.

isConnected

public boolean isConnected()

Checks if this SocketConnection is connected. This is equivalent to calling g_socket_is_connected() on this SocketConnection's underlying GSocket.

Returns:

whether this SocketConnection is connected

builder

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

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