gio/gsocketconnectable.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2008 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef __G_SOCKET_CONNECTABLE_H__
  22 #define __G_SOCKET_CONNECTABLE_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/giotypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_SOCKET_CONNECTABLE            (g_socket_connectable_get_type ())
  33 #define G_SOCKET_CONNECTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectable))
  34 #define G_IS_SOCKET_CONNECTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SOCKET_CONNECTABLE))
  35 #define G_SOCKET_CONNECTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectableIface))
  36
  37 /**
  38  * GSocketConnectable:
  39  *
  40  * Interface for objects that contain or generate a #GSocketAddress.
  41  */
  42 typedef struct _GSocketConnectableIface GSocketConnectableIface;
  43
  44 /**
  45  * GSocketConnectableIface:
  46  * @g_iface: The parent interface.
  47  * @enumerate: Creates a #GSocketAddressEnumerator
  48  * @proxy_enumerate: Creates a #GProxyAddressEnumerator
  49  * @to_string: Format the connectable’s address as a string for debugging.
  50  *    Implementing this is optional. (Since: 2.48)
  51  *
  52  * Provides an interface for returning a #GSocketAddressEnumerator
  53  * and #GProxyAddressEnumerator
  54  */
  55 struct _GSocketConnectableIface
  56 {
  57   GTypeInterface g_iface;
  58
  59   /* Virtual Table */
  60
  61   GSocketAddressEnumerator * (* enumerate)       (GSocketConnectable *connectable);
  62
  63   GSocketAddressEnumerator * (* proxy_enumerate) (GSocketConnectable *connectable);
  64
  65   gchar                    * (* to_string)       (GSocketConnectable *connectable);
  66 };
  67
  68 GIO_AVAILABLE_IN_ALL
  69 GType                     g_socket_connectable_get_type  (void) G_GNUC_CONST;
  70
  71 GIO_AVAILABLE_IN_ALL
  72 GSocketAddressEnumerator *g_socket_connectable_enumerate (GSocketConnectable *connectable);
  73
  74 GIO_AVAILABLE_IN_ALL
  75 GSocketAddressEnumerator *g_socket_connectable_proxy_enumerate (GSocketConnectable *connectable);
  76
  77 GIO_AVAILABLE_IN_2_48
  78 gchar                    *g_socket_connectable_to_string (GSocketConnectable *connectable);
  79
  80 G_END_DECLS
  81
  82
  83 #endif /* __G_SOCKET_CONNECTABLE_H__ */