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 "gsocketaddressenumerator.h"
32 #include "gsocketconnectable.h"
34 #include "gioenumtypes.h"
37 #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
);
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
))
74 * g_socket_address_get_family:
75 * @address: a #GSocketAddress
77 * Gets the socket family type of @address.
79 * Returns: the socket family type of @address.
84 g_socket_address_get_family (GSocketAddress
*address
)
86 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address
), 0);
88 return G_SOCKET_ADDRESS_GET_CLASS (address
)->get_family (address
);
92 g_socket_address_get_property (GObject
*object
, guint prop_id
,
93 GValue
*value
, GParamSpec
*pspec
)
95 GSocketAddress
*address
= G_SOCKET_ADDRESS (object
);
100 g_value_set_enum (value
, g_socket_address_get_family (address
));
104 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
109 g_socket_address_class_init (GSocketAddressClass
*klass
)
111 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
113 gobject_class
->get_property
= g_socket_address_get_property
;
115 g_object_class_install_property (gobject_class
, PROP_FAMILY
,
116 g_param_spec_enum ("family",
117 P_("Address family"),
118 P_("The family of the socket address"),
119 G_TYPE_SOCKET_FAMILY
,
120 G_SOCKET_FAMILY_INVALID
,
122 G_PARAM_STATIC_STRINGS
));
126 g_socket_address_connectable_iface_init (GSocketConnectableIface
*connectable_iface
)
128 connectable_iface
->enumerate
= g_socket_address_connectable_enumerate
;
132 g_socket_address_init (GSocketAddress
*address
)
138 * g_socket_address_get_native_size:
139 * @address: a #GSocketAddress
141 * Gets the size of @address's native <type>struct sockaddr</type>.
142 * You can use this to allocate memory to pass to
143 * g_socket_address_to_native().
145 * Returns: the size of the native <type>struct sockaddr</type> that
146 * @address represents
151 g_socket_address_get_native_size (GSocketAddress
*address
)
153 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address
), -1);
155 return G_SOCKET_ADDRESS_GET_CLASS (address
)->get_native_size (address
);
159 * g_socket_address_to_native:
160 * @address: a #GSocketAddress
161 * @dest: a pointer to a memory location that will contain the native
162 * <type>struct sockaddr</type>.
163 * @destlen: the size of @dest. Must be at least as large as
164 * g_socket_address_get_native_size().
165 * @error: #GError for error reporting, or %NULL to ignore.
167 * Converts a #GSocketAddress to a native <type>struct
168 * sockaddr</type>, which can be passed to low-level functions like
169 * connect() or bind().
171 * If not enough space is availible, a %G_IO_ERROR_NO_SPACE error is
172 * returned. If the address type is not known on the system
173 * then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
175 * Returns: %TRUE if @dest was filled in, %FALSE on error
180 g_socket_address_to_native (GSocketAddress
*address
,
185 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address
), FALSE
);
187 return G_SOCKET_ADDRESS_GET_CLASS (address
)->to_native (address
, dest
, destlen
, error
);
191 * g_socket_address_new_from_native:
192 * @native: a pointer to a <type>struct sockaddr</type>
193 * @len: the size of the memory location pointed to by @native
195 * Creates a #GSocketAddress subclass corresponding to the native
196 * <type>struct sockaddr</type> @native.
198 * Returns: a new #GSocketAddress if @native could successfully be converted,
204 g_socket_address_new_from_native (gpointer native
,
209 if (len
< sizeof (gshort
))
212 family
= ((struct sockaddr
*) native
)->sa_family
;
214 if (family
== AF_UNSPEC
)
217 if (family
== AF_INET
)
219 struct sockaddr_in
*addr
= (struct sockaddr_in
*) native
;
221 GSocketAddress
*sockaddr
;
223 if (len
< sizeof (*addr
))
226 iaddr
= g_inet_address_new_from_bytes ((guint8
*) &(addr
->sin_addr
), AF_INET
);
227 sockaddr
= g_inet_socket_address_new (iaddr
, g_ntohs (addr
->sin_port
));
228 g_object_unref (iaddr
);
232 if (family
== AF_INET6
)
234 struct sockaddr_in6
*addr
= (struct sockaddr_in6
*) native
;
236 GSocketAddress
*sockaddr
;
238 if (len
< sizeof (*addr
))
241 iaddr
= g_inet_address_new_from_bytes ((guint8
*) &(addr
->sin6_addr
), AF_INET6
);
242 sockaddr
= g_inet_socket_address_new (iaddr
, g_ntohs (addr
->sin6_port
));
243 g_object_unref (iaddr
);
248 if (family
== AF_UNIX
)
250 struct sockaddr_un
*addr
= (struct sockaddr_un
*) native
;
251 gint path_len
= len
- G_STRUCT_OFFSET (struct sockaddr_un
, sun_path
);
255 return g_unix_socket_address_new_with_type ("", 0,
256 G_UNIX_SOCKET_ADDRESS_ANONYMOUS
);
258 else if (addr
->sun_path
[0] == 0)
260 if (len
< sizeof (*addr
))
262 return g_unix_socket_address_new_with_type (addr
->sun_path
+ 1,
264 G_UNIX_SOCKET_ADDRESS_ABSTRACT
);
268 return g_unix_socket_address_new_with_type (addr
->sun_path
+ 1,
270 G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
);
274 return g_unix_socket_address_new (addr
->sun_path
);
282 #define G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (_g_socket_address_address_enumerator_get_type ())
283 #define G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, GSocketAddressAddressEnumerator))
286 GSocketAddressEnumerator parent_instance
;
288 GSocketAddress
*sockaddr
;
289 } GSocketAddressAddressEnumerator
;
292 GSocketAddressEnumeratorClass parent_class
;
294 } GSocketAddressAddressEnumeratorClass
;
296 G_DEFINE_TYPE (GSocketAddressAddressEnumerator
, _g_socket_address_address_enumerator
, G_TYPE_SOCKET_ADDRESS_ENUMERATOR
)
299 g_socket_address_address_enumerator_finalize (GObject
*object
)
301 GSocketAddressAddressEnumerator
*sockaddr_enum
=
302 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (object
);
304 if (sockaddr_enum
->sockaddr
)
305 g_object_unref (sockaddr_enum
->sockaddr
);
307 G_OBJECT_CLASS (_g_socket_address_address_enumerator_parent_class
)->finalize (object
);
310 static GSocketAddress
*
311 g_socket_address_address_enumerator_next (GSocketAddressEnumerator
*enumerator
,
312 GCancellable
*cancellable
,
315 GSocketAddressAddressEnumerator
*sockaddr_enum
=
316 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (enumerator
);
318 if (sockaddr_enum
->sockaddr
)
320 GSocketAddress
*ret
= sockaddr_enum
->sockaddr
;
322 sockaddr_enum
->sockaddr
= NULL
;
330 _g_socket_address_address_enumerator_init (GSocketAddressAddressEnumerator
*enumerator
)
335 _g_socket_address_address_enumerator_class_init (GSocketAddressAddressEnumeratorClass
*sockaddrenum_class
)
337 GObjectClass
*object_class
= G_OBJECT_CLASS (sockaddrenum_class
);
338 GSocketAddressEnumeratorClass
*enumerator_class
=
339 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (sockaddrenum_class
);
341 enumerator_class
->next
= g_socket_address_address_enumerator_next
;
342 object_class
->finalize
= g_socket_address_address_enumerator_finalize
;
345 static GSocketAddressEnumerator
*
346 g_socket_address_connectable_enumerate (GSocketConnectable
*connectable
)
348 GSocketAddressAddressEnumerator
*sockaddr_enum
;
350 sockaddr_enum
= g_object_new (G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR
, NULL
);
351 sockaddr_enum
->sockaddr
= g_object_ref (connectable
);
353 return (GSocketAddressEnumerator
*)sockaddr_enum
;
356 #define __G_SOCKET_ADDRESS_C__
357 #include "gioaliasdef.c"