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 <type>struct sockaddr</type>
51 * in the BSD sockets API. This is an abstract class; use
52 * #GInetSocketAddress for internet sockets, or #GUnixSocketAddress
53 * for UNIX domain sockets.
59 * A socket endpoint address, corresponding to <type>struct sockaddr</type>
60 * or one of its subtypes.
69 static void g_socket_address_connectable_iface_init (GSocketConnectableIface *iface);
70 static GSocketAddressEnumerator *g_socket_address_connectable_enumerate (GSocketConnectable *connectable);
71 static GSocketAddressEnumerator *g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable);
73 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GSocketAddress, g_socket_address, G_TYPE_OBJECT,
74 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
75 g_socket_address_connectable_iface_init))
78 * g_socket_address_get_family:
79 * @address: a #GSocketAddress
81 * Gets the socket family type of @address.
83 * Returns: the socket family type of @address.
88 g_socket_address_get_family (GSocketAddress *address)
90 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), 0);
92 return G_SOCKET_ADDRESS_GET_CLASS (address)->get_family (address);
96 g_socket_address_get_property (GObject *object, guint prop_id,
97 GValue *value, GParamSpec *pspec)
99 GSocketAddress *address = G_SOCKET_ADDRESS (object);
104 g_value_set_enum (value, g_socket_address_get_family (address));
108 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
113 g_socket_address_class_init (GSocketAddressClass *klass)
115 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
117 gobject_class->get_property = g_socket_address_get_property;
119 g_object_class_install_property (gobject_class, PROP_FAMILY,
120 g_param_spec_enum ("family",
121 P_("Address family"),
122 P_("The family of the socket address"),
123 G_TYPE_SOCKET_FAMILY,
124 G_SOCKET_FAMILY_INVALID,
126 G_PARAM_STATIC_STRINGS));
130 g_socket_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
132 connectable_iface->enumerate = g_socket_address_connectable_enumerate;
133 connectable_iface->proxy_enumerate = g_socket_address_connectable_proxy_enumerate;
137 g_socket_address_init (GSocketAddress *address)
143 * g_socket_address_get_native_size:
144 * @address: a #GSocketAddress
146 * Gets the size of @address's native <type>struct sockaddr</type>.
147 * You can use this to allocate memory to pass to
148 * g_socket_address_to_native().
150 * Returns: the size of the native <type>struct sockaddr</type> that
151 * @address represents
156 g_socket_address_get_native_size (GSocketAddress *address)
158 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), -1);
160 return G_SOCKET_ADDRESS_GET_CLASS (address)->get_native_size (address);
164 * g_socket_address_to_native:
165 * @address: a #GSocketAddress
166 * @dest: a pointer to a memory location that will contain the native
167 * <type>struct sockaddr</type>.
168 * @destlen: the size of @dest. Must be at least as large as
169 * g_socket_address_get_native_size().
170 * @error: #GError for error reporting, or %NULL to ignore.
172 * Converts a #GSocketAddress to a native <type>struct
173 * sockaddr</type>, which can be passed to low-level functions like
174 * connect() or bind().
176 * If not enough space is available, a %G_IO_ERROR_NO_SPACE error is
177 * returned. If the address type is not known on the system
178 * then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
180 * Returns: %TRUE if @dest was filled in, %FALSE on error
185 g_socket_address_to_native (GSocketAddress *address,
190 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), FALSE);
192 return G_SOCKET_ADDRESS_GET_CLASS (address)->to_native (address, dest, destlen, error);
196 * g_socket_address_new_from_native:
197 * @native: a pointer to a <type>struct sockaddr</type>
198 * @len: the size of the memory location pointed to by @native
200 * Creates a #GSocketAddress subclass corresponding to the native
201 * <type>struct sockaddr</type> @native.
203 * Returns: a new #GSocketAddress if @native could successfully be converted,
209 g_socket_address_new_from_native (gpointer native,
214 if (len < sizeof (gshort))
217 family = ((struct sockaddr *) native)->sa_family;
219 if (family == AF_UNSPEC)
222 if (family == AF_INET)
224 struct sockaddr_in *addr = (struct sockaddr_in *) native;
226 GSocketAddress *sockaddr;
228 if (len < sizeof (*addr))
231 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin_addr), AF_INET);
232 sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin_port));
233 g_object_unref (iaddr);
237 if (family == AF_INET6)
239 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) native;
241 GSocketAddress *sockaddr;
243 if (len < sizeof (*addr))
246 if (IN6_IS_ADDR_V4MAPPED (&(addr->sin6_addr)))
248 struct sockaddr_in sin_addr;
250 sin_addr.sin_family = AF_INET;
251 sin_addr.sin_port = addr->sin6_port;
252 memcpy (&(sin_addr.sin_addr.s_addr), addr->sin6_addr.s6_addr + 12, 4);
253 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(sin_addr.sin_addr), AF_INET);
257 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin6_addr), AF_INET6);
260 sockaddr = g_object_new (G_TYPE_INET_SOCKET_ADDRESS,
262 "port", g_ntohs (addr->sin6_port),
263 "flowinfo", addr->sin6_flowinfo,
264 "scope_id", addr->sin6_scope_id,
266 g_object_unref (iaddr);
271 if (family == AF_UNIX)
273 struct sockaddr_un *addr = (struct sockaddr_un *) native;
274 gint path_len = len - G_STRUCT_OFFSET (struct sockaddr_un, sun_path);
278 return g_unix_socket_address_new_with_type ("", 0,
279 G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
281 else if (addr->sun_path[0] == 0)
283 if (!g_unix_socket_address_abstract_names_supported ())
285 return g_unix_socket_address_new_with_type ("", 0,
286 G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
288 else if (len < sizeof (*addr))
290 return g_unix_socket_address_new_with_type (addr->sun_path + 1,
292 G_UNIX_SOCKET_ADDRESS_ABSTRACT);
296 return g_unix_socket_address_new_with_type (addr->sun_path + 1,
298 G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED);
302 return g_unix_socket_address_new (addr->sun_path);
310 #define G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (_g_socket_address_address_enumerator_get_type ())
311 #define G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, GSocketAddressAddressEnumerator))
314 GSocketAddressEnumerator parent_instance;
316 GSocketAddress *sockaddr;
317 } GSocketAddressAddressEnumerator;
320 GSocketAddressEnumeratorClass parent_class;
322 } GSocketAddressAddressEnumeratorClass;
324 static GType _g_socket_address_address_enumerator_get_type (void);
325 G_DEFINE_TYPE (GSocketAddressAddressEnumerator, _g_socket_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
328 g_socket_address_address_enumerator_finalize (GObject *object)
330 GSocketAddressAddressEnumerator *sockaddr_enum =
331 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (object);
333 if (sockaddr_enum->sockaddr)
334 g_object_unref (sockaddr_enum->sockaddr);
336 G_OBJECT_CLASS (_g_socket_address_address_enumerator_parent_class)->finalize (object);
339 static GSocketAddress *
340 g_socket_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
341 GCancellable *cancellable,
344 GSocketAddressAddressEnumerator *sockaddr_enum =
345 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
347 if (sockaddr_enum->sockaddr)
349 GSocketAddress *ret = sockaddr_enum->sockaddr;
351 sockaddr_enum->sockaddr = NULL;
359 _g_socket_address_address_enumerator_init (GSocketAddressAddressEnumerator *enumerator)
364 _g_socket_address_address_enumerator_class_init (GSocketAddressAddressEnumeratorClass *sockaddrenum_class)
366 GObjectClass *object_class = G_OBJECT_CLASS (sockaddrenum_class);
367 GSocketAddressEnumeratorClass *enumerator_class =
368 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (sockaddrenum_class);
370 enumerator_class->next = g_socket_address_address_enumerator_next;
371 object_class->finalize = g_socket_address_address_enumerator_finalize;
374 static GSocketAddressEnumerator *
375 g_socket_address_connectable_enumerate (GSocketConnectable *connectable)
377 GSocketAddressAddressEnumerator *sockaddr_enum;
379 sockaddr_enum = g_object_new (G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, NULL);
380 sockaddr_enum->sockaddr = g_object_ref (connectable);
382 return (GSocketAddressEnumerator *)sockaddr_enum;
385 static GSocketAddressEnumerator *
386 g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
388 GSocketAddressEnumerator *addr_enum = NULL;
390 g_assert (connectable != NULL);
392 if (G_IS_INET_SOCKET_ADDRESS (connectable) &&
393 !G_IS_PROXY_ADDRESS (connectable))
400 g_object_get (connectable, "address", &addr, "port", &port, NULL);
402 ip = g_inet_address_to_string (addr);
403 uri = _g_uri_from_authority ("none", ip, port, NULL);
405 addr_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
406 "connectable", connectable,
410 g_object_unref (addr);
416 addr_enum = g_socket_address_connectable_enumerate (connectable);