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.1 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_ADDRESS_ENUMERATOR_H__
20#define __G_SOCKET_ADDRESS_ENUMERATOR_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
28G_BEGIN_DECLS
29
30#define G_TYPE_SOCKET_ADDRESS_ENUMERATOR (g_socket_address_enumerator_get_type ())
31#define G_SOCKET_ADDRESS_ENUMERATOR(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_SOCKET_ADDRESS_ENUMERATOR, GSocketAddressEnumerator))
32#define G_SOCKET_ADDRESS_ENUMERATOR_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_SOCKET_ADDRESS_ENUMERATOR, GSocketAddressEnumeratorClass))
33#define G_IS_SOCKET_ADDRESS_ENUMERATOR(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_SOCKET_ADDRESS_ENUMERATOR))
34#define G_IS_SOCKET_ADDRESS_ENUMERATOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_SOCKET_ADDRESS_ENUMERATOR))
35#define G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_SOCKET_ADDRESS_ENUMERATOR, GSocketAddressEnumeratorClass))
36
37/**
38 * GSocketAddressEnumerator:
39 *
40 * Enumerator type for objects that contain or generate
41 * #GSocketAddress instances.
42 */
43typedef struct _GSocketAddressEnumeratorClass GSocketAddressEnumeratorClass;
44
45struct _GSocketAddressEnumerator
46{
47 /*< private >*/
48 GObject parent_instance;
49};
50
51/**
52 * GSocketAddressEnumeratorClass:
53 * @next: Virtual method for g_socket_address_enumerator_next().
54 * @next_async: Virtual method for g_socket_address_enumerator_next_async().
55 * @next_finish: Virtual method for g_socket_address_enumerator_next_finish().
56 *
57 * Class structure for #GSocketAddressEnumerator.
58 */
59struct _GSocketAddressEnumeratorClass
60{
61 /*< private >*/
62 GObjectClass parent_class;
63
64 /*< public >*/
65 /* Virtual Table */
66
67 GSocketAddress * (* next) (GSocketAddressEnumerator *enumerator,
68 GCancellable *cancellable,
69 GError **error);
70
71 void (* next_async) (GSocketAddressEnumerator *enumerator,
72 GCancellable *cancellable,
73 GAsyncReadyCallback callback,
74 gpointer user_data);
75 GSocketAddress * (* next_finish) (GSocketAddressEnumerator *enumerator,
76 GAsyncResult *result,
77 GError **error);
78};
79
80GLIB_AVAILABLE_IN_ALL
81GType g_socket_address_enumerator_get_type (void) G_GNUC_CONST;
82
83GLIB_AVAILABLE_IN_ALL
84GSocketAddress *g_socket_address_enumerator_next (GSocketAddressEnumerator *enumerator,
85 GCancellable *cancellable,
86 GError **error);
87
88GLIB_AVAILABLE_IN_ALL
89void g_socket_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
90 GCancellable *cancellable,
91 GAsyncReadyCallback callback,
92 gpointer user_data);
93GLIB_AVAILABLE_IN_ALL
94GSocketAddress *g_socket_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
95 GAsyncResult *result,
96 GError **error);
97
98G_END_DECLS
99
100
101#endif /* __G_SOCKET_ADDRESS_ENUMERATOR_H__ */
102