gio/gsocketaddressenumerator.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.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
  28 G_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<!-- -->es.
  42  */
  43 typedef struct _GSocketAddressEnumeratorClass GSocketAddressEnumeratorClass;
  44
  45 struct _GSocketAddressEnumerator
  46 {
  47   GObject parent_instance;
  48
  49 };
  50
  51 struct _GSocketAddressEnumeratorClass
  52 {
  53   GObjectClass parent_class;
  54
  55   /* Virtual Table */
  56
  57   GSocketAddress * (* next)        (GSocketAddressEnumerator  *enumerator,
  58                                     GCancellable              *cancellable,
  59                                     GError                   **error);
  60
  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);
  68 };
  69
  70 GLIB_AVAILABLE_IN_ALL
  71 GType           g_socket_address_enumerator_get_type        (void) G_GNUC_CONST;
  72
  73 GLIB_AVAILABLE_IN_ALL
  74 GSocketAddress *g_socket_address_enumerator_next        (GSocketAddressEnumerator  *enumerator,
  75                                                          GCancellable              *cancellable,
  76                                                          GError                   **error);
  77
  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);
  87
  88 G_END_DECLS
  89
  90
  91 #endif /* __G_SOCKET_ADDRESS_ENUMERATOR_H__ */