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