GI.Gio.Interfaces.SocketConnectable

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

C code

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;
    }
}

Exported types

newtype SocketConnectable

Constructors

SocketConnectable (ManagedPtr SocketConnectable)

Instances

GObject SocketConnectable

Methods

gobjectType :: SocketConnectable -> IO GType

IsObject SocketConnectable

IsSocketConnectable SocketConnectable

((~) * info (ResolveSocketConnectableMethod t SocketConnectable), MethodInfo * info SocketConnectable p) => IsLabel t (SocketConnectable -> p)

Methods

fromLabel :: Proxy# Symbol t -> SocketConnectable -> p

((~) * info (ResolveSocketConnectableMethod t SocketConnectable), MethodInfo * info SocketConnectable p) => IsLabelProxy t (SocketConnectable -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> SocketConnectable -> p

HasAttributeList * SocketConnectable

type AttributeList SocketConnectable

type AttributeList SocketConnectable

type SignalList SocketConnectable

type SignalList SocketConnectable

noSocketConnectable :: Maybe SocketConnectable

class GObject o => IsSocketConnectable o

Instances

(GObject a, UnknownAncestorError Constraint SocketConnectable a) => IsSocketConnectable a

IsSocketConnectable SocketAddress

IsSocketConnectable ProxyAddress

IsSocketConnectable InetSocketAddress

IsSocketConnectable SocketConnectable

IsSocketConnectable NetworkAddress

IsSocketConnectable NetworkService

IsSocketConnectable UnixSocketAddress

toSocketConnectable :: IsSocketConnectable o => o -> IO SocketConnectable

Methods

enumerate

data SocketConnectableEnumerateMethodInfo

Instances

((~) * signature (m SocketAddressEnumerator), MonadIO m, IsSocketConnectable a) => MethodInfo * SocketConnectableEnumerateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SocketConnectableEnumerateMethodInfo a -> signature -> s

socketConnectableEnumerate

Arguments

:: (HasCallStack, MonadIO m, IsSocketConnectable a)

=> a

connectable: a SocketConnectable

-> m SocketAddressEnumerator

Returns: a new SocketAddressEnumerator.

Creates a SocketAddressEnumerator for connectable.

Since: 2.22

proxyEnumerate

data SocketConnectableProxyEnumerateMethodInfo

Instances

((~) * signature (m SocketAddressEnumerator), MonadIO m, IsSocketConnectable a) => MethodInfo * SocketConnectableProxyEnumerateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SocketConnectableProxyEnumerateMethodInfo a -> signature -> s

socketConnectableProxyEnumerate

Arguments

:: (HasCallStack, MonadIO m, IsSocketConnectable a)

=> a

connectable: a SocketConnectable

-> m SocketAddressEnumerator

Returns: a new SocketAddressEnumerator.

Creates a SocketAddressEnumerator for connectable that will return GProxyAddresses for addresses that you must connect to via a proxy.

If connectable does not implement socketConnectableProxyEnumerate, this will fall back to calling socketConnectableEnumerate.

Since: 2.26

toString

data SocketConnectableToStringMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsSocketConnectable a) => MethodInfo * SocketConnectableToStringMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SocketConnectableToStringMethodInfo a -> signature -> s

socketConnectableToString

Arguments

:: (HasCallStack, MonadIO m, IsSocketConnectable a)

=> a

connectable: a SocketConnectable

-> m Text

Returns: the formatted string

Format a SocketConnectable 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 SocketConnectable implementation does not support string formatting, the implementation’s type name will be returned as a fallback.

Since: 2.48