glib (2.79.0)
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 typedef struct _GSocketConnectableIface GSocketConnectableIface;
38
39 /**
40 * GSocketConnectableIface:
41 * @g_iface: The parent interface.
42 * @enumerate: Creates a #GSocketAddressEnumerator
43 * @proxy_enumerate: Creates a #GProxyAddressEnumerator
44 * @to_string: Format the connectable’s address as a string for debugging.
45 * Implementing this is optional. (Since: 2.48)
46 *
47 * Provides an interface for returning a #GSocketAddressEnumerator
48 * and #GProxyAddressEnumerator
49 */
50 struct _GSocketConnectableIface
51 {
52 GTypeInterface g_iface;
53
54 /* Virtual Table */
55
56 GSocketAddressEnumerator * (* enumerate) (GSocketConnectable *connectable);
57
58 GSocketAddressEnumerator * (* proxy_enumerate) (GSocketConnectable *connectable);
59
60 gchar * (* to_string) (GSocketConnectable *connectable);
61 };
62
63 GIO_AVAILABLE_IN_ALL
64 GType g_socket_connectable_get_type (void) G_GNUC_CONST;
65
66 GIO_AVAILABLE_IN_ALL
67 GSocketAddressEnumerator *g_socket_connectable_enumerate (GSocketConnectable *connectable);
68
69 GIO_AVAILABLE_IN_ALL
70 GSocketAddressEnumerator *g_socket_connectable_proxy_enumerate (GSocketConnectable *connectable);
71
72 GIO_AVAILABLE_IN_2_48
73 gchar *g_socket_connectable_to_string (GSocketConnectable *connectable);
74
75 G_END_DECLS
76
77
78 #endif /* __G_SOCKET_CONNECTABLE_H__ */
Browse
Usage
Versions