1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
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.
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.
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.
20 * Authors: Christian Kellner <gicmo@gnome.org>
21 * Samuel Cormier-Iijima <sciyoshi@gmail.com>
28 #include "gsocketaddress.h"
29 #include "ginetaddress.h"
30 #include "ginetsocketaddress.h"
31 #include "gnetworkingprivate.h"
32 #include "gproxyaddress.h"
33 #include "gproxyaddressenumerator.h"
34 #include "gsocketaddressenumerator.h"
35 #include "gsocketconnectable.h"
37 #include "gioenumtypes.h"
40 #include "gunixsocketaddress.h"
45 * SECTION:gsocketaddress
46 * @short_description: Abstract base class representing endpoints
47 * for socket communication
50 * #GSocketAddress is the equivalent of struct sockaddr in the BSD
51 * sockets API. This is an abstract class; use #GInetSocketAddress
52 * for internet sockets, or #GUnixSocketAddress for UNIX domain sockets.
58 * A socket endpoint address, corresponding to struct sockaddr
59 * or one of its subtypes.
68 static void g_socket_address_connectable_iface_init (GSocketConnectableIface *iface);
69 static GSocketAddressEnumerator *g_socket_address_connectable_enumerate (GSocketConnectable *connectable);
70 static GSocketAddressEnumerator *g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable);
72 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GSocketAddress, g_socket_address, G_TYPE_OBJECT,
73 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
74 g_socket_address_connectable_iface_init))
77 * g_socket_address_get_family:
78 * @address: a #GSocketAddress
80 * Gets the socket family type of @address.
82 * Returns: the socket family type of @address
87 g_socket_address_get_family (GSocketAddress *address)
89 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), 0);
91 return G_SOCKET_ADDRESS_GET_CLASS (address)->get_family (address);
95 g_socket_address_get_property (GObject *object, guint prop_id,
96 GValue *value, GParamSpec *pspec)
98 GSocketAddress *address = G_SOCKET_ADDRESS (object);
103 g_value_set_enum (value, g_socket_address_get_family (address));
107 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
112 g_socket_address_class_init (GSocketAddressClass *klass)
114 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
116 gobject_class->get_property = g_socket_address_get_property;
118 g_object_class_install_property (gobject_class, PROP_FAMILY,
119 g_param_spec_enum ("family",
120 P_("Address family"),
121 P_("The family of the socket address"),
122 G_TYPE_SOCKET_FAMILY,
123 G_SOCKET_FAMILY_INVALID,
125 G_PARAM_STATIC_STRINGS));
129 g_socket_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
131 connectable_iface->enumerate = g_socket_address_connectable_enumerate;
132 connectable_iface->proxy_enumerate = g_socket_address_connectable_proxy_enumerate;
136 g_socket_address_init (GSocketAddress *address)
142 * g_socket_address_get_native_size:
143 * @address: a #GSocketAddress
145 * Gets the size of @address's native struct sockaddr.
146 * You can use this to allocate memory to pass to
147 * g_socket_address_to_native().
149 * Returns: the size of the native struct sockaddr that
150 * @address represents
155 g_socket_address_get_native_size (GSocketAddress *address)
157 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), -1);
159 return G_SOCKET_ADDRESS_GET_CLASS (address)->get_native_size (address);
163 * g_socket_address_to_native:
164 * @address: a #GSocketAddress
165 * @dest: a pointer to a memory location that will contain the native
167 * @destlen: the size of @dest. Must be at least as large as
168 * g_socket_address_get_native_size()
169 * @error: #GError for error reporting, or %NULL to ignore
171 * Converts a #GSocketAddress to a native struct sockaddr, which can
172 * be passed to low-level functions like connect() or bind().
174 * If not enough space is available, a %G_IO_ERROR_NO_SPACE error
175 * is returned. If the address type is not known on the system
176 * then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
178 * Returns: %TRUE if @dest was filled in, %FALSE on error
183 g_socket_address_to_native (GSocketAddress *address,
188 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), FALSE);
190 return G_SOCKET_ADDRESS_GET_CLASS (address)->to_native (address, dest, destlen, error);
194 * g_socket_address_new_from_native:
195 * @native: a pointer to a struct sockaddr
196 * @len: the size of the memory location pointed to by @native
198 * Creates a #GSocketAddress subclass corresponding to the native
199 * struct sockaddr @native.
201 * Returns: a new #GSocketAddress if @native could successfully
202 * be converted, otherwise %NULL
207 g_socket_address_new_from_native (gpointer native,
212 if (len < sizeof (gshort))
215 family = ((struct sockaddr *) native)->sa_family;
217 if (family == AF_UNSPEC)
220 if (family == AF_INET)
222 struct sockaddr_in *addr = (struct sockaddr_in *) native;
224 GSocketAddress *sockaddr;
226 if (len < sizeof (*addr))
229 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin_addr), AF_INET);
230 sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin_port));
231 g_object_unref (iaddr);
235 if (family == AF_INET6)
237 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) native;
239 GSocketAddress *sockaddr;
241 if (len < sizeof (*addr))
244 if (IN6_IS_ADDR_V4MAPPED (&(addr->sin6_addr)))
246 struct sockaddr_in sin_addr;
248 sin_addr.sin_family = AF_INET;
249 sin_addr.sin_port = addr->sin6_port;
250 memcpy (&(sin_addr.sin_addr.s_addr), addr->sin6_addr.s6_addr + 12, 4);
251 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(sin_addr.sin_addr), AF_INET);
255 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin6_addr), AF_INET6);
258 sockaddr = g_object_new (G_TYPE_INET_SOCKET_ADDRESS,
260 "port", g_ntohs (addr->sin6_port),
261 "flowinfo", addr->sin6_flowinfo,
262 "scope_id", addr->sin6_scope_id,
264 g_object_unref (iaddr);
269 if (family == AF_UNIX)
271 struct sockaddr_un *addr = (struct sockaddr_un *) native;
272 gint path_len = len - G_STRUCT_OFFSET (struct sockaddr_un, sun_path);
276 return g_unix_socket_address_new_with_type ("", 0,
277 G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
279 else if (addr->sun_path[0] == 0)
281 if (!g_unix_socket_address_abstract_names_supported ())
283 return g_unix_socket_address_new_with_type ("", 0,
284 G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
286 else if (len < sizeof (*addr))
288 return g_unix_socket_address_new_with_type (addr->sun_path + 1,
290 G_UNIX_SOCKET_ADDRESS_ABSTRACT);
294 return g_unix_socket_address_new_with_type (addr->sun_path + 1,
296 G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED);
300 return g_unix_socket_address_new (addr->sun_path);
308 #define G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (_g_socket_address_address_enumerator_get_type ())
309 #define G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, GSocketAddressAddressEnumerator))
312 GSocketAddressEnumerator parent_instance;
314 GSocketAddress *sockaddr;
315 } GSocketAddressAddressEnumerator;
318 GSocketAddressEnumeratorClass parent_class;
320 } GSocketAddressAddressEnumeratorClass;
322 static GType _g_socket_address_address_enumerator_get_type (void);
323 G_DEFINE_TYPE (GSocketAddressAddressEnumerator, _g_socket_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
326 g_socket_address_address_enumerator_finalize (GObject *object)
328 GSocketAddressAddressEnumerator *sockaddr_enum =
329 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (object);
331 if (sockaddr_enum->sockaddr)
332 g_object_unref (sockaddr_enum->sockaddr);
334 G_OBJECT_CLASS (_g_socket_address_address_enumerator_parent_class)->finalize (object);
337 static GSocketAddress *
338 g_socket_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
339 GCancellable *cancellable,
342 GSocketAddressAddressEnumerator *sockaddr_enum =
343 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
345 if (sockaddr_enum->sockaddr)
347 GSocketAddress *ret = sockaddr_enum->sockaddr;
349 sockaddr_enum->sockaddr = NULL;
357 _g_socket_address_address_enumerator_init (GSocketAddressAddressEnumerator *enumerator)
362 _g_socket_address_address_enumerator_class_init (GSocketAddressAddressEnumeratorClass *sockaddrenum_class)
364 GObjectClass *object_class = G_OBJECT_CLASS (sockaddrenum_class);
365 GSocketAddressEnumeratorClass *enumerator_class =
366 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (sockaddrenum_class);
368 enumerator_class->next = g_socket_address_address_enumerator_next;
369 object_class->finalize = g_socket_address_address_enumerator_finalize;
372 static GSocketAddressEnumerator *
373 g_socket_address_connectable_enumerate (GSocketConnectable *connectable)
375 GSocketAddressAddressEnumerator *sockaddr_enum;
377 sockaddr_enum = g_object_new (G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, NULL);
378 sockaddr_enum->sockaddr = g_object_ref (connectable);
380 return (GSocketAddressEnumerator *)sockaddr_enum;
383 static GSocketAddressEnumerator *
384 g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
386 GSocketAddressEnumerator *addr_enum = NULL;
388 g_assert (connectable != NULL);
390 if (G_IS_INET_SOCKET_ADDRESS (connectable) &&
391 !G_IS_PROXY_ADDRESS (connectable))
398 g_object_get (connectable, "address", &addr, "port", &port, NULL);
400 ip = g_inet_address_to_string (addr);
401 uri = _g_uri_from_authority ("none", ip, port, NULL);
403 addr_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
404 "connectable", connectable,
408 g_object_unref (addr);
414 addr_enum = g_socket_address_connectable_enumerate (connectable);