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>
27 #include "gsocketaddress.h"
28 #include "ginetaddress.h"
29 #include "ginetsocketaddress.h"
30 #include "gnetworkingprivate.h"
31 #include "gproxyaddressenumerator.h"
32 #include "gsocketaddressenumerator.h"
33 #include "gsocketconnectable.h"
35 #include "gioenumtypes.h"
38 #include "gunixsocketaddress.h"
43 * SECTION:gsocketaddress
44 * @short_description: Abstract base class representing endpoints for
45 * socket communication
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.
56 * A socket endpoint address, corresponding to <type>struct sockaddr</type>
57 * or one of its subtypes.
66 static void g_socket_address_connectable_iface_init (GSocketConnectableIface *iface);
67 static GSocketAddressEnumerator *g_socket_address_connectable_enumerate (GSocketConnectable *connectable);
68 static GSocketAddressEnumerator *g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable);
70 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GSocketAddress, g_socket_address, G_TYPE_OBJECT,
71 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
72 g_socket_address_connectable_iface_init))
75 * g_socket_address_get_family:
76 * @address: a #GSocketAddress
78 * Gets the socket family type of @address.
80 * Returns: the socket family type of @address.
85 g_socket_address_get_family (GSocketAddress *address)
87 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), 0);
89 return G_SOCKET_ADDRESS_GET_CLASS (address)->get_family (address);
93 g_socket_address_get_property (GObject *object, guint prop_id,
94 GValue *value, GParamSpec *pspec)
96 GSocketAddress *address = G_SOCKET_ADDRESS (object);
101 g_value_set_enum (value, g_socket_address_get_family (address));
105 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
110 g_socket_address_class_init (GSocketAddressClass *klass)
112 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
114 gobject_class->get_property = g_socket_address_get_property;
116 g_object_class_install_property (gobject_class, PROP_FAMILY,
117 g_param_spec_enum ("family",
118 P_("Address family"),
119 P_("The family of the socket address"),
120 G_TYPE_SOCKET_FAMILY,
121 G_SOCKET_FAMILY_INVALID,
123 G_PARAM_STATIC_STRINGS));
127 g_socket_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
129 connectable_iface->enumerate = g_socket_address_connectable_enumerate;
130 connectable_iface->proxy_enumerate = g_socket_address_connectable_proxy_enumerate;
134 g_socket_address_init (GSocketAddress *address)
140 * g_socket_address_get_native_size:
141 * @address: a #GSocketAddress
143 * Gets the size of @address's native <type>struct sockaddr</type>.
144 * You can use this to allocate memory to pass to
145 * g_socket_address_to_native().
147 * Returns: the size of the native <type>struct sockaddr</type> that
148 * @address represents
153 g_socket_address_get_native_size (GSocketAddress *address)
155 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), -1);
157 return G_SOCKET_ADDRESS_GET_CLASS (address)->get_native_size (address);
161 * g_socket_address_to_native:
162 * @address: a #GSocketAddress
163 * @dest: a pointer to a memory location that will contain the native
164 * <type>struct sockaddr</type>.
165 * @destlen: the size of @dest. Must be at least as large as
166 * g_socket_address_get_native_size().
167 * @error: #GError for error reporting, or %NULL to ignore.
169 * Converts a #GSocketAddress to a native <type>struct
170 * sockaddr</type>, which can be passed to low-level functions like
171 * connect() or bind().
173 * If not enough space is availible, a %G_IO_ERROR_NO_SPACE error is
174 * returned. If the address type is not known on the system
175 * then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
177 * Returns: %TRUE if @dest was filled in, %FALSE on error
182 g_socket_address_to_native (GSocketAddress *address,
187 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), FALSE);
189 return G_SOCKET_ADDRESS_GET_CLASS (address)->to_native (address, dest, destlen, error);
193 * g_socket_address_new_from_native:
194 * @native: a pointer to a <type>struct sockaddr</type>
195 * @len: the size of the memory location pointed to by @native
197 * Creates a #GSocketAddress subclass corresponding to the native
198 * <type>struct sockaddr</type> @native.
200 * Returns: a new #GSocketAddress if @native could successfully be converted,
206 g_socket_address_new_from_native (gpointer native,
211 if (len < sizeof (gshort))
214 family = ((struct sockaddr *) native)->sa_family;
216 if (family == AF_UNSPEC)
219 if (family == AF_INET)
221 struct sockaddr_in *addr = (struct sockaddr_in *) native;
223 GSocketAddress *sockaddr;
225 if (len < sizeof (*addr))
228 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin_addr), AF_INET);
229 sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin_port));
230 g_object_unref (iaddr);
234 if (family == AF_INET6)
236 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) native;
238 GSocketAddress *sockaddr;
240 if (len < sizeof (*addr))
243 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin6_addr), AF_INET6);
244 sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin6_port));
245 g_object_unref (iaddr);
250 if (family == AF_UNIX)
252 struct sockaddr_un *addr = (struct sockaddr_un *) native;
253 gint path_len = len - G_STRUCT_OFFSET (struct sockaddr_un, sun_path);
257 return g_unix_socket_address_new_with_type ("", 0,
258 G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
260 else if (addr->sun_path[0] == 0)
262 if (len < sizeof (*addr))
264 return g_unix_socket_address_new_with_type (addr->sun_path + 1,
266 G_UNIX_SOCKET_ADDRESS_ABSTRACT);
270 return g_unix_socket_address_new_with_type (addr->sun_path + 1,
272 G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED);
276 return g_unix_socket_address_new (addr->sun_path);
284 #define G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (_g_socket_address_address_enumerator_get_type ())
285 #define G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, GSocketAddressAddressEnumerator))
288 GSocketAddressEnumerator parent_instance;
290 GSocketAddress *sockaddr;
291 } GSocketAddressAddressEnumerator;
294 GSocketAddressEnumeratorClass parent_class;
296 } GSocketAddressAddressEnumeratorClass;
298 G_DEFINE_TYPE (GSocketAddressAddressEnumerator, _g_socket_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
301 g_socket_address_address_enumerator_finalize (GObject *object)
303 GSocketAddressAddressEnumerator *sockaddr_enum =
304 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (object);
306 if (sockaddr_enum->sockaddr)
307 g_object_unref (sockaddr_enum->sockaddr);
309 G_OBJECT_CLASS (_g_socket_address_address_enumerator_parent_class)->finalize (object);
312 static GSocketAddress *
313 g_socket_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
314 GCancellable *cancellable,
317 GSocketAddressAddressEnumerator *sockaddr_enum =
318 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
320 if (sockaddr_enum->sockaddr)
322 GSocketAddress *ret = sockaddr_enum->sockaddr;
324 sockaddr_enum->sockaddr = NULL;
332 _g_socket_address_address_enumerator_init (GSocketAddressAddressEnumerator *enumerator)
337 _g_socket_address_address_enumerator_class_init (GSocketAddressAddressEnumeratorClass *sockaddrenum_class)
339 GObjectClass *object_class = G_OBJECT_CLASS (sockaddrenum_class);
340 GSocketAddressEnumeratorClass *enumerator_class =
341 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (sockaddrenum_class);
343 enumerator_class->next = g_socket_address_address_enumerator_next;
344 object_class->finalize = g_socket_address_address_enumerator_finalize;
347 static GSocketAddressEnumerator *
348 g_socket_address_connectable_enumerate (GSocketConnectable *connectable)
350 GSocketAddressAddressEnumerator *sockaddr_enum;
352 sockaddr_enum = g_object_new (G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, NULL);
353 sockaddr_enum->sockaddr = g_object_ref (connectable);
355 return (GSocketAddressEnumerator *)sockaddr_enum;
358 static GSocketAddressEnumerator *
359 g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
361 GSocketAddressEnumerator *addr_enum = NULL;
363 if (G_IS_INET_SOCKET_ADDRESS (connectable) &&
364 !G_IS_PROXY_ADDRESS (connectable))
371 g_object_get (connectable, "address", &addr, "port", &port, NULL);
373 ip = g_inet_address_to_string (addr);
374 uri = g_strdup_printf ("none://%s:%u", ip, port);
376 addr_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
377 "connectable", connectable,
381 g_object_unref (addr);
387 addr_enum = g_socket_address_connectable_enumerate (connectable);