Merge branch '976-disable-assert-checks' into 'master'
[glib.git] / gio / gsocketaddressenumerator.h
blobf148f6369b84a15981cc40a91c8cc28901f0c223
1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2008 Red Hat, Inc.
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.
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.
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/>.
19 #ifndef __G_SOCKET_ADDRESS_ENUMERATOR_H__
20 #define __G_SOCKET_ADDRESS_ENUMERATOR_H__
22 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
23 #error "Only <gio/gio.h> can be included directly."
24 #endif
26 #include <gio/giotypes.h>
28 G_BEGIN_DECLS
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))
37 /**
38 * GSocketAddressEnumerator:
40 * Enumerator type for objects that contain or generate
41 * #GSocketAddress instances.
43 typedef struct _GSocketAddressEnumeratorClass GSocketAddressEnumeratorClass;
45 struct _GSocketAddressEnumerator
47 GObject parent_instance;
51 struct _GSocketAddressEnumeratorClass
53 GObjectClass parent_class;
55 /* Virtual Table */
57 GSocketAddress * (* next) (GSocketAddressEnumerator *enumerator,
58 GCancellable *cancellable,
59 GError **error);
61 void (* next_async) (GSocketAddressEnumerator *enumerator,
62 GCancellable *cancellable,
63 GAsyncReadyCallback callback,
64 gpointer user_data);
65 GSocketAddress * (* next_finish) (GSocketAddressEnumerator *enumerator,
66 GAsyncResult *result,
67 GError **error);
70 GLIB_AVAILABLE_IN_ALL
71 GType g_socket_address_enumerator_get_type (void) G_GNUC_CONST;
73 GLIB_AVAILABLE_IN_ALL
74 GSocketAddress *g_socket_address_enumerator_next (GSocketAddressEnumerator *enumerator,
75 GCancellable *cancellable,
76 GError **error);
78 GLIB_AVAILABLE_IN_ALL
79 void g_socket_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
80 GCancellable *cancellable,
81 GAsyncReadyCallback callback,
82 gpointer user_data);
83 GLIB_AVAILABLE_IN_ALL
84 GSocketAddress *g_socket_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
85 GAsyncResult *result,
86 GError **error);
88 G_END_DECLS
91 #endif /* __G_SOCKET_ADDRESS_ENUMERATOR_H__ */