gio/gsocketconnectable.h

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