gio/gsocketaddress.c

   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 #include <config.h>
  25 #include <glib.h>
  26
  27 #include "gsocketaddress.h"
  28 #include "ginetaddress.h"
  29 #include "ginetsocketaddress.h"
  30 #include "gnetworkingprivate.h"
  31 #include "gsocketaddressenumerator.h"
  32 #include "gsocketconnectable.h"
  33 #include "glibintl.h"
  34 #include "gioenumtypes.h"
  35
  36 #ifdef G_OS_UNIX
  37 #include "gunixsocketaddress.h"
  38 #endif
  39
  40 #include "gioalias.h"
  41
  42 /**
  43  * SECTION:gsocketaddress
  44  * @short_description: Abstract base class representing endpoints for
  45  * socket communication
  46  *
  47  * #GSocketAddress is the equivalent of <type>struct sockaddr</type>
  48  * in the BSD sockets API. This is an abstract class; use
  49  * #GInetSocketAddress for internet sockets, or #GUnixSocketAddress
  50  * for UNIX domain sockets.
  51  **/
  52
  53 /**
  54  * GSocketAddress:
  55  *
  56  * A socket endpoint address, corresponding to <type>struct sockaddr</type>
  57  * or one of its subtypes.
  58  **/
  59
  60 enum
  61 {
  62   PROP_NONE,
  63   PROP_FAMILY
  64 };
  65
  66 static void                      g_socket_address_connectable_iface_init (GSocketConnectableIface *iface);
  67 static GSocketAddressEnumerator *g_socket_address_connectable_enumerate  (GSocketConnectable      *connectable);
  68
  69 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GSocketAddress, g_socket_address, G_TYPE_OBJECT,
  70                                   G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
  71                                                          g_socket_address_connectable_iface_init))
  72
  73 /**
  74  * g_socket_address_get_family:
  75  * @address: a #GSocketAddress
  76  *
  77  * Gets the socket family type of @address.
  78  *
  79  * Returns: the socket family type of @address.
  80  *
  81  * Since: 2.22
  82  */
  83 GSocketFamily
  84 g_socket_address_get_family (GSocketAddress *address)
  85 {
  86   g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), 0);
  87
  88   return G_SOCKET_ADDRESS_GET_CLASS (address)->get_family (address);
  89 }
  90
  91 static void
  92 g_socket_address_get_property (GObject *object, guint prop_id,
  93                                GValue *value, GParamSpec *pspec)
  94 {
  95   GSocketAddress *address = G_SOCKET_ADDRESS (object);
  96
  97   switch (prop_id)
  98     {
  99      case PROP_FAMILY:
 100       g_value_set_enum (value, g_socket_address_get_family (address));
 101       break;
 102
 103      default:
 104       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 105     }
 106 }
 107
 108 static void
 109 g_socket_address_class_init (GSocketAddressClass *klass)
 110 {
 111   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 112
 113   gobject_class->get_property = g_socket_address_get_property;
 114
 115   g_object_class_install_property (gobject_class, PROP_FAMILY,
 116                                    g_param_spec_enum ("family",
 117                                                       _("Address family"),
 118                                                       _("The family of the socket address"),
 119                                                       G_TYPE_SOCKET_FAMILY,
 120                                                       G_SOCKET_FAMILY_INVALID,
 121                                                       G_PARAM_READABLE | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NAME));
 122 }
 123
 124 static void
 125 g_socket_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
 126 {
 127   connectable_iface->enumerate  = g_socket_address_connectable_enumerate;
 128 }
 129
 130 static void
 131 g_socket_address_init (GSocketAddress *address)
 132 {
 133
 134 }
 135
 136 /**
 137  * g_socket_address_get_native_size:
 138  * @address: a #GSocketAddress
 139  *
 140  * Gets the size of @address's native <type>struct sockaddr</type>.
 141  * You can use this to allocate memory to pass to
 142  * g_socket_address_to_native().
 143  *
 144  * Returns: the size of the native <type>struct sockaddr</type> that
 145  * @address represents
 146  *
 147  * Since: 2.22
 148  */
 149 gssize
 150 g_socket_address_get_native_size (GSocketAddress *address)
 151 {
 152   g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), -1);
 153
 154   return G_SOCKET_ADDRESS_GET_CLASS (address)->get_native_size (address);
 155 }
 156
 157 /**
 158  * g_socket_address_to_native:
 159  * @address: a #GSocketAddress
 160  * @dest: a pointer to a memory location that will contain the native
 161  * <type>struct sockaddr</type>.
 162  * @destlen: the size of @dest. Must be at least as large as
 163  * g_socket_address_get_native_size().
 164  *
 165  * Converts a #GSocketAddress to a native <type>struct
 166  * sockaddr</type>, which can be passed to low-level functions like
 167  * connect() or bind().
 168  *
 169  * Returns: %TRUE if @dest was filled in, %FALSE if @address is invalid
 170  * or @destlen is too small.
 171  *
 172  * Since: 2.22
 173  */
 174 gboolean
 175 g_socket_address_to_native (GSocketAddress *address,
 176                             gpointer        dest,
 177                             gsize           destlen)
 178 {
 179   g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), FALSE);
 180
 181   return G_SOCKET_ADDRESS_GET_CLASS (address)->to_native (address, dest, destlen);
 182 }
 183
 184 /**
 185  * g_socket_address_new_from_native:
 186  * @native: a pointer to a <type>struct sockaddr</type>
 187  * @len: the size of the memory location pointed to by @native
 188  *
 189  * Creates a #GSocketAddress subclass corresponding to the native
 190  * <type>struct sockaddr</type> @native.
 191  *
 192  * Returns: a new #GSocketAddress if @native could successfully be converted,
 193  * otherwise %NULL.
 194  *
 195  * Since: 2.22
 196  */
 197 GSocketAddress *
 198 g_socket_address_new_from_native (gpointer native,
 199                                   gsize    len)
 200 {
 201   gshort family;
 202
 203   if (len < sizeof (gshort))
 204     return NULL;
 205
 206   family = ((struct sockaddr *) native)->sa_family;
 207
 208   if (family == AF_UNSPEC)
 209     return NULL;
 210
 211   if (family == AF_INET)
 212     {
 213       struct sockaddr_in *addr = (struct sockaddr_in *) native;
 214       GInetAddress *iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin_addr), AF_INET);
 215       GSocketAddress *sockaddr;
 216
 217       sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin_port));
 218       g_object_unref (iaddr);
 219       return sockaddr;
 220     }
 221
 222   if (family == AF_INET6)
 223     {
 224       struct sockaddr_in6 *addr = (struct sockaddr_in6 *) native;
 225       GInetAddress *iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin6_addr), AF_INET6);
 226       GSocketAddress *sockaddr;
 227
 228       sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin6_port));
 229       g_object_unref (iaddr);
 230       return sockaddr;
 231     }
 232
 233 #ifdef G_OS_UNIX
 234   if (family == AF_UNIX)
 235     {
 236       struct sockaddr_un *addr = (struct sockaddr_un *) native;
 237
 238       return g_unix_socket_address_new (addr->sun_path);
 239     }
 240 #endif
 241
 242   return NULL;
 243 }
 244
 245
 246 #define G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (_g_socket_address_address_enumerator_get_type ())
 247 #define G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, GSocketAddressAddressEnumerator))
 248
 249 typedef struct {
 250   GSocketAddressEnumerator parent_instance;
 251
 252   GSocketAddress *sockaddr;
 253 } GSocketAddressAddressEnumerator;
 254
 255 typedef struct {
 256   GSocketAddressEnumeratorClass parent_class;
 257
 258 } GSocketAddressAddressEnumeratorClass;
 259
 260 G_DEFINE_TYPE (GSocketAddressAddressEnumerator, _g_socket_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
 261
 262 static void
 263 g_socket_address_address_enumerator_finalize (GObject *object)
 264 {
 265   GSocketAddressAddressEnumerator *sockaddr_enum =
 266     G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (object);
 267
 268   if (sockaddr_enum->sockaddr)
 269     g_object_unref (sockaddr_enum->sockaddr);
 270
 271   G_OBJECT_CLASS (_g_socket_address_address_enumerator_parent_class)->finalize (object);
 272 }
 273
 274 static GSocketAddress *
 275 g_socket_address_address_enumerator_next (GSocketAddressEnumerator  *enumerator,
 276                                           GCancellable              *cancellable,
 277                                           GError                   **error)
 278 {
 279   GSocketAddressAddressEnumerator *sockaddr_enum =
 280     G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
 281
 282   if (sockaddr_enum->sockaddr)
 283     {
 284       GSocketAddress *ret = sockaddr_enum->sockaddr;
 285
 286       sockaddr_enum->sockaddr = NULL;
 287       return ret;
 288     }
 289   else
 290     return NULL;
 291 }
 292
 293 static void
 294 _g_socket_address_address_enumerator_init (GSocketAddressAddressEnumerator *enumerator)
 295 {
 296 }
 297
 298 static void
 299 _g_socket_address_address_enumerator_class_init (GSocketAddressAddressEnumeratorClass *sockaddrenum_class)
 300 {
 301   GObjectClass *object_class = G_OBJECT_CLASS (sockaddrenum_class);
 302   GSocketAddressEnumeratorClass *enumerator_class =
 303     G_SOCKET_ADDRESS_ENUMERATOR_CLASS (sockaddrenum_class);
 304
 305   enumerator_class->next = g_socket_address_address_enumerator_next;
 306   object_class->finalize = g_socket_address_address_enumerator_finalize;
 307 }
 308
 309 static GSocketAddressEnumerator *
 310 g_socket_address_connectable_enumerate (GSocketConnectable *connectable)
 311 {
 312   GSocketAddressAddressEnumerator *sockaddr_enum;
 313
 314   sockaddr_enum = g_object_new (G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, NULL);
 315   sockaddr_enum->sockaddr = g_object_ref (connectable);
 316
 317   return (GSocketAddressEnumerator *)sockaddr_enum;
 318 }
 319
 320 #define __G_SOCKET_ADDRESS_C__
 321 #include "gioaliasdef.c"