Interface SocketConnectable

All Superinterfaces:

Proxy

All Known Implementing Classes:

InetSocketAddress, NativeSocketAddress, NetworkAddress, NetworkService, ProxyAddress, SocketAddress, SocketAddress.SocketAddress$Impl, SocketConnectable.SocketConnectable$Impl, UnixSocketAddress

@Generated("org.javagi.JavaGI")
public interface SocketConnectable
extends Proxy

Objects that describe one or more potential socket endpoints implement GSocketConnectable. Callers can then use enumerate() to get a SocketAddressEnumerator to try out each socket address in turn until one succeeds, as shown in the sample code below.

MyConnectionType *
connect_to_host (const char    *hostname,
                 guint16        port,
                 GCancellable  *cancellable,
                 GError       **error)
{
  MyConnection *conn = NULL;
  GSocketConnectable *addr;
  GSocketAddressEnumerator *enumerator;
  GSocketAddress *sockaddr;
  GError *conn_error = NULL;

  addr = g_network_address_new (hostname, port);
  enumerator = g_socket_connectable_enumerate (addr);
  g_object_unref (addr);

  // Try each sockaddr until we succeed. Record the first connection error,
  // but not any further ones (since they'll probably be basically the same
  // as the first).
  while (!conn && (sockaddr = g_socket_address_enumerator_next (enumerator, cancellable, error))
    {
      conn = connect_to_sockaddr (sockaddr, conn_error ? NULL : &conn_error);
      g_object_unref (sockaddr);
    }
  g_object_unref (enumerator);

  if (conn)
    {
      if (conn_error)
        {
          // We couldn't connect to the first address, but we succeeded
          // in connecting to a later address.
          g_error_free (conn_error);
        }
      return conn;
    }
  else if (error)
    {
      /// Either initial lookup failed, or else the caller cancelled us.
      if (conn_error)
        g_error_free (conn_error);
      return NULL;
    }
  else
    {
      g_error_propagate (error, conn_error);
      return NULL;
    }
}

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SocketConnectable.SocketConnectable$Impl	The SocketConnectable$Impl type represents a native instance of the SocketConnectable interface.
static class	SocketConnectable.SocketConnectableIface	Provides an interface for returning a GSocketAddressEnumerator and GProxyAddressEnumerator

Method Summary

Modifier and Type	Method	Description
default SocketAddressEnumerator	enumerate()	Creates a GSocketAddressEnumerator for connectable.
default String	formatAsString()	Format a GSocketConnectable as a string.
static @Nullable Type	getType()	Get the GType of the SocketConnectable class.
default SocketAddressEnumerator	proxyEnumerate()	Creates a GSocketAddressEnumerator for this SocketConnectable that will return a GProxyAddress for each of its addresses that you must connect to via a proxy.

Methods inherited from interface Proxy

handle

Method Details

getType

static @Nullable Type getType()

Get the GType of the SocketConnectable class.

Returns:

the GType

enumerate

default SocketAddressEnumerator enumerate()

Creates a GSocketAddressEnumerator for connectable.

Returns:

a new GSocketAddressEnumerator.

Since:

2.22

proxyEnumerate

default SocketAddressEnumerator proxyEnumerate()

Creates a GSocketAddressEnumerator for this SocketConnectable that will return a GProxyAddress for each of its addresses that you must connect to via a proxy.

If this SocketConnectable does not implement g_socket_connectable_proxy_enumerate(), this will fall back to calling g_socket_connectable_enumerate().

Returns:

a new GSocketAddressEnumerator.

Since:

2.26

formatAsString

default String formatAsString()

Format a GSocketConnectable as a string. This is a human-readable format for use in debugging output, and is not a stable serialization format. It is not suitable for use in user interfaces as it exposes too much information for a user.

If the GSocketConnectable implementation does not support string formatting, the implementation’s type name will be returned as a fallback.

Returns:

the formatted string

Since:

2.48