glib-2.0/gio/gsocketconnectable.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2008 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  */
0020
0021 #ifndef __G_SOCKET_CONNECTABLE_H__
0022 #define __G_SOCKET_CONNECTABLE_H__
0023
0024 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0025 #error "Only <gio/gio.h> can be included directly."
0026 #endif
0027
0028 #include <gio/giotypes.h>
0029
0030 G_BEGIN_DECLS
0031
0032 #define G_TYPE_SOCKET_CONNECTABLE            (g_socket_connectable_get_type ())
0033 #define G_SOCKET_CONNECTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectable))
0034 #define G_IS_SOCKET_CONNECTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SOCKET_CONNECTABLE))
0035 #define G_SOCKET_CONNECTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectableIface))
0036
0037 typedef struct _GSocketConnectableIface GSocketConnectableIface;
0038
0039 /**
0040  * GSocketConnectableIface:
0041  * @g_iface: The parent interface.
0042  * @enumerate: Creates a #GSocketAddressEnumerator
0043  * @proxy_enumerate: Creates a #GProxyAddressEnumerator
0044  * @to_string: Format the connectable’s address as a string for debugging.
0045  *    Implementing this is optional. (Since: 2.48)
0046  *
0047  * Provides an interface for returning a #GSocketAddressEnumerator
0048  * and #GProxyAddressEnumerator
0049  */
0050 struct _GSocketConnectableIface
0051 {
0052   GTypeInterface g_iface;
0053
0054   /* Virtual Table */
0055
0056   GSocketAddressEnumerator * (* enumerate)       (GSocketConnectable *connectable);
0057
0058   GSocketAddressEnumerator * (* proxy_enumerate) (GSocketConnectable *connectable);
0059
0060   gchar                    * (* to_string)       (GSocketConnectable *connectable);
0061 };
0062
0063 GIO_AVAILABLE_IN_ALL
0064 GType                     g_socket_connectable_get_type  (void) G_GNUC_CONST;
0065
0066 GIO_AVAILABLE_IN_ALL
0067 GSocketAddressEnumerator *g_socket_connectable_enumerate (GSocketConnectable *connectable);
0068
0069 GIO_AVAILABLE_IN_ALL
0070 GSocketAddressEnumerator *g_socket_connectable_proxy_enumerate (GSocketConnectable *connectable);
0071
0072 GIO_AVAILABLE_IN_2_48
0073 gchar                    *g_socket_connectable_to_string (GSocketConnectable *connectable);
0074
0075 G_END_DECLS
0076
0077
0078 #endif /* __G_SOCKET_CONNECTABLE_H__ */