gio/ginetaddress.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
   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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Authors: Christian Kellner <gicmo@gnome.org>
  19  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
  20  */
  21
  22 #ifndef __G_INET_ADDRESS_H__
  23 #define __G_INET_ADDRESS_H__
  24
  25 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  26 #error "Only <gio/gio.h> can be included directly."
  27 #endif
  28
  29 #include <gio/giotypes.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define G_TYPE_INET_ADDRESS         (g_inet_address_get_type ())
  34 #define G_INET_ADDRESS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_INET_ADDRESS, GInetAddress))
  35 #define G_INET_ADDRESS_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_INET_ADDRESS, GInetAddressClass))
  36 #define G_IS_INET_ADDRESS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_INET_ADDRESS))
  37 #define G_IS_INET_ADDRESS_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_INET_ADDRESS))
  38 #define G_INET_ADDRESS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_INET_ADDRESS, GInetAddressClass))
  39
  40 typedef struct _GInetAddressClass   GInetAddressClass;
  41 typedef struct _GInetAddressPrivate GInetAddressPrivate;
  42
  43 struct _GInetAddress
  44 {
  45   GObject parent_instance;
  46
  47   /*< private >*/
  48   GInetAddressPrivate *priv;
  49 };
  50
  51 struct _GInetAddressClass
  52 {
  53   GObjectClass parent_class;
  54
  55   gchar *        (*to_string) (GInetAddress *address);
  56   const guint8 * (*to_bytes)  (GInetAddress *address);
  57 };
  58
  59 GLIB_AVAILABLE_IN_ALL
  60 GType                 g_inet_address_get_type             (void) G_GNUC_CONST;
  61
  62 GLIB_AVAILABLE_IN_ALL
  63 GInetAddress *        g_inet_address_new_from_string      (const gchar          *string);
  64
  65 GLIB_AVAILABLE_IN_ALL
  66 GInetAddress *        g_inet_address_new_from_bytes       (const guint8         *bytes,
  67                                                            GSocketFamily         family);
  68
  69 GLIB_AVAILABLE_IN_ALL
  70 GInetAddress *        g_inet_address_new_loopback         (GSocketFamily         family);
  71
  72 GLIB_AVAILABLE_IN_ALL
  73 GInetAddress *        g_inet_address_new_any              (GSocketFamily         family);
  74
  75 GLIB_AVAILABLE_IN_ALL
  76 gboolean              g_inet_address_equal                (GInetAddress         *address,
  77                                                            GInetAddress         *other_address);
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 gchar *               g_inet_address_to_string            (GInetAddress         *address);
  81
  82 GLIB_AVAILABLE_IN_ALL
  83 const guint8 *        g_inet_address_to_bytes             (GInetAddress         *address);
  84
  85 GLIB_AVAILABLE_IN_ALL
  86 gsize                 g_inet_address_get_native_size      (GInetAddress         *address);
  87
  88 GLIB_AVAILABLE_IN_ALL
  89 GSocketFamily         g_inet_address_get_family           (GInetAddress         *address);
  90
  91 GLIB_AVAILABLE_IN_ALL
  92 gboolean              g_inet_address_get_is_any           (GInetAddress         *address);
  93
  94 GLIB_AVAILABLE_IN_ALL
  95 gboolean              g_inet_address_get_is_loopback      (GInetAddress         *address);
  96
  97 GLIB_AVAILABLE_IN_ALL
  98 gboolean              g_inet_address_get_is_link_local    (GInetAddress         *address);
  99
 100 GLIB_AVAILABLE_IN_ALL
 101 gboolean              g_inet_address_get_is_site_local    (GInetAddress         *address);
 102
 103 GLIB_AVAILABLE_IN_ALL
 104 gboolean              g_inet_address_get_is_multicast     (GInetAddress         *address);
 105
 106 GLIB_AVAILABLE_IN_ALL
 107 gboolean              g_inet_address_get_is_mc_global     (GInetAddress         *address);
 108
 109 GLIB_AVAILABLE_IN_ALL
 110 gboolean              g_inet_address_get_is_mc_link_local (GInetAddress         *address);
 111
 112 GLIB_AVAILABLE_IN_ALL
 113 gboolean              g_inet_address_get_is_mc_node_local (GInetAddress         *address);
 114
 115 GLIB_AVAILABLE_IN_ALL
 116 gboolean              g_inet_address_get_is_mc_org_local  (GInetAddress         *address);
 117
 118 GLIB_AVAILABLE_IN_ALL
 119 gboolean              g_inet_address_get_is_mc_site_local (GInetAddress         *address);
 120
 121 G_END_DECLS
 122
 123 #endif /* __G_INET_ADDRESS_H__ */
 124