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 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, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __G_SOCKET_ADDRESS_ENUMERATOR_H__
  22 #define __G_SOCKET_ADDRESS_ENUMERATOR_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_ADDRESS_ENUMERATOR         (g_socket_address_enumerator_get_type ())
  33 #define G_SOCKET_ADDRESS_ENUMERATOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_SOCKET_ADDRESS_ENUMERATOR, GSocketAddressEnumerator))
  34 #define G_SOCKET_ADDRESS_ENUMERATOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_SOCKET_ADDRESS_ENUMERATOR, GSocketAddressEnumeratorClass))
  35 #define G_IS_SOCKET_ADDRESS_ENUMERATOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_SOCKET_ADDRESS_ENUMERATOR))
  36 #define G_IS_SOCKET_ADDRESS_ENUMERATOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_SOCKET_ADDRESS_ENUMERATOR))
  37 #define G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_SOCKET_ADDRESS_ENUMERATOR, GSocketAddressEnumeratorClass))
  38
  39 /**
  40  * GSocketAddressEnumerator:
  41  *
  42  * Enumerator type for objects that contain or generate
  43  * #GSocketAddress<!-- -->es.
  44  */
  45 typedef struct _GSocketAddressEnumeratorClass GSocketAddressEnumeratorClass;
  46
  47 struct _GSocketAddressEnumerator
  48 {
  49   GObject parent_instance;
  50
  51 };
  52
  53 struct _GSocketAddressEnumeratorClass
  54 {
  55   GObjectClass parent_class;
  56
  57   /* Virtual Table */
  58
  59   GSocketAddress * (* next)        (GSocketAddressEnumerator  *enumerator,
  60                                     GCancellable              *cancellable,
  61                                     GError                   **error);
  62
  63   void             (* next_async)  (GSocketAddressEnumerator  *enumerator,
  64                                     GCancellable              *cancellable,
  65                                     GAsyncReadyCallback        callback,
  66                                     gpointer                   user_data);
  67   GSocketAddress * (* next_finish) (GSocketAddressEnumerator  *enumerator,
  68                                     GAsyncResult              *result,
  69                                     GError                   **error);
  70 };
  71
  72 GLIB_AVAILABLE_IN_ALL
  73 GType           g_socket_address_enumerator_get_type        (void) G_GNUC_CONST;
  74
  75 GLIB_AVAILABLE_IN_ALL
  76 GSocketAddress *g_socket_address_enumerator_next        (GSocketAddressEnumerator  *enumerator,
  77                                                          GCancellable              *cancellable,
  78                                                          GError                   **error);
  79
  80 GLIB_AVAILABLE_IN_ALL
  81 void            g_socket_address_enumerator_next_async  (GSocketAddressEnumerator  *enumerator,
  82                                                          GCancellable              *cancellable,
  83                                                          GAsyncReadyCallback        callback,
  84                                                          gpointer                   user_data);
  85 GLIB_AVAILABLE_IN_ALL
  86 GSocketAddress *g_socket_address_enumerator_next_finish (GSocketAddressEnumerator  *enumerator,
  87                                                          GAsyncResult              *result,
  88                                                          GError                   **error);
  89
  90 G_END_DECLS
  91
  92
  93 #endif /* __G_SOCKET_ADDRESS_ENUMERATOR_H__ */