1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
4 * Copyright © 2009 Codethink Limited
5 * Copyright © 2009 Red Hat, Inc
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
22 * Authors: Christian Kellner <gicmo@gnome.org>
23 * Samuel Cormier-Iijima <sciyoshi@gmail.com>
24 * Ryan Lortie <desrt@desrt.ca>
25 * Alexander Larsson <alexl@redhat.com>
46 #include "gcancellable.h"
47 #include "gioenumtypes.h"
48 #include "ginetaddress.h"
49 #include "ginitable.h"
53 #include "gnetworkingprivate.h"
54 #include "gsocketaddress.h"
55 #include "gsocketcontrolmessage.h"
56 #include "gcredentials.h"
61 * @short_description: Low-level socket object
63 * @see_also: #GInitable
65 * A #GSocket is a low-level networking primitive. It is a more or less
66 * direct mapping of the BSD socket API in a portable GObject based API.
67 * It supports both the UNIX socket implementations and winsock2 on Windows.
69 * #GSocket is the platform independent base upon which the higher level
70 * network primitives are based. Applications are not typically meant to
71 * use it directly, but rather through classes like #GSocketClient,
72 * #GSocketService and #GSocketConnection. However there may be cases where
73 * direct use of #GSocket is useful.
75 * #GSocket implements the #GInitable interface, so if it is manually constructed
76 * by e.g. g_object_new() you must call g_initable_init() and check the
77 * results before using the object. This is done automatically in
78 * g_socket_new() and g_socket_new_from_fd(), so these functions can return
81 * Sockets operate in two general modes, blocking or non-blocking. When
82 * in blocking mode all operations block until the requested operation
83 * is finished or there is an error. In non-blocking mode all calls that
84 * would block return immediately with a %G_IO_ERROR_WOULD_BLOCK error.
85 * To know when a call would successfully run you can call g_socket_condition_check(),
86 * or g_socket_condition_wait(). You can also use g_socket_create_source() and
87 * attach it to a #GMainContext to get callbacks when I/O is possible.
88 * Note that all sockets are always set to non blocking mode in the system, and
89 * blocking mode is emulated in GSocket.
91 * When working in non-blocking mode applications should always be able to
92 * handle getting a %G_IO_ERROR_WOULD_BLOCK error even when some other
93 * function said that I/O was possible. This can easily happen in case
94 * of a race condition in the application, but it can also happen for other
95 * reasons. For instance, on Windows a socket is always seen as writable
96 * until a write returns %G_IO_ERROR_WOULD_BLOCK.
98 * #GSocket<!-- -->s can be either connection oriented or datagram based.
99 * For connection oriented types you must first establish a connection by
100 * either connecting to an address or accepting a connection from another
101 * address. For connectionless socket types the target/source address is
102 * specified or received in each I/O operation.
104 * All socket file descriptors are set to be close-on-exec.
106 * Note that creating a #GSocket causes the signal %SIGPIPE to be
107 * ignored for the remainder of the program. If you are writing a
108 * command-line utility that uses #GSocket, you may need to take into
109 * account the fact that your program will not automatically be killed
110 * if it tries to write to %stdout after it has been closed.
115 static void g_socket_initable_iface_init (GInitableIface *iface);
116 static gboolean g_socket_initable_init (GInitable *initable,
117 GCancellable *cancellable,
120 G_DEFINE_TYPE_WITH_CODE (GSocket, g_socket, G_TYPE_OBJECT,
121 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE,
122 g_socket_initable_iface_init));
139 struct _GSocketPrivate
141 GSocketFamily family;
143 GSocketProtocol protocol;
147 GError *construct_error;
148 GSocketAddress *remote_address;
156 guint connect_pending : 1;
162 GList *requested_conditions; /* list of requested GIOCondition * */
167 get_socket_errno (void)
172 return WSAGetLastError ();
177 socket_io_error_from_errno (int err)
180 return g_io_error_from_errno (err);
185 return G_IO_ERROR_ADDRESS_IN_USE;
187 return G_IO_ERROR_WOULD_BLOCK;
189 return G_IO_ERROR_PERMISSION_DENIED;
190 case WSA_INVALID_HANDLE:
191 case WSA_INVALID_PARAMETER:
194 return G_IO_ERROR_INVALID_ARGUMENT;
195 case WSAEPROTONOSUPPORT:
196 return G_IO_ERROR_NOT_SUPPORTED;
198 return G_IO_ERROR_CANCELLED;
199 case WSAESOCKTNOSUPPORT:
201 case WSAEPFNOSUPPORT:
202 case WSAEAFNOSUPPORT:
203 return G_IO_ERROR_NOT_SUPPORTED;
205 return G_IO_ERROR_FAILED;
211 socket_strerror (int err)
214 return g_strerror (err);
216 static GStaticPrivate last_msg = G_STATIC_PRIVATE_INIT;
219 msg = g_win32_error_message (err);
220 g_static_private_set (&last_msg, msg, g_free);
227 #define win32_unset_event_mask(_socket, _mask) _win32_unset_event_mask (_socket, _mask)
229 _win32_unset_event_mask (GSocket *socket, int mask)
231 socket->priv->current_events &= ~mask;
232 socket->priv->current_errors &= ~mask;
235 #define win32_unset_event_mask(_socket, _mask)
239 set_fd_nonblocking (int fd)
248 if ((arg = fcntl (fd, F_GETFL, NULL)) < 0)
250 g_warning ("Error getting socket status flags: %s", socket_strerror (errno));
254 arg = arg | O_NONBLOCK;
256 if (fcntl (fd, F_SETFL, arg) < 0)
257 g_warning ("Error setting socket status flags: %s", socket_strerror (errno));
261 if (ioctlsocket (fd, FIONBIO, &arg) == SOCKET_ERROR)
263 int errsv = get_socket_errno ();
264 g_warning ("Error setting socket status flags: %s", socket_strerror (errsv));
270 check_socket (GSocket *socket,
273 if (!socket->priv->inited)
275 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_INITIALIZED,
276 _("Invalid socket, not initialized"));
280 if (socket->priv->construct_error)
282 g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_INITIALIZED,
283 _("Invalid socket, initialization failed due to: %s"),
284 socket->priv->construct_error->message);
288 if (socket->priv->closed)
290 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
291 _("Socket is already closed"));
295 if (socket->priv->timed_out)
297 socket->priv->timed_out = FALSE;
298 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
299 _("Socket I/O timed out"));
307 g_socket_details_from_fd (GSocket *socket)
309 struct sockaddr_storage address;
316 /* See bug #611756 */
317 BOOL bool_val = FALSE;
322 fd = socket->priv->fd;
323 optlen = sizeof value;
324 if (getsockopt (fd, SOL_SOCKET, SO_TYPE, (void *)&value, &optlen) != 0)
326 errsv = get_socket_errno ();
337 /* programmer error */
338 g_error ("creating GSocket from fd %d: %s\n",
339 fd, socket_strerror (errsv));
347 g_assert (optlen == sizeof value);
351 socket->priv->type = G_SOCKET_TYPE_STREAM;
355 socket->priv->type = G_SOCKET_TYPE_DATAGRAM;
359 socket->priv->type = G_SOCKET_TYPE_SEQPACKET;
363 socket->priv->type = G_SOCKET_TYPE_INVALID;
367 addrlen = sizeof address;
368 if (getsockname (fd, (struct sockaddr *) &address, &addrlen) != 0)
370 errsv = get_socket_errno ();
374 g_assert (G_STRUCT_OFFSET (struct sockaddr, sa_family) +
375 sizeof address.ss_family <= addrlen);
376 switch (address.ss_family)
378 case G_SOCKET_FAMILY_IPV4:
379 case G_SOCKET_FAMILY_IPV6:
380 socket->priv->family = address.ss_family;
381 switch (socket->priv->type)
383 case G_SOCKET_TYPE_STREAM:
384 socket->priv->protocol = G_SOCKET_PROTOCOL_TCP;
387 case G_SOCKET_TYPE_DATAGRAM:
388 socket->priv->protocol = G_SOCKET_PROTOCOL_UDP;
391 case G_SOCKET_TYPE_SEQPACKET:
392 socket->priv->protocol = G_SOCKET_PROTOCOL_SCTP;
400 case G_SOCKET_FAMILY_UNIX:
401 socket->priv->family = G_SOCKET_FAMILY_UNIX;
402 socket->priv->protocol = G_SOCKET_PROTOCOL_DEFAULT;
406 socket->priv->family = G_SOCKET_FAMILY_INVALID;
410 if (socket->priv->family != G_SOCKET_FAMILY_INVALID)
412 addrlen = sizeof address;
413 if (getpeername (fd, (struct sockaddr *) &address, &addrlen) >= 0)
414 socket->priv->connected = TRUE;
417 optlen = sizeof bool_val;
418 if (getsockopt (fd, SOL_SOCKET, SO_KEEPALIVE,
419 (void *)&bool_val, &optlen) == 0)
422 /* Experimentation indicates that the SO_KEEPALIVE value is
423 * actually a char on Windows, even if documentation claims it
424 * to be a BOOL which is a typedef for int. So this g_assert()
425 * fails. See bug #611756.
427 g_assert (optlen == sizeof bool_val);
429 socket->priv->keepalive = !!bool_val;
433 /* Can't read, maybe not supported, assume FALSE */
434 socket->priv->keepalive = FALSE;
440 g_set_error (&socket->priv->construct_error, G_IO_ERROR,
441 socket_io_error_from_errno (errsv),
442 _("creating GSocket from fd: %s"),
443 socket_strerror (errsv));
447 g_socket_create_socket (GSocketFamily family,
457 case G_SOCKET_TYPE_STREAM:
458 native_type = SOCK_STREAM;
461 case G_SOCKET_TYPE_DATAGRAM:
462 native_type = SOCK_DGRAM;
465 case G_SOCKET_TYPE_SEQPACKET:
466 native_type = SOCK_SEQPACKET;
470 g_assert_not_reached ();
475 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
476 _("Unable to create socket: %s"), _("Unknown protocol was specified"));
481 fd = socket (family, native_type | SOCK_CLOEXEC, protocol);
482 /* It's possible that libc has SOCK_CLOEXEC but the kernel does not */
483 if (fd < 0 && errno == EINVAL)
485 fd = socket (family, native_type, protocol);
489 int errsv = get_socket_errno ();
491 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
492 _("Unable to create socket: %s"), socket_strerror (errsv));
499 /* We always want to set close-on-exec to protect users. If you
500 need to so some weird inheritance to exec you can re-enable this
501 using lower level hacks with g_socket_get_fd(). */
502 flags = fcntl (fd, F_GETFD, 0);
504 (flags & FD_CLOEXEC) == 0)
507 fcntl (fd, F_SETFD, flags);
516 g_socket_constructed (GObject *object)
518 GSocket *socket = G_SOCKET (object);
520 if (socket->priv->fd >= 0)
521 /* create socket->priv info from the fd */
522 g_socket_details_from_fd (socket);
525 /* create the fd from socket->priv info */
526 socket->priv->fd = g_socket_create_socket (socket->priv->family,
528 socket->priv->protocol,
529 &socket->priv->construct_error);
531 /* Always use native nonblocking sockets, as
532 windows sets sockets to nonblocking automatically
533 in certain operations. This way we make things work
534 the same on all platforms */
535 if (socket->priv->fd != -1)
536 set_fd_nonblocking (socket->priv->fd);
540 g_socket_get_property (GObject *object,
545 GSocket *socket = G_SOCKET (object);
546 GSocketAddress *address;
551 g_value_set_enum (value, socket->priv->family);
555 g_value_set_enum (value, socket->priv->type);
559 g_value_set_enum (value, socket->priv->protocol);
563 g_value_set_int (value, socket->priv->fd);
567 g_value_set_boolean (value, socket->priv->blocking);
570 case PROP_LISTEN_BACKLOG:
571 g_value_set_int (value, socket->priv->listen_backlog);
575 g_value_set_boolean (value, socket->priv->keepalive);
578 case PROP_LOCAL_ADDRESS:
579 address = g_socket_get_local_address (socket, NULL);
580 g_value_take_object (value, address);
583 case PROP_REMOTE_ADDRESS:
584 address = g_socket_get_remote_address (socket, NULL);
585 g_value_take_object (value, address);
589 g_value_set_uint (value, socket->priv->timeout);
593 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
598 g_socket_set_property (GObject *object,
603 GSocket *socket = G_SOCKET (object);
608 socket->priv->family = g_value_get_enum (value);
612 socket->priv->type = g_value_get_enum (value);
616 socket->priv->protocol = g_value_get_enum (value);
620 socket->priv->fd = g_value_get_int (value);
624 g_socket_set_blocking (socket, g_value_get_boolean (value));
627 case PROP_LISTEN_BACKLOG:
628 g_socket_set_listen_backlog (socket, g_value_get_int (value));
632 g_socket_set_keepalive (socket, g_value_get_boolean (value));
636 g_socket_set_timeout (socket, g_value_get_uint (value));
640 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
645 g_socket_finalize (GObject *object)
647 GSocket *socket = G_SOCKET (object);
649 g_clear_error (&socket->priv->construct_error);
651 if (socket->priv->fd != -1 &&
652 !socket->priv->closed)
653 g_socket_close (socket, NULL);
655 if (socket->priv->remote_address)
656 g_object_unref (socket->priv->remote_address);
659 if (socket->priv->event != WSA_INVALID_EVENT)
661 WSACloseEvent (socket->priv->event);
662 socket->priv->event = WSA_INVALID_EVENT;
665 g_assert (socket->priv->requested_conditions == NULL);
668 if (G_OBJECT_CLASS (g_socket_parent_class)->finalize)
669 (*G_OBJECT_CLASS (g_socket_parent_class)->finalize) (object);
673 g_socket_class_init (GSocketClass *klass)
675 GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
678 /* Make sure winsock has been initialized */
679 type = g_inet_address_get_type ();
682 /* There is no portable, thread-safe way to avoid having the process
683 * be killed by SIGPIPE when calling send() or sendmsg(), so we are
684 * forced to simply ignore the signal process-wide.
686 signal (SIGPIPE, SIG_IGN);
689 g_type_class_add_private (klass, sizeof (GSocketPrivate));
691 gobject_class->finalize = g_socket_finalize;
692 gobject_class->constructed = g_socket_constructed;
693 gobject_class->set_property = g_socket_set_property;
694 gobject_class->get_property = g_socket_get_property;
696 g_object_class_install_property (gobject_class, PROP_FAMILY,
697 g_param_spec_enum ("family",
699 P_("The sockets address family"),
700 G_TYPE_SOCKET_FAMILY,
701 G_SOCKET_FAMILY_INVALID,
702 G_PARAM_CONSTRUCT_ONLY |
704 G_PARAM_STATIC_STRINGS));
706 g_object_class_install_property (gobject_class, PROP_TYPE,
707 g_param_spec_enum ("type",
709 P_("The sockets type"),
711 G_SOCKET_TYPE_STREAM,
712 G_PARAM_CONSTRUCT_ONLY |
714 G_PARAM_STATIC_STRINGS));
716 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
717 g_param_spec_enum ("protocol",
718 P_("Socket protocol"),
719 P_("The id of the protocol to use, or -1 for unknown"),
720 G_TYPE_SOCKET_PROTOCOL,
721 G_SOCKET_PROTOCOL_UNKNOWN,
722 G_PARAM_CONSTRUCT_ONLY |
724 G_PARAM_STATIC_STRINGS));
726 g_object_class_install_property (gobject_class, PROP_FD,
727 g_param_spec_int ("fd",
728 P_("File descriptor"),
729 P_("The sockets file descriptor"),
733 G_PARAM_CONSTRUCT_ONLY |
735 G_PARAM_STATIC_STRINGS));
737 g_object_class_install_property (gobject_class, PROP_BLOCKING,
738 g_param_spec_boolean ("blocking",
740 P_("Whether or not I/O on this socket is blocking"),
743 G_PARAM_STATIC_STRINGS));
745 g_object_class_install_property (gobject_class, PROP_LISTEN_BACKLOG,
746 g_param_spec_int ("listen-backlog",
747 P_("Listen backlog"),
748 P_("Outstanding connections in the listen queue"),
753 G_PARAM_STATIC_STRINGS));
755 g_object_class_install_property (gobject_class, PROP_KEEPALIVE,
756 g_param_spec_boolean ("keepalive",
757 P_("Keep connection alive"),
758 P_("Keep connection alive by sending periodic pings"),
761 G_PARAM_STATIC_STRINGS));
763 g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
764 g_param_spec_object ("local-address",
766 P_("The local address the socket is bound to"),
767 G_TYPE_SOCKET_ADDRESS,
769 G_PARAM_STATIC_STRINGS));
771 g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
772 g_param_spec_object ("remote-address",
773 P_("Remote address"),
774 P_("The remote address the socket is connected to"),
775 G_TYPE_SOCKET_ADDRESS,
777 G_PARAM_STATIC_STRINGS));
782 * The timeout in seconds on socket I/O
786 g_object_class_install_property (gobject_class, PROP_TIMEOUT,
787 g_param_spec_uint ("timeout",
789 P_("The timeout in seconds on socket I/O"),
794 G_PARAM_STATIC_STRINGS));
798 g_socket_initable_iface_init (GInitableIface *iface)
800 iface->init = g_socket_initable_init;
804 g_socket_init (GSocket *socket)
806 socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket, G_TYPE_SOCKET, GSocketPrivate);
808 socket->priv->fd = -1;
809 socket->priv->blocking = TRUE;
810 socket->priv->listen_backlog = 10;
811 socket->priv->construct_error = NULL;
813 socket->priv->event = WSA_INVALID_EVENT;
818 g_socket_initable_init (GInitable *initable,
819 GCancellable *cancellable,
824 g_return_val_if_fail (G_IS_SOCKET (initable), FALSE);
826 socket = G_SOCKET (initable);
828 if (cancellable != NULL)
830 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
831 _("Cancellable initialization not supported"));
835 socket->priv->inited = TRUE;
837 if (socket->priv->construct_error)
840 *error = g_error_copy (socket->priv->construct_error);
850 * @family: the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.
851 * @type: the socket type to use.
852 * @protocol: the id of the protocol to use, or 0 for default.
853 * @error: #GError for error reporting, or %NULL to ignore.
855 * Creates a new #GSocket with the defined family, type and protocol.
856 * If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type
857 * for the family and type is used.
859 * The @protocol is a family and type specific int that specifies what
860 * kind of protocol to use. #GSocketProtocol lists several common ones.
861 * Many families only support one protocol, and use 0 for this, others
862 * support several and using 0 means to use the default protocol for
863 * the family and type.
865 * The protocol id is passed directly to the operating
866 * system, so you can use protocols not listed in #GSocketProtocol if you
867 * know the protocol number used for it.
869 * Returns: a #GSocket or %NULL on error.
870 * Free the returned object with g_object_unref().
875 g_socket_new (GSocketFamily family,
877 GSocketProtocol protocol,
880 return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
884 "protocol", protocol,
889 * g_socket_new_from_fd:
890 * @fd: a native socket file descriptor.
891 * @error: #GError for error reporting, or %NULL to ignore.
893 * Creates a new #GSocket from a native file descriptor
894 * or winsock SOCKET handle.
896 * This reads all the settings from the file descriptor so that
897 * all properties should work. Note that the file descriptor
898 * will be set to non-blocking mode, independent on the blocking
899 * mode of the #GSocket.
901 * Returns: a #GSocket or %NULL on error.
902 * Free the returned object with g_object_unref().
907 g_socket_new_from_fd (gint fd,
910 return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
917 * g_socket_set_blocking:
918 * @socket: a #GSocket.
919 * @blocking: Whether to use blocking I/O or not.
921 * Sets the blocking mode of the socket. In blocking mode
922 * all operations block until they succeed or there is an error. In
923 * non-blocking mode all functions return results immediately or
924 * with a %G_IO_ERROR_WOULD_BLOCK error.
926 * All sockets are created in blocking mode. However, note that the
927 * platform level socket is always non-blocking, and blocking mode
928 * is a GSocket level feature.
933 g_socket_set_blocking (GSocket *socket,
936 g_return_if_fail (G_IS_SOCKET (socket));
938 blocking = !!blocking;
940 if (socket->priv->blocking == blocking)
943 socket->priv->blocking = blocking;
944 g_object_notify (G_OBJECT (socket), "blocking");
948 * g_socket_get_blocking:
949 * @socket: a #GSocket.
951 * Gets the blocking mode of the socket. For details on blocking I/O,
952 * see g_socket_set_blocking().
954 * Returns: %TRUE if blocking I/O is used, %FALSE otherwise.
959 g_socket_get_blocking (GSocket *socket)
961 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
963 return socket->priv->blocking;
967 * g_socket_set_keepalive:
968 * @socket: a #GSocket.
969 * @keepalive: Value for the keepalive flag
971 * Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When
972 * this flag is set on a socket, the system will attempt to verify that the
973 * remote socket endpoint is still present if a sufficiently long period of
974 * time passes with no data being exchanged. If the system is unable to
975 * verify the presence of the remote endpoint, it will automatically close
978 * This option is only functional on certain kinds of sockets. (Notably,
979 * %G_SOCKET_PROTOCOL_TCP sockets.)
981 * The exact time between pings is system- and protocol-dependent, but will
982 * normally be at least two hours. Most commonly, you would set this flag
983 * on a server socket if you want to allow clients to remain idle for long
984 * periods of time, but also want to ensure that connections are eventually
985 * garbage-collected if clients crash or become unreachable.
990 g_socket_set_keepalive (GSocket *socket,
995 g_return_if_fail (G_IS_SOCKET (socket));
997 keepalive = !!keepalive;
998 if (socket->priv->keepalive == keepalive)
1001 value = (gint) keepalive;
1002 if (setsockopt (socket->priv->fd, SOL_SOCKET, SO_KEEPALIVE,
1003 (gpointer) &value, sizeof (value)) < 0)
1005 int errsv = get_socket_errno ();
1006 g_warning ("error setting keepalive: %s", socket_strerror (errsv));
1010 socket->priv->keepalive = keepalive;
1011 g_object_notify (G_OBJECT (socket), "keepalive");
1015 * g_socket_get_keepalive:
1016 * @socket: a #GSocket.
1018 * Gets the keepalive mode of the socket. For details on this,
1019 * see g_socket_set_keepalive().
1021 * Returns: %TRUE if keepalive is active, %FALSE otherwise.
1026 g_socket_get_keepalive (GSocket *socket)
1028 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1030 return socket->priv->keepalive;
1034 * g_socket_get_listen_backlog:
1035 * @socket: a #GSocket.
1037 * Gets the listen backlog setting of the socket. For details on this,
1038 * see g_socket_set_listen_backlog().
1040 * Returns: the maximum number of pending connections.
1045 g_socket_get_listen_backlog (GSocket *socket)
1047 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1049 return socket->priv->listen_backlog;
1053 * g_socket_set_listen_backlog:
1054 * @socket: a #GSocket.
1055 * @backlog: the maximum number of pending connections.
1057 * Sets the maximum number of outstanding connections allowed
1058 * when listening on this socket. If more clients than this are
1059 * connecting to the socket and the application is not handling them
1060 * on time then the new connections will be refused.
1062 * Note that this must be called before g_socket_listen() and has no
1063 * effect if called after that.
1068 g_socket_set_listen_backlog (GSocket *socket,
1071 g_return_if_fail (G_IS_SOCKET (socket));
1072 g_return_if_fail (!socket->priv->listening);
1074 if (backlog != socket->priv->listen_backlog)
1076 socket->priv->listen_backlog = backlog;
1077 g_object_notify (G_OBJECT (socket), "listen-backlog");
1082 * g_socket_get_timeout:
1083 * @socket: a #GSocket.
1085 * Gets the timeout setting of the socket. For details on this, see
1086 * g_socket_set_timeout().
1088 * Returns: the timeout in seconds
1093 g_socket_get_timeout (GSocket *socket)
1095 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1097 return socket->priv->timeout;
1101 * g_socket_set_timeout:
1102 * @socket: a #GSocket.
1103 * @timeout: the timeout for @socket, in seconds, or 0 for none
1105 * Sets the time in seconds after which I/O operations on @socket will
1106 * time out if they have not yet completed.
1108 * On a blocking socket, this means that any blocking #GSocket
1109 * operation will time out after @timeout seconds of inactivity,
1110 * returning %G_IO_ERROR_TIMED_OUT.
1112 * On a non-blocking socket, calls to g_socket_condition_wait() will
1113 * also fail with %G_IO_ERROR_TIMED_OUT after the given time. Sources
1114 * created with g_socket_create_source() will trigger after
1115 * @timeout seconds of inactivity, with the requested condition
1116 * set, at which point calling g_socket_receive(), g_socket_send(),
1117 * g_socket_check_connect_result(), etc, will fail with
1118 * %G_IO_ERROR_TIMED_OUT.
1120 * If @timeout is 0 (the default), operations will never time out
1123 * Note that if an I/O operation is interrupted by a signal, this may
1124 * cause the timeout to be reset.
1129 g_socket_set_timeout (GSocket *socket,
1132 g_return_if_fail (G_IS_SOCKET (socket));
1134 if (timeout != socket->priv->timeout)
1136 socket->priv->timeout = timeout;
1137 g_object_notify (G_OBJECT (socket), "timeout");
1142 * g_socket_get_family:
1143 * @socket: a #GSocket.
1145 * Gets the socket family of the socket.
1147 * Returns: a #GSocketFamily
1152 g_socket_get_family (GSocket *socket)
1154 g_return_val_if_fail (G_IS_SOCKET (socket), G_SOCKET_FAMILY_INVALID);
1156 return socket->priv->family;
1160 * g_socket_get_socket_type:
1161 * @socket: a #GSocket.
1163 * Gets the socket type of the socket.
1165 * Returns: a #GSocketType
1170 g_socket_get_socket_type (GSocket *socket)
1172 g_return_val_if_fail (G_IS_SOCKET (socket), G_SOCKET_TYPE_INVALID);
1174 return socket->priv->type;
1178 * g_socket_get_protocol:
1179 * @socket: a #GSocket.
1181 * Gets the socket protocol id the socket was created with.
1182 * In case the protocol is unknown, -1 is returned.
1184 * Returns: a protocol id, or -1 if unknown
1189 g_socket_get_protocol (GSocket *socket)
1191 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
1193 return socket->priv->protocol;
1198 * @socket: a #GSocket.
1200 * Returns the underlying OS socket object. On unix this
1201 * is a socket file descriptor, and on windows this is
1202 * a Winsock2 SOCKET handle. This may be useful for
1203 * doing platform specific or otherwise unusual operations
1206 * Returns: the file descriptor of the socket.
1211 g_socket_get_fd (GSocket *socket)
1213 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
1215 return socket->priv->fd;
1219 * g_socket_get_local_address:
1220 * @socket: a #GSocket.
1221 * @error: #GError for error reporting, or %NULL to ignore.
1223 * Try to get the local address of a bound socket. This is only
1224 * useful if the socket has been bound to a local address,
1225 * either explicitly or implicitly when connecting.
1227 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
1228 * Free the returned object with g_object_unref().
1233 g_socket_get_local_address (GSocket *socket,
1236 struct sockaddr_storage buffer;
1237 guint32 len = sizeof (buffer);
1239 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1241 if (getsockname (socket->priv->fd, (struct sockaddr *) &buffer, &len) < 0)
1243 int errsv = get_socket_errno ();
1244 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1245 _("could not get local address: %s"), socket_strerror (errsv));
1249 return g_socket_address_new_from_native (&buffer, len);
1253 * g_socket_get_remote_address:
1254 * @socket: a #GSocket.
1255 * @error: #GError for error reporting, or %NULL to ignore.
1257 * Try to get the remove address of a connected socket. This is only
1258 * useful for connection oriented sockets that have been connected.
1260 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
1261 * Free the returned object with g_object_unref().
1266 g_socket_get_remote_address (GSocket *socket,
1269 struct sockaddr_storage buffer;
1270 guint32 len = sizeof (buffer);
1272 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1274 if (socket->priv->connect_pending)
1276 if (!g_socket_check_connect_result (socket, error))
1279 socket->priv->connect_pending = FALSE;
1282 if (!socket->priv->remote_address)
1284 if (getpeername (socket->priv->fd, (struct sockaddr *) &buffer, &len) < 0)
1286 int errsv = get_socket_errno ();
1287 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1288 _("could not get remote address: %s"), socket_strerror (errsv));
1292 socket->priv->remote_address = g_socket_address_new_from_native (&buffer, len);
1295 return g_object_ref (socket->priv->remote_address);
1299 * g_socket_is_connected:
1300 * @socket: a #GSocket.
1302 * Check whether the socket is connected. This is only useful for
1303 * connection-oriented sockets.
1305 * Returns: %TRUE if socket is connected, %FALSE otherwise.
1310 g_socket_is_connected (GSocket *socket)
1312 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1314 return socket->priv->connected;
1319 * @socket: a #GSocket.
1320 * @error: #GError for error reporting, or %NULL to ignore.
1322 * Marks the socket as a server socket, i.e. a socket that is used
1323 * to accept incoming requests using g_socket_accept().
1325 * Before calling this the socket must be bound to a local address using
1328 * To set the maximum amount of outstanding clients, use
1329 * g_socket_set_listen_backlog().
1331 * Returns: %TRUE on success, %FALSE on error.
1336 g_socket_listen (GSocket *socket,
1339 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1341 if (!check_socket (socket, error))
1344 if (listen (socket->priv->fd, socket->priv->listen_backlog) < 0)
1346 int errsv = get_socket_errno ();
1348 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1349 _("could not listen: %s"), socket_strerror (errsv));
1353 socket->priv->listening = TRUE;
1360 * @socket: a #GSocket.
1361 * @address: a #GSocketAddress specifying the local address.
1362 * @allow_reuse: whether to allow reusing this address
1363 * @error: #GError for error reporting, or %NULL to ignore.
1365 * When a socket is created it is attached to an address family, but it
1366 * doesn't have an address in this family. g_socket_bind() assigns the
1367 * address (sometimes called name) of the socket.
1369 * It is generally required to bind to a local address before you can
1370 * receive connections. (See g_socket_listen() and g_socket_accept() ).
1371 * In certain situations, you may also want to bind a socket that will be
1372 * used to initiate connections, though this is not normally required.
1374 * @allow_reuse should be %TRUE for server sockets (sockets that you will
1375 * eventually call g_socket_accept() on), and %FALSE for client sockets.
1376 * (Specifically, if it is %TRUE, then g_socket_bind() will set the
1377 * %SO_REUSEADDR flag on the socket, allowing it to bind @address even if
1378 * that address was previously used by another socket that has not yet been
1379 * fully cleaned-up by the kernel. Failing to set this flag on a server
1380 * socket may cause the bind call to return %G_IO_ERROR_ADDRESS_IN_USE if
1381 * the server program is stopped and then immediately restarted.)
1383 * Returns: %TRUE on success, %FALSE on error.
1388 g_socket_bind (GSocket *socket,
1389 GSocketAddress *address,
1390 gboolean reuse_address,
1393 struct sockaddr_storage addr;
1395 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
1397 if (!check_socket (socket, error))
1400 /* SO_REUSEADDR on windows means something else and is not what we want.
1401 It always allows the unix variant of SO_REUSEADDR anyway */
1406 value = (int) !!reuse_address;
1407 /* Ignore errors here, the only likely error is "not supported", and
1408 this is a "best effort" thing mainly */
1409 setsockopt (socket->priv->fd, SOL_SOCKET, SO_REUSEADDR,
1410 (gpointer) &value, sizeof (value));
1414 if (!g_socket_address_to_native (address, &addr, sizeof addr, error))
1417 if (bind (socket->priv->fd, (struct sockaddr *) &addr,
1418 g_socket_address_get_native_size (address)) < 0)
1420 int errsv = get_socket_errno ();
1422 G_IO_ERROR, socket_io_error_from_errno (errsv),
1423 _("Error binding to address: %s"), socket_strerror (errsv));
1431 * g_socket_speaks_ipv4:
1432 * @socket: a #GSocket
1434 * Checks if a socket is capable of speaking IPv4.
1436 * IPv4 sockets are capable of speaking IPv4. On some operating systems
1437 * and under some combinations of circumstances IPv6 sockets are also
1438 * capable of speaking IPv4. See RFC 3493 section 3.7 for more
1441 * No other types of sockets are currently considered as being capable
1444 * Returns: %TRUE if this socket can be used with IPv4.
1449 g_socket_speaks_ipv4 (GSocket *socket)
1451 switch (socket->priv->family)
1453 case G_SOCKET_FAMILY_IPV4:
1456 case G_SOCKET_FAMILY_IPV6:
1457 #if defined (IPPROTO_IPV6) && defined (IPV6_V6ONLY)
1459 guint sizeof_int = sizeof (int);
1462 if (getsockopt (socket->priv->fd,
1463 IPPROTO_IPV6, IPV6_V6ONLY,
1464 &v6_only, &sizeof_int) != 0)
1480 * @socket: a #GSocket.
1481 * @cancellable: a %GCancellable or %NULL
1482 * @error: #GError for error reporting, or %NULL to ignore.
1484 * Accept incoming connections on a connection-based socket. This removes
1485 * the first outstanding connection request from the listening socket and
1486 * creates a #GSocket object for it.
1488 * The @socket must be bound to a local address with g_socket_bind() and
1489 * must be listening for incoming connections (g_socket_listen()).
1491 * If there are no outstanding connections then the operation will block
1492 * or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled.
1493 * To be notified of an incoming connection, wait for the %G_IO_IN condition.
1495 * Returns: (transfer full): a new #GSocket, or %NULL on error.
1496 * Free the returned object with g_object_unref().
1501 g_socket_accept (GSocket *socket,
1502 GCancellable *cancellable,
1505 GSocket *new_socket;
1508 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1510 if (!check_socket (socket, error))
1515 if (socket->priv->blocking &&
1516 !g_socket_condition_wait (socket,
1517 G_IO_IN, cancellable, error))
1520 if ((ret = accept (socket->priv->fd, NULL, 0)) < 0)
1522 int errsv = get_socket_errno ();
1524 win32_unset_event_mask (socket, FD_ACCEPT);
1529 if (socket->priv->blocking)
1531 #ifdef WSAEWOULDBLOCK
1532 if (errsv == WSAEWOULDBLOCK)
1535 if (errsv == EWOULDBLOCK ||
1541 g_set_error (error, G_IO_ERROR,
1542 socket_io_error_from_errno (errsv),
1543 _("Error accepting connection: %s"), socket_strerror (errsv));
1549 win32_unset_event_mask (socket, FD_ACCEPT);
1553 /* The socket inherits the accepting sockets event mask and even object,
1554 we need to remove that */
1555 WSAEventSelect (ret, NULL, 0);
1561 /* We always want to set close-on-exec to protect users. If you
1562 need to so some weird inheritance to exec you can re-enable this
1563 using lower level hacks with g_socket_get_fd(). */
1564 flags = fcntl (ret, F_GETFD, 0);
1566 (flags & FD_CLOEXEC) == 0)
1568 flags |= FD_CLOEXEC;
1569 fcntl (ret, F_SETFD, flags);
1574 new_socket = g_socket_new_from_fd (ret, error);
1575 if (new_socket == NULL)
1584 new_socket->priv->protocol = socket->priv->protocol;
1591 * @socket: a #GSocket.
1592 * @address: a #GSocketAddress specifying the remote address.
1593 * @cancellable: a %GCancellable or %NULL
1594 * @error: #GError for error reporting, or %NULL to ignore.
1596 * Connect the socket to the specified remote address.
1598 * For connection oriented socket this generally means we attempt to make
1599 * a connection to the @address. For a connection-less socket it sets
1600 * the default address for g_socket_send() and discards all incoming datagrams
1601 * from other sources.
1603 * Generally connection oriented sockets can only connect once, but
1604 * connection-less sockets can connect multiple times to change the
1607 * If the connect call needs to do network I/O it will block, unless
1608 * non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned
1609 * and the user can be notified of the connection finishing by waiting
1610 * for the G_IO_OUT condition. The result of the connection can then be
1611 * checked with g_socket_check_connect_result().
1613 * Returns: %TRUE if connected, %FALSE on error.
1618 g_socket_connect (GSocket *socket,
1619 GSocketAddress *address,
1620 GCancellable *cancellable,
1623 struct sockaddr_storage buffer;
1625 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
1627 if (!check_socket (socket, error))
1630 if (!g_socket_address_to_native (address, &buffer, sizeof buffer, error))
1633 if (socket->priv->remote_address)
1634 g_object_unref (socket->priv->remote_address);
1635 socket->priv->remote_address = g_object_ref (address);
1639 if (connect (socket->priv->fd, (struct sockaddr *) &buffer,
1640 g_socket_address_get_native_size (address)) < 0)
1642 int errsv = get_socket_errno ();
1648 if (errsv == EINPROGRESS)
1650 if (errsv == WSAEWOULDBLOCK)
1653 if (socket->priv->blocking)
1655 if (g_socket_condition_wait (socket, G_IO_OUT, cancellable, error))
1657 if (g_socket_check_connect_result (socket, error))
1660 g_prefix_error (error, _("Error connecting: "));
1664 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
1665 _("Connection in progress"));
1666 socket->priv->connect_pending = TRUE;
1670 g_set_error (error, G_IO_ERROR,
1671 socket_io_error_from_errno (errsv),
1672 _("Error connecting: %s"), socket_strerror (errsv));
1679 win32_unset_event_mask (socket, FD_CONNECT);
1681 socket->priv->connected = TRUE;
1687 * g_socket_check_connect_result:
1688 * @socket: a #GSocket
1689 * @error: #GError for error reporting, or %NULL to ignore.
1691 * Checks and resets the pending connect error for the socket.
1692 * This is used to check for errors when g_socket_connect() is
1693 * used in non-blocking mode.
1695 * Returns: %TRUE if no error, %FALSE otherwise, setting @error to the error
1700 g_socket_check_connect_result (GSocket *socket,
1706 if (!check_socket (socket, error))
1709 optlen = sizeof (value);
1710 if (getsockopt (socket->priv->fd, SOL_SOCKET, SO_ERROR, (void *)&value, &optlen) != 0)
1712 int errsv = get_socket_errno ();
1714 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1715 _("Unable to get pending error: %s"), socket_strerror (errsv));
1721 g_set_error_literal (error, G_IO_ERROR, socket_io_error_from_errno (value),
1722 socket_strerror (value));
1723 if (socket->priv->remote_address)
1725 g_object_unref (socket->priv->remote_address);
1726 socket->priv->remote_address = NULL;
1735 * @socket: a #GSocket
1736 * @buffer: a buffer to read data into (which should be at least @size
1738 * @size: the number of bytes you want to read from the socket
1739 * @cancellable: a %GCancellable or %NULL
1740 * @error: #GError for error reporting, or %NULL to ignore.
1742 * Receive data (up to @size bytes) from a socket. This is mainly used by
1743 * connection-oriented sockets; it is identical to g_socket_receive_from()
1744 * with @address set to %NULL.
1746 * For %G_SOCKET_TYPE_DATAGRAM and %G_SOCKET_TYPE_SEQPACKET sockets,
1747 * g_socket_receive() will always read either 0 or 1 complete messages from
1748 * the socket. If the received message is too large to fit in @buffer, then
1749 * the data beyond @size bytes will be discarded, without any explicit
1750 * indication that this has occurred.
1752 * For %G_SOCKET_TYPE_STREAM sockets, g_socket_receive() can return any
1753 * number of bytes, up to @size. If more than @size bytes have been
1754 * received, the additional data will be returned in future calls to
1755 * g_socket_receive().
1757 * If the socket is in blocking mode the call will block until there is
1758 * some data to receive or there is an error. If there is no data available
1759 * and the socket is in non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error
1760 * will be returned. To be notified when data is available, wait for the
1761 * %G_IO_IN condition.
1763 * On error -1 is returned and @error is set accordingly.
1765 * Returns: Number of bytes read, or -1 on error
1770 g_socket_receive (GSocket *socket,
1773 GCancellable *cancellable,
1776 return g_socket_receive_with_blocking (socket, buffer, size,
1777 socket->priv->blocking,
1778 cancellable, error);
1782 * g_socket_receive_with_blocking:
1783 * @socket: a #GSocket
1784 * @buffer: a buffer to read data into (which should be at least @size
1786 * @size: the number of bytes you want to read from the socket
1787 * @blocking: whether to do blocking or non-blocking I/O
1788 * @cancellable: a %GCancellable or %NULL
1789 * @error: #GError for error reporting, or %NULL to ignore.
1791 * This behaves exactly the same as g_socket_receive(), except that
1792 * the choice of blocking or non-blocking behavior is determined by
1793 * the @blocking argument rather than by @socket's properties.
1795 * Returns: Number of bytes read, or -1 on error
1800 g_socket_receive_with_blocking (GSocket *socket,
1804 GCancellable *cancellable,
1809 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
1811 if (!check_socket (socket, error))
1814 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1820 !g_socket_condition_wait (socket,
1821 G_IO_IN, cancellable, error))
1824 if ((ret = recv (socket->priv->fd, buffer, size, 0)) < 0)
1826 int errsv = get_socket_errno ();
1833 #ifdef WSAEWOULDBLOCK
1834 if (errsv == WSAEWOULDBLOCK)
1837 if (errsv == EWOULDBLOCK ||
1843 win32_unset_event_mask (socket, FD_READ);
1845 g_set_error (error, G_IO_ERROR,
1846 socket_io_error_from_errno (errsv),
1847 _("Error receiving data: %s"), socket_strerror (errsv));
1851 win32_unset_event_mask (socket, FD_READ);
1860 * g_socket_receive_from:
1861 * @socket: a #GSocket
1862 * @address: a pointer to a #GSocketAddress pointer, or %NULL
1863 * @buffer: a buffer to read data into (which should be at least @size
1865 * @size: the number of bytes you want to read from the socket
1866 * @cancellable: a %GCancellable or %NULL
1867 * @error: #GError for error reporting, or %NULL to ignore.
1869 * Receive data (up to @size bytes) from a socket.
1871 * If @address is non-%NULL then @address will be set equal to the
1872 * source address of the received packet.
1873 * @address is owned by the caller.
1875 * See g_socket_receive() for additional information.
1877 * Returns: Number of bytes read, or -1 on error
1882 g_socket_receive_from (GSocket *socket,
1883 GSocketAddress **address,
1886 GCancellable *cancellable,
1894 return g_socket_receive_message (socket,
1902 /* Although we ignore SIGPIPE, gdb will still stop if the app receives
1903 * one, which can be confusing and annoying. So if possible, we want
1904 * to suppress the signal entirely.
1907 #define G_SOCKET_DEFAULT_SEND_FLAGS MSG_NOSIGNAL
1909 #define G_SOCKET_DEFAULT_SEND_FLAGS 0
1914 * @socket: a #GSocket
1915 * @buffer: the buffer containing the data to send.
1916 * @size: the number of bytes to send
1917 * @cancellable: a %GCancellable or %NULL
1918 * @error: #GError for error reporting, or %NULL to ignore.
1920 * Tries to send @size bytes from @buffer on the socket. This is
1921 * mainly used by connection-oriented sockets; it is identical to
1922 * g_socket_send_to() with @address set to %NULL.
1924 * If the socket is in blocking mode the call will block until there is
1925 * space for the data in the socket queue. If there is no space available
1926 * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
1927 * will be returned. To be notified when space is available, wait for the
1928 * %G_IO_OUT condition. Note though that you may still receive
1929 * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
1930 * notified of a %G_IO_OUT condition. (On Windows in particular, this is
1931 * very common due to the way the underlying APIs work.)
1933 * On error -1 is returned and @error is set accordingly.
1935 * Returns: Number of bytes written (which may be less than @size), or -1
1941 g_socket_send (GSocket *socket,
1942 const gchar *buffer,
1944 GCancellable *cancellable,
1947 return g_socket_send_with_blocking (socket, buffer, size,
1948 socket->priv->blocking,
1949 cancellable, error);
1953 * g_socket_send_with_blocking:
1954 * @socket: a #GSocket
1955 * @buffer: the buffer containing the data to send.
1956 * @size: the number of bytes to send
1957 * @blocking: whether to do blocking or non-blocking I/O
1958 * @cancellable: a %GCancellable or %NULL
1959 * @error: #GError for error reporting, or %NULL to ignore.
1961 * This behaves exactly the same as g_socket_send(), except that
1962 * the choice of blocking or non-blocking behavior is determined by
1963 * the @blocking argument rather than by @socket's properties.
1965 * Returns: Number of bytes written (which may be less than @size), or -1
1971 g_socket_send_with_blocking (GSocket *socket,
1972 const gchar *buffer,
1975 GCancellable *cancellable,
1980 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
1982 if (!check_socket (socket, error))
1985 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1991 !g_socket_condition_wait (socket,
1992 G_IO_OUT, cancellable, error))
1995 if ((ret = send (socket->priv->fd, buffer, size, G_SOCKET_DEFAULT_SEND_FLAGS)) < 0)
1997 int errsv = get_socket_errno ();
2002 #ifdef WSAEWOULDBLOCK
2003 if (errsv == WSAEWOULDBLOCK)
2004 win32_unset_event_mask (socket, FD_WRITE);
2009 #ifdef WSAEWOULDBLOCK
2010 if (errsv == WSAEWOULDBLOCK)
2013 if (errsv == EWOULDBLOCK ||
2019 g_set_error (error, G_IO_ERROR,
2020 socket_io_error_from_errno (errsv),
2021 _("Error sending data: %s"), socket_strerror (errsv));
2032 * @socket: a #GSocket
2033 * @address: a #GSocketAddress, or %NULL
2034 * @buffer: the buffer containing the data to send.
2035 * @size: the number of bytes to send
2036 * @cancellable: a %GCancellable or %NULL
2037 * @error: #GError for error reporting, or %NULL to ignore.
2039 * Tries to send @size bytes from @buffer to @address. If @address is
2040 * %NULL then the message is sent to the default receiver (set by
2041 * g_socket_connect()).
2043 * See g_socket_send() for additional information.
2045 * Returns: Number of bytes written (which may be less than @size), or -1
2051 g_socket_send_to (GSocket *socket,
2052 GSocketAddress *address,
2053 const gchar *buffer,
2055 GCancellable *cancellable,
2063 return g_socket_send_message (socket,
2073 * g_socket_shutdown:
2074 * @socket: a #GSocket
2075 * @shutdown_read: whether to shut down the read side
2076 * @shutdown_write: whether to shut down the write side
2077 * @error: #GError for error reporting, or %NULL to ignore.
2079 * Shut down part of a full-duplex connection.
2081 * If @shutdown_read is %TRUE then the recieving side of the connection
2082 * is shut down, and further reading is disallowed.
2084 * If @shutdown_write is %TRUE then the sending side of the connection
2085 * is shut down, and further writing is disallowed.
2087 * It is allowed for both @shutdown_read and @shutdown_write to be %TRUE.
2089 * One example where this is used is graceful disconnect for TCP connections
2090 * where you close the sending side, then wait for the other side to close
2091 * the connection, thus ensuring that the other side saw all sent data.
2093 * Returns: %TRUE on success, %FALSE on error
2098 g_socket_shutdown (GSocket *socket,
2099 gboolean shutdown_read,
2100 gboolean shutdown_write,
2105 g_return_val_if_fail (G_IS_SOCKET (socket), TRUE);
2107 if (!check_socket (socket, NULL))
2111 if (!shutdown_read && !shutdown_write)
2115 if (shutdown_read && shutdown_write)
2117 else if (shutdown_read)
2122 if (shutdown_read && shutdown_write)
2124 else if (shutdown_read)
2130 if (shutdown (socket->priv->fd, how) != 0)
2132 int errsv = get_socket_errno ();
2133 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
2134 _("Unable to create socket: %s"), socket_strerror (errsv));
2138 if (shutdown_read && shutdown_write)
2139 socket->priv->connected = FALSE;
2146 * @socket: a #GSocket
2147 * @error: #GError for error reporting, or %NULL to ignore.
2149 * Closes the socket, shutting down any active connection.
2151 * Closing a socket does not wait for all outstanding I/O operations
2152 * to finish, so the caller should not rely on them to be guaranteed
2153 * to complete even if the close returns with no error.
2155 * Once the socket is closed, all other operations will return
2156 * %G_IO_ERROR_CLOSED. Closing a socket multiple times will not
2159 * Sockets will be automatically closed when the last reference
2160 * is dropped, but you might want to call this function to make sure
2161 * resources are released as early as possible.
2163 * Beware that due to the way that TCP works, it is possible for
2164 * recently-sent data to be lost if either you close a socket while the
2165 * %G_IO_IN condition is set, or else if the remote connection tries to
2166 * send something to you after you close the socket but before it has
2167 * finished reading all of the data you sent. There is no easy generic
2168 * way to avoid this problem; the easiest fix is to design the network
2169 * protocol such that the client will never send data "out of turn".
2170 * Another solution is for the server to half-close the connection by
2171 * calling g_socket_shutdown() with only the @shutdown_write flag set,
2172 * and then wait for the client to notice this and close its side of the
2173 * connection, after which the server can safely call g_socket_close().
2174 * (This is what #GTcpConnection does if you call
2175 * g_tcp_connection_set_graceful_disconnect(). But of course, this
2176 * only works if the client will close its connection after the server
2179 * Returns: %TRUE on success, %FALSE on error
2184 g_socket_close (GSocket *socket,
2189 g_return_val_if_fail (G_IS_SOCKET (socket), TRUE);
2191 if (socket->priv->closed)
2192 return TRUE; /* Multiple close not an error */
2194 if (!check_socket (socket, NULL))
2200 res = closesocket (socket->priv->fd);
2202 res = close (socket->priv->fd);
2206 int errsv = get_socket_errno ();
2211 g_set_error (error, G_IO_ERROR,
2212 socket_io_error_from_errno (errsv),
2213 _("Error closing socket: %s"),
2214 socket_strerror (errsv));
2220 socket->priv->connected = FALSE;
2221 socket->priv->closed = TRUE;
2222 if (socket->priv->remote_address)
2224 g_object_unref (socket->priv->remote_address);
2225 socket->priv->remote_address = NULL;
2232 * g_socket_is_closed:
2233 * @socket: a #GSocket
2235 * Checks whether a socket is closed.
2237 * Returns: %TRUE if socket is closed, %FALSE otherwise
2242 g_socket_is_closed (GSocket *socket)
2244 return socket->priv->closed;
2248 /* Broken source, used on errors */
2250 broken_prepare (GSource *source,
2257 broken_check (GSource *source)
2263 broken_dispatch (GSource *source,
2264 GSourceFunc callback,
2270 static GSourceFuncs broken_funcs =
2279 network_events_for_condition (GIOCondition condition)
2283 if (condition & G_IO_IN)
2284 event_mask |= (FD_READ | FD_ACCEPT);
2285 if (condition & G_IO_OUT)
2286 event_mask |= (FD_WRITE | FD_CONNECT);
2287 event_mask |= FD_CLOSE;
2293 ensure_event (GSocket *socket)
2295 if (socket->priv->event == WSA_INVALID_EVENT)
2296 socket->priv->event = WSACreateEvent();
2300 update_select_events (GSocket *socket)
2307 ensure_event (socket);
2310 for (l = socket->priv->requested_conditions; l != NULL; l = l->next)
2313 event_mask |= network_events_for_condition (*ptr);
2316 if (event_mask != socket->priv->selected_events)
2318 /* If no events selected, disable event so we can unset
2321 if (event_mask == 0)
2324 event = socket->priv->event;
2326 if (WSAEventSelect (socket->priv->fd, event, event_mask) == 0)
2327 socket->priv->selected_events = event_mask;
2332 add_condition_watch (GSocket *socket,
2333 GIOCondition *condition)
2335 g_assert (g_list_find (socket->priv->requested_conditions, condition) == NULL);
2337 socket->priv->requested_conditions =
2338 g_list_prepend (socket->priv->requested_conditions, condition);
2340 update_select_events (socket);
2344 remove_condition_watch (GSocket *socket,
2345 GIOCondition *condition)
2347 g_assert (g_list_find (socket->priv->requested_conditions, condition) != NULL);
2349 socket->priv->requested_conditions =
2350 g_list_remove (socket->priv->requested_conditions, condition);
2352 update_select_events (socket);
2356 update_condition (GSocket *socket)
2358 WSANETWORKEVENTS events;
2359 GIOCondition condition;
2361 if (WSAEnumNetworkEvents (socket->priv->fd,
2362 socket->priv->event,
2365 socket->priv->current_events |= events.lNetworkEvents;
2366 if (events.lNetworkEvents & FD_WRITE &&
2367 events.iErrorCode[FD_WRITE_BIT] != 0)
2368 socket->priv->current_errors |= FD_WRITE;
2369 if (events.lNetworkEvents & FD_CONNECT &&
2370 events.iErrorCode[FD_CONNECT_BIT] != 0)
2371 socket->priv->current_errors |= FD_CONNECT;
2375 if (socket->priv->current_events & (FD_READ | FD_ACCEPT))
2376 condition |= G_IO_IN;
2378 if (socket->priv->current_events & FD_CLOSE ||
2379 socket->priv->closed)
2380 condition |= G_IO_HUP;
2382 /* Never report both G_IO_OUT and HUP, these are
2383 mutually exclusive (can't write to a closed socket) */
2384 if ((condition & G_IO_HUP) == 0 &&
2385 socket->priv->current_events & FD_WRITE)
2387 if (socket->priv->current_errors & FD_WRITE)
2388 condition |= G_IO_ERR;
2390 condition |= G_IO_OUT;
2394 if (socket->priv->current_events & FD_CONNECT)
2396 if (socket->priv->current_errors & FD_CONNECT)
2397 condition |= (G_IO_HUP | G_IO_ERR);
2399 condition |= G_IO_OUT;
2411 GIOCondition condition;
2412 GCancellable *cancellable;
2413 GPollFD cancel_pollfd;
2414 gint64 timeout_time;
2418 socket_source_prepare (GSource *source,
2421 GSocketSource *socket_source = (GSocketSource *)source;
2423 if (g_cancellable_is_cancelled (socket_source->cancellable))
2426 if (socket_source->timeout_time)
2430 now = g_source_get_time (source);
2431 /* Round up to ensure that we don't try again too early */
2432 *timeout = (socket_source->timeout_time - now + 999) / 1000;
2435 socket_source->socket->priv->timed_out = TRUE;
2436 socket_source->pollfd.revents = socket_source->condition & (G_IO_IN | G_IO_OUT);
2445 socket_source->pollfd.revents = update_condition (socket_source->socket);
2448 if ((socket_source->condition & socket_source->pollfd.revents) != 0)
2455 socket_source_check (GSource *source)
2459 return socket_source_prepare (source, &timeout);
2463 socket_source_dispatch (GSource *source,
2464 GSourceFunc callback,
2467 GSocketSourceFunc func = (GSocketSourceFunc)callback;
2468 GSocketSource *socket_source = (GSocketSource *)source;
2470 return (*func) (socket_source->socket,
2471 socket_source->pollfd.revents & socket_source->condition,
2476 socket_source_finalize (GSource *source)
2478 GSocketSource *socket_source = (GSocketSource *)source;
2481 socket = socket_source->socket;
2484 remove_condition_watch (socket, &socket_source->condition);
2487 g_object_unref (socket);
2489 if (socket_source->cancellable)
2491 g_cancellable_release_fd (socket_source->cancellable);
2492 g_object_unref (socket_source->cancellable);
2496 static GSourceFuncs socket_source_funcs =
2498 socket_source_prepare,
2499 socket_source_check,
2500 socket_source_dispatch,
2501 socket_source_finalize
2505 socket_source_new (GSocket *socket,
2506 GIOCondition condition,
2507 GCancellable *cancellable)
2510 GSocketSource *socket_source;
2513 ensure_event (socket);
2515 if (socket->priv->event == WSA_INVALID_EVENT)
2517 g_warning ("Failed to create WSAEvent");
2518 return g_source_new (&broken_funcs, sizeof (GSource));
2522 condition |= G_IO_HUP | G_IO_ERR;
2524 source = g_source_new (&socket_source_funcs, sizeof (GSocketSource));
2525 g_source_set_name (source, "GSocket");
2526 socket_source = (GSocketSource *)source;
2528 socket_source->socket = g_object_ref (socket);
2529 socket_source->condition = condition;
2531 if (g_cancellable_make_pollfd (cancellable,
2532 &socket_source->cancel_pollfd))
2534 socket_source->cancellable = g_object_ref (cancellable);
2535 g_source_add_poll (source, &socket_source->cancel_pollfd);
2539 add_condition_watch (socket, &socket_source->condition);
2540 socket_source->pollfd.fd = (gintptr) socket->priv->event;
2542 socket_source->pollfd.fd = socket->priv->fd;
2545 socket_source->pollfd.events = condition;
2546 socket_source->pollfd.revents = 0;
2547 g_source_add_poll (source, &socket_source->pollfd);
2549 if (socket->priv->timeout)
2550 socket_source->timeout_time = g_get_monotonic_time () +
2551 socket->priv->timeout * 1000000;
2554 socket_source->timeout_time = 0;
2560 * g_socket_create_source:
2561 * @socket: a #GSocket
2562 * @condition: a #GIOCondition mask to monitor
2563 * @cancellable: a %GCancellable or %NULL
2565 * Creates a %GSource that can be attached to a %GMainContext to monitor
2566 * for the availibility of the specified @condition on the socket.
2568 * The callback on the source is of the #GSocketSourceFunc type.
2570 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in @condition;
2571 * these conditions will always be reported output if they are true.
2573 * @cancellable if not %NULL can be used to cancel the source, which will
2574 * cause the source to trigger, reporting the current condition (which
2575 * is likely 0 unless cancellation happened at the same time as a
2576 * condition change). You can check for this in the callback using
2577 * g_cancellable_is_cancelled().
2579 * If @socket has a timeout set, and it is reached before @condition
2580 * occurs, the source will then trigger anyway, reporting %G_IO_IN or
2581 * %G_IO_OUT depending on @condition. However, @socket will have been
2582 * marked as having had a timeout, and so the next #GSocket I/O method
2583 * you call will then fail with a %G_IO_ERROR_TIMED_OUT.
2585 * Returns: (transfer full): a newly allocated %GSource, free with g_source_unref().
2590 g_socket_create_source (GSocket *socket,
2591 GIOCondition condition,
2592 GCancellable *cancellable)
2594 g_return_val_if_fail (G_IS_SOCKET (socket) && (cancellable == NULL || G_IS_CANCELLABLE (cancellable)), NULL);
2596 return socket_source_new (socket, condition, cancellable);
2600 * g_socket_condition_check:
2601 * @socket: a #GSocket
2602 * @condition: a #GIOCondition mask to check
2604 * Checks on the readiness of @socket to perform operations.
2605 * The operations specified in @condition are checked for and masked
2606 * against the currently-satisfied conditions on @socket. The result
2609 * Note that on Windows, it is possible for an operation to return
2610 * %G_IO_ERROR_WOULD_BLOCK even immediately after
2611 * g_socket_condition_check() has claimed that the socket is ready for
2612 * writing. Rather than calling g_socket_condition_check() and then
2613 * writing to the socket if it succeeds, it is generally better to
2614 * simply try writing to the socket right away, and try again later if
2615 * the initial attempt returns %G_IO_ERROR_WOULD_BLOCK.
2617 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition;
2618 * these conditions will always be set in the output if they are true.
2620 * This call never blocks.
2622 * Returns: the @GIOCondition mask of the current state
2627 g_socket_condition_check (GSocket *socket,
2628 GIOCondition condition)
2630 if (!check_socket (socket, NULL))
2635 GIOCondition current_condition;
2637 condition |= G_IO_ERR | G_IO_HUP;
2639 add_condition_watch (socket, &condition);
2640 current_condition = update_condition (socket);
2641 remove_condition_watch (socket, &condition);
2642 return condition & current_condition;
2648 poll_fd.fd = socket->priv->fd;
2649 poll_fd.events = condition;
2652 result = g_poll (&poll_fd, 1, 0);
2653 while (result == -1 && get_socket_errno () == EINTR);
2655 return poll_fd.revents;
2661 * g_socket_condition_wait:
2662 * @socket: a #GSocket
2663 * @condition: a #GIOCondition mask to wait for
2664 * @cancellable: a #GCancellable, or %NULL
2665 * @error: a #GError pointer, or %NULL
2667 * Waits for @condition to become true on @socket. When the condition
2668 * is met, %TRUE is returned.
2670 * If @cancellable is cancelled before the condition is met, or if the
2671 * socket has a timeout set and it is reached before the condition is
2672 * met, then %FALSE is returned and @error, if non-%NULL, is set to
2673 * the appropriate value (%G_IO_ERROR_CANCELLED or
2674 * %G_IO_ERROR_TIMED_OUT).
2676 * Returns: %TRUE if the condition was met, %FALSE otherwise
2681 g_socket_condition_wait (GSocket *socket,
2682 GIOCondition condition,
2683 GCancellable *cancellable,
2686 if (!check_socket (socket, error))
2689 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2694 GIOCondition current_condition;
2700 /* Always check these */
2701 condition |= G_IO_ERR | G_IO_HUP;
2703 add_condition_watch (socket, &condition);
2706 events[num_events++] = socket->priv->event;
2708 if (g_cancellable_make_pollfd (cancellable, &cancel_fd))
2709 events[num_events++] = (WSAEVENT)cancel_fd.fd;
2711 if (socket->priv->timeout)
2712 timeout = socket->priv->timeout * 1000;
2714 timeout = WSA_INFINITE;
2716 current_condition = update_condition (socket);
2717 while ((condition & current_condition) == 0)
2719 res = WSAWaitForMultipleEvents(num_events, events,
2720 FALSE, timeout, FALSE);
2721 if (res == WSA_WAIT_FAILED)
2723 int errsv = get_socket_errno ();
2725 g_set_error (error, G_IO_ERROR,
2726 socket_io_error_from_errno (errsv),
2727 _("Waiting for socket condition: %s"),
2728 socket_strerror (errsv));
2731 else if (res == WSA_WAIT_TIMEOUT)
2733 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
2734 _("Socket I/O timed out"));
2738 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2741 current_condition = update_condition (socket);
2743 remove_condition_watch (socket, &condition);
2745 g_cancellable_release_fd (cancellable);
2747 return (condition & current_condition) != 0;
2756 poll_fd[0].fd = socket->priv->fd;
2757 poll_fd[0].events = condition;
2760 if (g_cancellable_make_pollfd (cancellable, &poll_fd[1]))
2763 if (socket->priv->timeout)
2764 timeout = socket->priv->timeout * 1000;
2769 result = g_poll (poll_fd, num, timeout);
2770 while (result == -1 && get_socket_errno () == EINTR);
2773 g_cancellable_release_fd (cancellable);
2777 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
2778 _("Socket I/O timed out"));
2782 return !g_cancellable_set_error_if_cancelled (cancellable, error);
2788 * g_socket_send_message:
2789 * @socket: a #GSocket
2790 * @address: a #GSocketAddress, or %NULL
2791 * @vectors: an array of #GOutputVector structs
2792 * @num_vectors: the number of elements in @vectors, or -1
2793 * @messages: a pointer to an array of #GSocketControlMessages, or
2795 * @num_messages: number of elements in @messages, or -1.
2796 * @flags: an int containing #GSocketMsgFlags flags
2797 * @cancellable: a %GCancellable or %NULL
2798 * @error: #GError for error reporting, or %NULL to ignore.
2800 * Send data to @address on @socket. This is the most complicated and
2801 * fully-featured version of this call. For easier use, see
2802 * g_socket_send() and g_socket_send_to().
2804 * If @address is %NULL then the message is sent to the default receiver
2805 * (set by g_socket_connect()).
2807 * @vectors must point to an array of #GOutputVector structs and
2808 * @num_vectors must be the length of this array. (If @num_vectors is -1,
2809 * then @vectors is assumed to be terminated by a #GOutputVector with a
2810 * %NULL buffer pointer.) The #GOutputVector structs describe the buffers
2811 * that the sent data will be gathered from. Using multiple
2812 * #GOutputVector<!-- -->s is more memory-efficient than manually copying
2813 * data from multiple sources into a single buffer, and more
2814 * network-efficient than making multiple calls to g_socket_send().
2816 * @messages, if non-%NULL, is taken to point to an array of @num_messages
2817 * #GSocketControlMessage instances. These correspond to the control
2818 * messages to be sent on the socket.
2819 * If @num_messages is -1 then @messages is treated as a %NULL-terminated
2822 * @flags modify how the message is sent. The commonly available arguments
2823 * for this are available in the #GSocketMsgFlags enum, but the
2824 * values there are the same as the system values, and the flags
2825 * are passed in as-is, so you can pass in system-specific flags too.
2827 * If the socket is in blocking mode the call will block until there is
2828 * space for the data in the socket queue. If there is no space available
2829 * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
2830 * will be returned. To be notified when space is available, wait for the
2831 * %G_IO_OUT condition. Note though that you may still receive
2832 * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
2833 * notified of a %G_IO_OUT condition. (On Windows in particular, this is
2834 * very common due to the way the underlying APIs work.)
2836 * On error -1 is returned and @error is set accordingly.
2838 * Returns: Number of bytes written (which may be less than @size), or -1
2844 g_socket_send_message (GSocket *socket,
2845 GSocketAddress *address,
2846 GOutputVector *vectors,
2848 GSocketControlMessage **messages,
2851 GCancellable *cancellable,
2854 GOutputVector one_vector;
2857 if (!check_socket (socket, error))
2860 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2863 if (num_vectors == -1)
2865 for (num_vectors = 0;
2866 vectors[num_vectors].buffer != NULL;
2871 if (num_messages == -1)
2873 for (num_messages = 0;
2874 messages != NULL && messages[num_messages] != NULL;
2879 if (num_vectors == 0)
2883 one_vector.buffer = &zero;
2884 one_vector.size = 1;
2886 vectors = &one_vector;
2899 msg.msg_namelen = g_socket_address_get_native_size (address);
2900 msg.msg_name = g_alloca (msg.msg_namelen);
2901 if (!g_socket_address_to_native (address, msg.msg_name, msg.msg_namelen, error))
2906 msg.msg_name = NULL;
2907 msg.msg_namelen = 0;
2912 /* this entire expression will be evaluated at compile time */
2913 if (sizeof *msg.msg_iov == sizeof *vectors &&
2914 sizeof msg.msg_iov->iov_base == sizeof vectors->buffer &&
2915 G_STRUCT_OFFSET (struct iovec, iov_base) ==
2916 G_STRUCT_OFFSET (GOutputVector, buffer) &&
2917 sizeof msg.msg_iov->iov_len == sizeof vectors->size &&
2918 G_STRUCT_OFFSET (struct iovec, iov_len) ==
2919 G_STRUCT_OFFSET (GOutputVector, size))
2920 /* ABI is compatible */
2922 msg.msg_iov = (struct iovec *) vectors;
2923 msg.msg_iovlen = num_vectors;
2926 /* ABI is incompatible */
2930 msg.msg_iov = g_newa (struct iovec, num_vectors);
2931 for (i = 0; i < num_vectors; i++)
2933 msg.msg_iov[i].iov_base = (void *) vectors[i].buffer;
2934 msg.msg_iov[i].iov_len = vectors[i].size;
2936 msg.msg_iovlen = num_vectors;
2942 struct cmsghdr *cmsg;
2945 msg.msg_controllen = 0;
2946 for (i = 0; i < num_messages; i++)
2947 msg.msg_controllen += CMSG_SPACE (g_socket_control_message_get_size (messages[i]));
2949 if (msg.msg_controllen == 0)
2950 msg.msg_control = NULL;
2953 msg.msg_control = g_alloca (msg.msg_controllen);
2954 memset (msg.msg_control, '\0', msg.msg_controllen);
2957 cmsg = CMSG_FIRSTHDR (&msg);
2958 for (i = 0; i < num_messages; i++)
2960 cmsg->cmsg_level = g_socket_control_message_get_level (messages[i]);
2961 cmsg->cmsg_type = g_socket_control_message_get_msg_type (messages[i]);
2962 cmsg->cmsg_len = CMSG_LEN (g_socket_control_message_get_size (messages[i]));
2963 g_socket_control_message_serialize (messages[i],
2965 cmsg = CMSG_NXTHDR (&msg, cmsg);
2967 g_assert (cmsg == NULL);
2972 if (socket->priv->blocking &&
2973 !g_socket_condition_wait (socket,
2974 G_IO_OUT, cancellable, error))
2977 result = sendmsg (socket->priv->fd, &msg, flags | G_SOCKET_DEFAULT_SEND_FLAGS);
2980 int errsv = get_socket_errno ();
2985 if (socket->priv->blocking &&
2986 (errsv == EWOULDBLOCK ||
2990 g_set_error (error, G_IO_ERROR,
2991 socket_io_error_from_errno (errsv),
2992 _("Error sending message: %s"), socket_strerror (errsv));
3003 struct sockaddr_storage addr;
3010 /* Win32 doesn't support control messages.
3011 Actually this is possible for raw and datagram sockets
3012 via WSASendMessage on Vista or later, but that doesn't
3014 if (num_messages != 0)
3016 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3017 _("GSocketControlMessage not supported on windows"));
3022 bufs = g_newa (WSABUF, num_vectors);
3023 for (i = 0; i < num_vectors; i++)
3025 bufs[i].buf = (char *)vectors[i].buffer;
3026 bufs[i].len = (gulong)vectors[i].size;
3030 addrlen = 0; /* Avoid warning */
3033 addrlen = g_socket_address_get_native_size (address);
3034 if (!g_socket_address_to_native (address, &addr, sizeof addr, error))
3040 if (socket->priv->blocking &&
3041 !g_socket_condition_wait (socket,
3042 G_IO_OUT, cancellable, error))
3046 result = WSASendTo (socket->priv->fd,
3049 (const struct sockaddr *)&addr, addrlen,
3052 result = WSASend (socket->priv->fd,
3059 int errsv = get_socket_errno ();
3061 if (errsv == WSAEINTR)
3064 if (errsv == WSAEWOULDBLOCK)
3065 win32_unset_event_mask (socket, FD_WRITE);
3067 if (socket->priv->blocking &&
3068 errsv == WSAEWOULDBLOCK)
3071 g_set_error (error, G_IO_ERROR,
3072 socket_io_error_from_errno (errsv),
3073 _("Error sending message: %s"), socket_strerror (errsv));
3086 * g_socket_receive_message:
3087 * @socket: a #GSocket
3088 * @address: a pointer to a #GSocketAddress pointer, or %NULL
3089 * @vectors: an array of #GInputVector structs
3090 * @num_vectors: the number of elements in @vectors, or -1
3091 * @messages: a pointer which may be filled with an array of
3092 * #GSocketControlMessages, or %NULL
3093 * @num_messages: a pointer which will be filled with the number of
3094 * elements in @messages, or %NULL
3095 * @flags: a pointer to an int containing #GSocketMsgFlags flags
3096 * @cancellable: a %GCancellable or %NULL
3097 * @error: a #GError pointer, or %NULL
3099 * Receive data from a socket. This is the most complicated and
3100 * fully-featured version of this call. For easier use, see
3101 * g_socket_receive() and g_socket_receive_from().
3103 * If @address is non-%NULL then @address will be set equal to the
3104 * source address of the received packet.
3105 * @address is owned by the caller.
3107 * @vector must point to an array of #GInputVector structs and
3108 * @num_vectors must be the length of this array. These structs
3109 * describe the buffers that received data will be scattered into.
3110 * If @num_vectors is -1, then @vectors is assumed to be terminated
3111 * by a #GInputVector with a %NULL buffer pointer.
3113 * As a special case, if @num_vectors is 0 (in which case, @vectors
3114 * may of course be %NULL), then a single byte is received and
3115 * discarded. This is to facilitate the common practice of sending a
3116 * single '\0' byte for the purposes of transferring ancillary data.
3118 * @messages, if non-%NULL, will be set to point to a newly-allocated
3119 * array of #GSocketControlMessage instances or %NULL if no such
3120 * messages was received. These correspond to the control messages
3121 * received from the kernel, one #GSocketControlMessage per message
3122 * from the kernel. This array is %NULL-terminated and must be freed
3123 * by the caller using g_free() after calling g_object_unref() on each
3124 * element. If @messages is %NULL, any control messages received will
3127 * @num_messages, if non-%NULL, will be set to the number of control
3128 * messages received.
3130 * If both @messages and @num_messages are non-%NULL, then
3131 * @num_messages gives the number of #GSocketControlMessage instances
3132 * in @messages (ie: not including the %NULL terminator).
3134 * @flags is an in/out parameter. The commonly available arguments
3135 * for this are available in the #GSocketMsgFlags enum, but the
3136 * values there are the same as the system values, and the flags
3137 * are passed in as-is, so you can pass in system-specific flags too
3138 * (and g_socket_receive_message() may pass system-specific flags out).
3140 * As with g_socket_receive(), data may be discarded if @socket is
3141 * %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not
3142 * provide enough buffer space to read a complete message. You can pass
3143 * %G_SOCKET_MSG_PEEK in @flags to peek at the current message without
3144 * removing it from the receive queue, but there is no portable way to find
3145 * out the length of the message other than by reading it into a
3146 * sufficiently-large buffer.
3148 * If the socket is in blocking mode the call will block until there
3149 * is some data to receive or there is an error. If there is no data
3150 * available and the socket is in non-blocking mode, a
3151 * %G_IO_ERROR_WOULD_BLOCK error will be returned. To be notified when
3152 * data is available, wait for the %G_IO_IN condition.
3154 * On error -1 is returned and @error is set accordingly.
3156 * Returns: Number of bytes read, or -1 on error
3161 g_socket_receive_message (GSocket *socket,
3162 GSocketAddress **address,
3163 GInputVector *vectors,
3165 GSocketControlMessage ***messages,
3168 GCancellable *cancellable,
3171 GInputVector one_vector;
3174 if (!check_socket (socket, error))
3177 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3180 if (num_vectors == -1)
3182 for (num_vectors = 0;
3183 vectors[num_vectors].buffer != NULL;
3188 if (num_vectors == 0)
3190 one_vector.buffer = &one_byte;
3191 one_vector.size = 1;
3193 vectors = &one_vector;
3200 struct sockaddr_storage one_sockaddr;
3205 msg.msg_name = &one_sockaddr;
3206 msg.msg_namelen = sizeof (struct sockaddr_storage);
3210 msg.msg_name = NULL;
3211 msg.msg_namelen = 0;
3215 /* this entire expression will be evaluated at compile time */
3216 if (sizeof *msg.msg_iov == sizeof *vectors &&
3217 sizeof msg.msg_iov->iov_base == sizeof vectors->buffer &&
3218 G_STRUCT_OFFSET (struct iovec, iov_base) ==
3219 G_STRUCT_OFFSET (GInputVector, buffer) &&
3220 sizeof msg.msg_iov->iov_len == sizeof vectors->size &&
3221 G_STRUCT_OFFSET (struct iovec, iov_len) ==
3222 G_STRUCT_OFFSET (GInputVector, size))
3223 /* ABI is compatible */
3225 msg.msg_iov = (struct iovec *) vectors;
3226 msg.msg_iovlen = num_vectors;
3229 /* ABI is incompatible */
3233 msg.msg_iov = g_newa (struct iovec, num_vectors);
3234 for (i = 0; i < num_vectors; i++)
3236 msg.msg_iov[i].iov_base = vectors[i].buffer;
3237 msg.msg_iov[i].iov_len = vectors[i].size;
3239 msg.msg_iovlen = num_vectors;
3243 msg.msg_control = g_alloca (2048);
3244 msg.msg_controllen = 2048;
3248 msg.msg_flags = *flags;
3255 if (socket->priv->blocking &&
3256 !g_socket_condition_wait (socket,
3257 G_IO_IN, cancellable, error))
3260 result = recvmsg (socket->priv->fd, &msg, msg.msg_flags);
3264 int errsv = get_socket_errno ();
3269 if (socket->priv->blocking &&
3270 (errsv == EWOULDBLOCK ||
3274 g_set_error (error, G_IO_ERROR,
3275 socket_io_error_from_errno (errsv),
3276 _("Error receiving message: %s"), socket_strerror (errsv));
3283 /* decode address */
3284 if (address != NULL)
3286 if (msg.msg_namelen > 0)
3287 *address = g_socket_address_new_from_native (msg.msg_name,
3293 /* decode control messages */
3295 GPtrArray *my_messages = NULL;
3296 const gchar *scm_pointer;
3297 struct cmsghdr *cmsg;
3300 scm_pointer = (const gchar *) msg.msg_control;
3301 scm_size = msg.msg_controllen;
3303 for (cmsg = CMSG_FIRSTHDR (&msg); cmsg; cmsg = CMSG_NXTHDR (&msg, cmsg))
3305 GSocketControlMessage *message;
3307 message = g_socket_control_message_deserialize (cmsg->cmsg_level,
3309 cmsg->cmsg_len - ((char *)CMSG_DATA (cmsg) - (char *)cmsg),
3311 if (message == NULL)
3312 /* We've already spewed about the problem in the
3313 deserialization code, so just continue */
3316 if (messages == NULL)
3318 /* we have to do it this way if the user ignores the
3319 * messages so that we will close any received fds.
3321 g_object_unref (message);
3325 if (my_messages == NULL)
3326 my_messages = g_ptr_array_new ();
3327 g_ptr_array_add (my_messages, message);
3332 *num_messages = my_messages != NULL ? my_messages->len : 0;
3336 if (my_messages == NULL)
3342 g_ptr_array_add (my_messages, NULL);
3343 *messages = (GSocketControlMessage **) g_ptr_array_free (my_messages, FALSE);
3348 g_assert (my_messages == NULL);
3352 /* capture the flags */
3354 *flags = msg.msg_flags;
3360 struct sockaddr_storage addr;
3362 DWORD bytes_received;
3369 bufs = g_newa (WSABUF, num_vectors);
3370 for (i = 0; i < num_vectors; i++)
3372 bufs[i].buf = (char *)vectors[i].buffer;
3373 bufs[i].len = (gulong)vectors[i].size;
3385 if (socket->priv->blocking &&
3386 !g_socket_condition_wait (socket,
3387 G_IO_IN, cancellable, error))
3390 addrlen = sizeof addr;
3392 result = WSARecvFrom (socket->priv->fd,
3394 &bytes_received, &win_flags,
3395 (struct sockaddr *)&addr, &addrlen,
3398 result = WSARecv (socket->priv->fd,
3400 &bytes_received, &win_flags,
3404 int errsv = get_socket_errno ();
3406 if (errsv == WSAEINTR)
3409 win32_unset_event_mask (socket, FD_READ);
3411 if (socket->priv->blocking &&
3412 errsv == WSAEWOULDBLOCK)
3415 g_set_error (error, G_IO_ERROR,
3416 socket_io_error_from_errno (errsv),
3417 _("Error receiving message: %s"), socket_strerror (errsv));
3421 win32_unset_event_mask (socket, FD_READ);
3425 /* decode address */
3426 if (address != NULL)
3429 *address = g_socket_address_new_from_native (&addr, addrlen);
3434 /* capture the flags */
3438 if (messages != NULL)
3440 if (num_messages != NULL)
3443 return bytes_received;
3449 * g_socket_get_credentials:
3450 * @socket: a #GSocket.
3451 * @error: #GError for error reporting, or %NULL to ignore.
3453 * Returns the credentials of the foreign process connected to this
3454 * socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX
3457 * If this operation isn't supported on the OS, the method fails with
3458 * the %G_IO_ERROR_NOT_SUPPORTED error. On Linux this is implemented
3459 * by reading the %SO_PEERCRED option on the underlying socket.
3461 * Other ways to obtain credentials from a foreign peer includes the
3462 * #GUnixCredentialsMessage type and
3463 * g_unix_connection_send_credentials() /
3464 * g_unix_connection_receive_credentials() functions.
3466 * Returns: (transfer full): %NULL if @error is set, otherwise a #GCredentials object
3467 * that must be freed with g_object_unref().
3472 g_socket_get_credentials (GSocket *socket,
3477 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
3478 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3484 struct ucred native_creds;
3486 optlen = sizeof (struct ucred);
3487 if (getsockopt (socket->priv->fd,
3490 (void *)&native_creds,
3493 int errsv = get_socket_errno ();
3496 socket_io_error_from_errno (errsv),
3497 _("Unable to get pending error: %s"),
3498 socket_strerror (errsv));
3502 ret = g_credentials_new ();
3503 g_credentials_set_native (ret,
3504 G_CREDENTIALS_TYPE_LINUX_UCRED,
3509 g_set_error_literal (error,
3511 G_IO_ERROR_NOT_SUPPORTED,
3512 _("g_socket_get_credentials not implemented for this OS"));