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"
31 # include <netinet/in.h>
32 # include <arpa/inet.h>
36 # include <sys/types.h>
42 #include "ginetaddress.h"
43 #include "ginet4address.h"
44 #include "ginet6address.h"
46 #include "gnioerror.h"
47 #include "ginetsocketaddress.h"
49 G_DEFINE_TYPE (GSocket, g_socket, G_TYPE_OBJECT);
65 struct _GSocketPrivate
73 gboolean reuse_address;
75 GSocketAddress *local_address;
76 GSocketAddress *remote_address;
80 g_socket_constructed (GObject *object)
82 GSocket *sock = G_SOCKET (object);
84 static GStaticMutex getprotobyname_mutex = G_STATIC_MUTEX_INIT;
85 gint fd, native_domain, native_type, native_protocol;
87 if (sock->priv->fd >= 0)
89 // we've been constructed from an existing file descriptor
93 // TODO: set the socket type with getsockopt (SO_TYPE)
94 // TODO: what should we do about domain and protocol?
96 if ((arg = fcntl (sock->priv->fd, F_GETFL, NULL)) < 0)
97 g_warning ("Error getting socket status flags: %s", g_strerror (errno));
99 blocking = ((arg & O_NONBLOCK) == 0);
104 switch (sock->priv->domain)
106 case G_SOCKET_DOMAIN_INET:
107 native_domain = PF_INET;
110 case G_SOCKET_DOMAIN_INET6:
111 native_domain = PF_INET6;
114 case G_SOCKET_DOMAIN_UNIX:
115 native_domain = PF_UNIX;
119 g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket domain");
123 switch (sock->priv->type)
125 case G_SOCKET_TYPE_STREAM:
126 native_type = SOCK_STREAM;
129 case G_SOCKET_TYPE_DATAGRAM:
130 native_type = SOCK_DGRAM;
133 case G_SOCKET_TYPE_SEQPACKET:
134 native_type = SOCK_SEQPACKET;
138 g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket type");
142 if (sock->priv->protocol == NULL)
146 struct protoent *ent;
147 g_static_mutex_lock (&getprotobyname_mutex);
148 if (!(ent = getprotobyname (sock->priv->protocol)))
150 g_static_mutex_unlock (&getprotobyname_mutex);
151 g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket protocol");
154 native_protocol = ent->p_proto;
155 g_static_mutex_unlock (&getprotobyname_mutex);
158 fd = socket (native_domain, native_type, native_protocol);
162 g_set_error (&error, G_IO_ERROR, g_io_error_from_errno (errno), "unable to create socket: %s", g_strerror (errno));
170 g_socket_get_property (GObject *object,
175 GSocket *socket = G_SOCKET (object);
180 g_value_set_enum (value, socket->priv->domain);
184 g_value_set_enum (value, socket->priv->type);
188 g_value_set_string (value, socket->priv->protocol);
192 g_value_set_int (value, socket->priv->fd);
196 g_value_set_boolean (value, socket->priv->blocking);
200 g_value_set_int (value, socket->priv->backlog);
203 case PROP_REUSE_ADDRESS:
204 g_value_set_boolean (value, socket->priv->reuse_address);
207 case PROP_LOCAL_ADDRESS:
208 g_value_set_object (value, socket->priv->local_address);
211 case PROP_REMOTE_ADDRESS:
212 g_value_set_object (value, socket->priv->remote_address);
216 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
221 g_socket_set_property (GObject *object,
226 GSocket *socket = G_SOCKET (object);
231 socket->priv->domain = g_value_get_enum (value);
235 socket->priv->type = g_value_get_enum (value);
239 socket->priv->protocol = g_value_dup_string (value);
243 socket->priv->fd = g_value_get_int (value);
247 g_socket_set_blocking (socket, g_value_get_boolean (value));
251 socket->priv->backlog = g_value_get_int (value);
254 case PROP_REUSE_ADDRESS:
255 g_socket_set_reuse_address (socket, g_value_get_boolean (value));
259 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
264 g_socket_finalize (GObject *object)
266 GSocket *socket = G_SOCKET (object);
268 if (socket->priv->local_address)
269 g_object_unref (socket->priv->local_address);
271 if (socket->priv->remote_address)
272 g_object_unref (socket->priv->remote_address);
274 if (G_OBJECT_CLASS (g_socket_parent_class)->finalize)
275 (*G_OBJECT_CLASS (g_socket_parent_class)->finalize) (object);
279 g_socket_dispose (GObject *object)
281 GSocket *socket = G_SOCKET (object);
283 g_free (socket->priv->protocol);
285 g_clear_error (&socket->priv->error);
287 g_socket_close (socket);
289 if (G_OBJECT_CLASS (g_socket_parent_class)->dispose)
290 (*G_OBJECT_CLASS (g_socket_parent_class)->dispose) (object);
294 g_socket_class_init (GSocketClass *klass)
296 GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
300 g_type_class_add_private (klass, sizeof (GSocketPrivate));
302 gobject_class->finalize = g_socket_finalize;
303 gobject_class->dispose = g_socket_dispose;
304 gobject_class->constructed = g_socket_constructed;
305 gobject_class->set_property = g_socket_set_property;
306 gobject_class->get_property = g_socket_get_property;
308 g_object_class_install_property (gobject_class, PROP_DOMAIN,
309 g_param_spec_enum ("domain",
311 "the socket's domain",
312 G_TYPE_SOCKET_DOMAIN,
313 G_SOCKET_DOMAIN_INET,
314 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
316 g_object_class_install_property (gobject_class, PROP_TYPE,
317 g_param_spec_enum ("type",
321 G_SOCKET_TYPE_STREAM,
322 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
324 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
325 g_param_spec_string ("protocol",
327 "the socket's protocol",
329 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
331 g_object_class_install_property (gobject_class, PROP_FD,
332 g_param_spec_int ("fd",
334 "the socket's file descriptor",
338 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
340 g_object_class_install_property (gobject_class, PROP_BLOCKING,
341 g_param_spec_boolean ("blocking",
343 "whether or not this socket is blocking",
345 G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
347 g_object_class_install_property (gobject_class, PROP_BACKLOG,
348 g_param_spec_int ("backlog",
350 "outstanding connections in the listen queue",
354 G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
356 g_object_class_install_property (gobject_class, PROP_REUSE_ADDRESS,
357 g_param_spec_boolean ("reuse-address",
359 "allow reuse of local addresses when binding",
361 G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
363 g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
364 g_param_spec_object ("local-address",
366 "the local address the socket is bound to",
367 G_TYPE_SOCKET_ADDRESS,
368 G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
370 g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
371 g_param_spec_object ("remote-address",
373 "the remote address the socket is connected to",
374 G_TYPE_SOCKET_ADDRESS,
375 G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
379 g_socket_init (GSocket *socket)
381 socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket, G_TYPE_SOCKET, GSocketPrivate);
383 socket->priv->fd = -1;
384 socket->priv->blocking = TRUE;
385 socket->priv->backlog = 10;
386 socket->priv->reuse_address = FALSE;
387 socket->priv->error = NULL;
388 socket->priv->remote_address = NULL;
389 socket->priv->local_address = NULL;
393 g_socket_new (GSocketDomain domain, GSocketType type, const gchar *protocol)
395 return G_SOCKET (g_object_new (G_TYPE_SOCKET, "domain", domain, "type", type, "protocol", protocol, NULL));
399 g_socket_new_from_fd (gint fd)
401 return G_SOCKET (g_object_new (G_TYPE_SOCKET, "fd", fd, NULL));
405 g_socket_set_blocking (GSocket *socket,
410 g_return_if_fail (G_IS_SOCKET (socket));
412 if ((arg = fcntl (socket->priv->fd, F_GETFL, NULL)) < 0)
413 g_warning ("Error getting socket status flags: %s", g_strerror (errno));
415 arg = blocking ? arg & ~O_NONBLOCK : arg | O_NONBLOCK;
417 if (fcntl (socket->priv->fd, F_SETFL, arg) < 0)
418 g_warning ("Error setting socket status flags: %s", g_strerror (errno));
420 socket->priv->blocking = blocking;
422 g_object_notify (G_OBJECT (socket), "blocking");
426 g_socket_get_blocking (GSocket *socket)
428 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
430 return socket->priv->blocking;
434 g_socket_set_reuse_address (GSocket *socket,
437 gint value = (gint) reuse;
439 g_return_if_fail (G_IS_SOCKET (socket));
441 if (setsockopt (socket->priv->fd, SOL_SOCKET, SO_REUSEADDR, (gpointer) &value, sizeof (value)) < 0)
442 g_warning ("error setting reuse address: %s", g_strerror (errno));
444 socket->priv->reuse_address = reuse;
446 g_object_notify (G_OBJECT (socket), "reuse-address");
450 g_socket_get_reuse_address (GSocket *socket)
452 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
454 return socket->priv->reuse_address;
458 g_socket_has_socket_error (GSocket *socket,
462 guint32 sockerr_size = sizeof (sockerr);
464 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
466 if (getsockopt (socket->priv->fd, SOL_SOCKET, SO_ERROR, (gpointer) &sockerr, &sockerr_size) < 0)
468 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get socket error: %s", g_strerror (errno));
474 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (sockerr), "error connecting: %s", g_strerror (sockerr));
482 g_socket_get_local_address (GSocket *socket,
488 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
490 if (socket->priv->local_address)
491 return socket->priv->local_address;
493 if (getsockname (socket->priv->fd, (struct sockaddr *) buffer, &len) < 0)
495 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get local address: %s", g_strerror (errno));
499 return (socket->priv->local_address = g_object_ref_sink (g_socket_address_from_native (buffer, len)));
503 g_socket_get_remote_address (GSocket *socket,
509 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
511 if (socket->priv->remote_address)
512 return socket->priv->remote_address;
514 if (getpeername (socket->priv->fd, (struct sockaddr *) buffer, &len) < 0)
516 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get remote address: %s", g_strerror (errno));
520 return (socket->priv->remote_address = g_object_ref_sink (g_socket_address_from_native (buffer, len)));
524 g_socket_has_error (GSocket *socket,
527 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
529 if (!socket->priv->error)
536 g_socket_listen (GSocket *socket,
539 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
541 if (g_socket_has_error (socket, error))
544 if (listen (socket->priv->fd, socket->priv->backlog) < 0)
546 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not listen: %s", g_strerror (errno));
554 g_socket_bind (GSocket *socket,
555 GSocketAddress *address,
558 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
560 if (g_socket_has_error (socket, error))
566 if (!g_socket_address_to_native (address, addr))
569 if (bind (socket->priv->fd, (struct sockaddr *) addr, g_socket_address_native_size (address)) < 0)
571 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error binding to address: %s", g_strerror (errno));
575 g_object_ref_sink (address);
577 socket->priv->local_address = address;
584 g_socket_accept (GSocket *socket,
589 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
591 if (g_socket_has_error (socket, error))
594 if ((ret = accept (socket->priv->fd, NULL, 0)) < 0)
596 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error accepting connection: %s", g_strerror (errno));
600 return g_socket_new_from_fd (ret);
604 g_socket_connect (GSocket *socket,
605 GSocketAddress *address,
610 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
612 if (g_socket_has_error (socket, error))
615 g_socket_address_to_native (address, buffer);
617 if (connect (socket->priv->fd, (struct sockaddr *) buffer, g_socket_address_native_size (address)) < 0)
619 if (errno == EINPROGRESS)
620 g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING, "connection in progress");
622 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error connecting: %s", g_strerror (errno));
626 socket->priv->remote_address = g_object_ref_sink (address);
632 g_socket_receive (GSocket *socket,
639 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
641 if ((ret = recv (socket->priv->fd, buffer, size, 0)) < 0)
643 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error receiving data: %s", g_strerror (errno));
651 g_socket_send (GSocket *socket,
658 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
660 if ((ret = send (socket->priv->fd, buffer, size, 0)) < 0)
662 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error sending data: %s", g_strerror (errno));
670 g_socket_close (GSocket *socket)
672 g_return_if_fail (G_IS_SOCKET (socket));
675 closesocket (socket->priv->fd);
677 close (socket->priv->fd);
682 g_socket_create_source (GSocket *socket,
683 GIOCondition condition,
684 GCancellable *cancellable)
686 g_return_val_if_fail (G_IS_SOCKET (socket) && (cancellable == NULL || G_IS_CANCELLABLE (cancellable)), NULL);
688 return _g_fd_source_new (socket->priv->fd, condition, cancellable);