1 /* GNIO - GLib Network Layer of GIO
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 "gasynchelper.h"
28 #include "gnioenumtypes.h"
32 # include <netinet/in.h>
33 # include <arpa/inet.h>
37 # include <sys/types.h>
43 #include "ginetaddress.h"
44 #include "ginet4address.h"
45 #include "ginet6address.h"
47 #include "gnioerror.h"
48 #include "ginetsocketaddress.h"
50 G_DEFINE_TYPE (GSocket, g_socket, G_TYPE_OBJECT);
66 struct _GSocketPrivate
74 gboolean reuse_address;
76 GSocketAddress *local_address;
77 GSocketAddress *remote_address;
81 g_socket_constructed (GObject *object)
83 GSocket *sock = G_SOCKET (object);
85 static GStaticMutex getprotobyname_mutex = G_STATIC_MUTEX_INIT;
86 gint fd, native_domain, native_type, native_protocol;
88 if (sock->priv->fd >= 0)
90 // we've been constructed from an existing file descriptor
94 // TODO: set the socket type with getsockopt (SO_TYPE)
95 // TODO: what should we do about domain and protocol?
97 if ((arg = fcntl (sock->priv->fd, F_GETFL, NULL)) < 0)
98 g_warning ("Error getting socket status flags: %s", g_strerror (errno));
100 blocking = ((arg & O_NONBLOCK) == 0);
105 switch (sock->priv->domain)
107 case G_SOCKET_DOMAIN_INET:
108 native_domain = PF_INET;
111 case G_SOCKET_DOMAIN_INET6:
112 native_domain = PF_INET6;
115 case G_SOCKET_DOMAIN_UNIX:
116 native_domain = PF_UNIX;
120 g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket domain");
124 switch (sock->priv->type)
126 case G_SOCKET_TYPE_STREAM:
127 native_type = SOCK_STREAM;
130 case G_SOCKET_TYPE_DATAGRAM:
131 native_type = SOCK_DGRAM;
134 case G_SOCKET_TYPE_SEQPACKET:
135 native_type = SOCK_SEQPACKET;
139 g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket type");
143 if (sock->priv->protocol == NULL)
147 struct protoent *ent;
148 g_static_mutex_lock (&getprotobyname_mutex);
149 if (!(ent = getprotobyname (sock->priv->protocol)))
151 g_static_mutex_unlock (&getprotobyname_mutex);
152 g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket protocol");
155 native_protocol = ent->p_proto;
156 g_static_mutex_unlock (&getprotobyname_mutex);
159 fd = socket (native_domain, native_type, native_protocol);
163 g_set_error (&error, G_IO_ERROR, g_io_error_from_errno (errno), "unable to create socket: %s", g_strerror (errno));
171 g_socket_get_property (GObject *object,
176 GSocket *socket = G_SOCKET (object);
181 g_value_set_enum (value, socket->priv->domain);
185 g_value_set_enum (value, socket->priv->type);
189 g_value_set_string (value, socket->priv->protocol);
193 g_value_set_int (value, socket->priv->fd);
197 g_value_set_boolean (value, socket->priv->blocking);
201 g_value_set_int (value, socket->priv->backlog);
204 case PROP_REUSE_ADDRESS:
205 g_value_set_boolean (value, socket->priv->reuse_address);
208 case PROP_LOCAL_ADDRESS:
209 g_value_set_object (value, socket->priv->local_address);
212 case PROP_REMOTE_ADDRESS:
213 g_value_set_object (value, socket->priv->remote_address);
217 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
222 g_socket_set_property (GObject *object,
227 GSocket *socket = G_SOCKET (object);
232 socket->priv->domain = g_value_get_enum (value);
236 socket->priv->type = g_value_get_enum (value);
240 socket->priv->protocol = g_value_dup_string (value);
244 socket->priv->fd = g_value_get_int (value);
248 g_socket_set_blocking (socket, g_value_get_boolean (value));
252 socket->priv->backlog = g_value_get_int (value);
255 case PROP_REUSE_ADDRESS:
256 g_socket_set_reuse_address (socket, g_value_get_boolean (value));
260 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
265 g_socket_finalize (GObject *object)
267 GSocket *socket = G_SOCKET (object);
269 if (socket->priv->local_address)
270 g_object_unref (socket->priv->local_address);
272 if (socket->priv->remote_address)
273 g_object_unref (socket->priv->remote_address);
275 if (G_OBJECT_CLASS (g_socket_parent_class)->finalize)
276 (*G_OBJECT_CLASS (g_socket_parent_class)->finalize) (object);
280 g_socket_dispose (GObject *object)
282 GSocket *socket = G_SOCKET (object);
284 g_free (socket->priv->protocol);
286 g_clear_error (&socket->priv->error);
288 g_socket_close (socket);
290 if (G_OBJECT_CLASS (g_socket_parent_class)->dispose)
291 (*G_OBJECT_CLASS (g_socket_parent_class)->dispose) (object);
295 g_socket_class_init (GSocketClass *klass)
297 GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
301 g_type_class_add_private (klass, sizeof (GSocketPrivate));
303 gobject_class->finalize = g_socket_finalize;
304 gobject_class->dispose = g_socket_dispose;
305 gobject_class->constructed = g_socket_constructed;
306 gobject_class->set_property = g_socket_set_property;
307 gobject_class->get_property = g_socket_get_property;
309 g_object_class_install_property (gobject_class, PROP_DOMAIN,
310 g_param_spec_enum ("domain",
312 "the socket's domain",
313 G_TYPE_SOCKET_DOMAIN,
314 G_SOCKET_DOMAIN_INET,
315 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
317 g_object_class_install_property (gobject_class, PROP_TYPE,
318 g_param_spec_enum ("type",
322 G_SOCKET_TYPE_STREAM,
323 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
325 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
326 g_param_spec_string ("protocol",
328 "the socket's protocol",
330 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
332 g_object_class_install_property (gobject_class, PROP_FD,
333 g_param_spec_int ("fd",
335 "the socket's file descriptor",
339 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
341 g_object_class_install_property (gobject_class, PROP_BLOCKING,
342 g_param_spec_boolean ("blocking",
344 "whether or not this socket is blocking",
346 G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
348 g_object_class_install_property (gobject_class, PROP_BACKLOG,
349 g_param_spec_int ("backlog",
351 "outstanding connections in the listen queue",
355 G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
357 g_object_class_install_property (gobject_class, PROP_REUSE_ADDRESS,
358 g_param_spec_boolean ("reuse-address",
360 "allow reuse of local addresses when binding",
362 G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
364 g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
365 g_param_spec_object ("local-address",
367 "the local address the socket is bound to",
368 G_TYPE_SOCKET_ADDRESS,
369 G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
371 g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
372 g_param_spec_object ("remote-address",
374 "the remote address the socket is connected to",
375 G_TYPE_SOCKET_ADDRESS,
376 G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
380 g_socket_init (GSocket *socket)
382 socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket, G_TYPE_SOCKET, GSocketPrivate);
384 socket->priv->fd = -1;
385 socket->priv->blocking = TRUE;
386 socket->priv->backlog = 10;
387 socket->priv->reuse_address = FALSE;
388 socket->priv->error = NULL;
389 socket->priv->remote_address = NULL;
390 socket->priv->local_address = NULL;
394 g_socket_new (GSocketDomain domain, GSocketType type, const gchar *protocol)
396 return G_SOCKET (g_object_new (G_TYPE_SOCKET, "domain", domain, "type", type, "protocol", protocol, NULL));
400 g_socket_new_from_fd (gint fd)
402 return G_SOCKET (g_object_new (G_TYPE_SOCKET, "fd", fd, NULL));
406 g_socket_set_blocking (GSocket *socket,
411 g_return_if_fail (G_IS_SOCKET (socket));
413 if ((arg = fcntl (socket->priv->fd, F_GETFL, NULL)) < 0)
414 g_warning ("Error getting socket status flags: %s", g_strerror (errno));
416 arg = blocking ? arg & ~O_NONBLOCK : arg | O_NONBLOCK;
418 if (fcntl (socket->priv->fd, F_SETFL, arg) < 0)
419 g_warning ("Error setting socket status flags: %s", g_strerror (errno));
421 socket->priv->blocking = blocking;
423 g_object_notify (G_OBJECT (socket), "blocking");
427 g_socket_get_blocking (GSocket *socket)
429 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
431 return socket->priv->blocking;
435 g_socket_set_reuse_address (GSocket *socket,
438 gint value = (gint) reuse;
440 g_return_if_fail (G_IS_SOCKET (socket));
442 if (setsockopt (socket->priv->fd, SOL_SOCKET, SO_REUSEADDR, (gpointer) &value, sizeof (value)) < 0)
443 g_warning ("error setting reuse address: %s", g_strerror (errno));
445 socket->priv->reuse_address = reuse;
447 g_object_notify (G_OBJECT (socket), "reuse-address");
451 g_socket_get_reuse_address (GSocket *socket)
453 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
455 return socket->priv->reuse_address;
459 g_socket_has_socket_error (GSocket *socket,
463 guint32 sockerr_size = sizeof (sockerr);
465 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
467 if (getsockopt (socket->priv->fd, SOL_SOCKET, SO_ERROR, (gpointer) &sockerr, &sockerr_size) < 0)
469 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get socket error: %s", g_strerror (errno));
475 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (sockerr), "error connecting: %s", g_strerror (sockerr));
483 g_socket_get_local_address (GSocket *socket,
489 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
491 if (socket->priv->local_address)
492 return socket->priv->local_address;
494 if (getsockname (socket->priv->fd, (struct sockaddr *) buffer, &len) < 0)
496 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get local address: %s", g_strerror (errno));
500 return (socket->priv->local_address = g_object_ref_sink (g_socket_address_from_native (buffer, len)));
504 g_socket_get_remote_address (GSocket *socket,
510 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
512 if (socket->priv->remote_address)
513 return socket->priv->remote_address;
515 if (getpeername (socket->priv->fd, (struct sockaddr *) buffer, &len) < 0)
517 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get remote address: %s", g_strerror (errno));
521 return (socket->priv->remote_address = g_object_ref_sink (g_socket_address_from_native (buffer, len)));
525 g_socket_has_error (GSocket *socket,
528 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
530 if (!socket->priv->error)
537 g_socket_listen (GSocket *socket,
540 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
542 if (g_socket_has_error (socket, error))
545 if (listen (socket->priv->fd, socket->priv->backlog) < 0)
547 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not listen: %s", g_strerror (errno));
555 g_socket_bind (GSocket *socket,
556 GSocketAddress *address,
559 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
561 if (g_socket_has_error (socket, error))
567 if (!g_socket_address_to_native (address, addr))
570 if (bind (socket->priv->fd, (struct sockaddr *) addr, g_socket_address_native_size (address)) < 0)
572 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error binding to address: %s", g_strerror (errno));
576 g_object_ref_sink (address);
578 socket->priv->local_address = address;
585 g_socket_accept (GSocket *socket,
590 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
592 if (g_socket_has_error (socket, error))
595 if ((ret = accept (socket->priv->fd, NULL, 0)) < 0)
597 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error accepting connection: %s", g_strerror (errno));
601 return g_socket_new_from_fd (ret);
605 g_socket_connect (GSocket *socket,
606 GSocketAddress *address,
611 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
613 if (g_socket_has_error (socket, error))
616 g_socket_address_to_native (address, buffer);
618 if (connect (socket->priv->fd, (struct sockaddr *) buffer, g_socket_address_native_size (address)) < 0)
620 if (errno == EINPROGRESS)
621 g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING, "connection in progress");
623 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error connecting: %s", g_strerror (errno));
627 socket->priv->remote_address = g_object_ref_sink (address);
633 g_socket_receive (GSocket *socket,
640 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
642 if ((ret = recv (socket->priv->fd, buffer, size, 0)) < 0)
644 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error receiving data: %s", g_strerror (errno));
652 g_socket_send (GSocket *socket,
659 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
661 if ((ret = send (socket->priv->fd, buffer, size, 0)) < 0)
663 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error sending data: %s", g_strerror (errno));
671 g_socket_close (GSocket *socket)
673 g_return_if_fail (G_IS_SOCKET (socket));
676 closesocket (socket->priv->fd);
678 close (socket->priv->fd);
683 g_socket_create_source (GSocket *socket,
684 GIOCondition condition,
685 GCancellable *cancellable)
687 g_return_val_if_fail (G_IS_SOCKET (socket) && (cancellable == NULL || G_IS_CANCELLABLE (cancellable)), NULL);
689 return _g_fd_source_new (socket->priv->fd, condition, cancellable);