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 "gio-marshal.h"
54 #include "gnetworkingprivate.h"
55 #include "gsocketaddress.h"
56 #include "gsocketcontrolmessage.h"
57 #include "gcredentials.h"
62 * @short_description: Low-level socket object
64 * @see_also: #GInitable
66 * A #GSocket is a low-level networking primitive. It is a more or less
67 * direct mapping of the BSD socket API in a portable GObject based API.
68 * It supports both the UNIX socket implementations and winsock2 on Windows.
70 * #GSocket is the platform independent base upon which the higher level
71 * network primitives are based. Applications are not typically meant to
72 * use it directly, but rather through classes like #GSocketClient,
73 * #GSocketService and #GSocketConnection. However there may be cases where
74 * direct use of #GSocket is useful.
76 * #GSocket implements the #GInitable interface, so if it is manually constructed
77 * by e.g. g_object_new() you must call g_initable_init() and check the
78 * results before using the object. This is done automatically in
79 * g_socket_new() and g_socket_new_from_fd(), so these functions can return
82 * Sockets operate in two general modes, blocking or non-blocking. When
83 * in blocking mode all operations block until the requested operation
84 * is finished or there is an error. In non-blocking mode all calls that
85 * would block return immediately with a %G_IO_ERROR_WOULD_BLOCK error.
86 * To know when a call would successfully run you can call g_socket_condition_check(),
87 * or g_socket_condition_wait(). You can also use g_socket_create_source() and
88 * attach it to a #GMainContext to get callbacks when I/O is possible.
89 * Note that all sockets are always set to non blocking mode in the system, and
90 * blocking mode is emulated in GSocket.
92 * When working in non-blocking mode applications should always be able to
93 * handle getting a %G_IO_ERROR_WOULD_BLOCK error even when some other
94 * function said that I/O was possible. This can easily happen in case
95 * of a race condition in the application, but it can also happen for other
96 * reasons. For instance, on Windows a socket is always seen as writable
97 * until a write returns %G_IO_ERROR_WOULD_BLOCK.
99 * #GSocket<!-- -->s can be either connection oriented or datagram based.
100 * For connection oriented types you must first establish a connection by
101 * either connecting to an address or accepting a connection from another
102 * address. For connectionless socket types the target/source address is
103 * specified or received in each I/O operation.
105 * All socket file descriptors are set to be close-on-exec.
107 * Note that creating a #GSocket causes the signal %SIGPIPE to be
108 * ignored for the remainder of the program. If you are writing a
109 * command-line utility that uses #GSocket, you may need to take into
110 * account the fact that your program will not automatically be killed
111 * if it tries to write to %stdout after it has been closed.
116 static void g_socket_initable_iface_init (GInitableIface *iface);
117 static gboolean g_socket_initable_init (GInitable *initable,
118 GCancellable *cancellable,
121 G_DEFINE_TYPE_WITH_CODE (GSocket, g_socket, G_TYPE_OBJECT,
122 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE,
123 g_socket_initable_iface_init));
140 struct _GSocketPrivate
142 GSocketFamily family;
144 GSocketProtocol protocol;
148 GError *construct_error;
149 GSocketAddress *remote_address;
157 guint connect_pending : 1;
163 GList *requested_conditions; /* list of requested GIOCondition * */
168 get_socket_errno (void)
173 return WSAGetLastError ();
178 socket_io_error_from_errno (int err)
181 return g_io_error_from_errno (err);
186 return G_IO_ERROR_ADDRESS_IN_USE;
188 return G_IO_ERROR_WOULD_BLOCK;
190 return G_IO_ERROR_PERMISSION_DENIED;
191 case WSA_INVALID_HANDLE:
192 case WSA_INVALID_PARAMETER:
195 return G_IO_ERROR_INVALID_ARGUMENT;
196 case WSAEPROTONOSUPPORT:
197 return G_IO_ERROR_NOT_SUPPORTED;
199 return G_IO_ERROR_CANCELLED;
200 case WSAESOCKTNOSUPPORT:
202 case WSAEPFNOSUPPORT:
203 case WSAEAFNOSUPPORT:
204 return G_IO_ERROR_NOT_SUPPORTED;
206 return G_IO_ERROR_FAILED;
212 socket_strerror (int err)
215 return g_strerror (err);
217 static GStaticPrivate last_msg = G_STATIC_PRIVATE_INIT;
220 msg = g_win32_error_message (err);
221 g_static_private_set (&last_msg, msg, g_free);
228 #define win32_unset_event_mask(_socket, _mask) _win32_unset_event_mask (_socket, _mask)
230 _win32_unset_event_mask (GSocket *socket, int mask)
232 socket->priv->current_events &= ~mask;
233 socket->priv->current_errors &= ~mask;
236 #define win32_unset_event_mask(_socket, _mask)
240 set_fd_nonblocking (int fd)
249 if ((arg = fcntl (fd, F_GETFL, NULL)) < 0)
251 g_warning ("Error getting socket status flags: %s", socket_strerror (errno));
255 arg = arg | O_NONBLOCK;
257 if (fcntl (fd, F_SETFL, arg) < 0)
258 g_warning ("Error setting socket status flags: %s", socket_strerror (errno));
262 if (ioctlsocket (fd, FIONBIO, &arg) == SOCKET_ERROR)
264 int errsv = get_socket_errno ();
265 g_warning ("Error setting socket status flags: %s", socket_strerror (errsv));
271 check_socket (GSocket *socket,
274 if (!socket->priv->inited)
276 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_INITIALIZED,
277 _("Invalid socket, not initialized"));
281 if (socket->priv->construct_error)
283 g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_INITIALIZED,
284 _("Invalid socket, initialization failed due to: %s"),
285 socket->priv->construct_error->message);
289 if (socket->priv->closed)
291 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
292 _("Socket is already closed"));
296 if (socket->priv->timed_out)
298 socket->priv->timed_out = FALSE;
299 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
300 _("Socket I/O timed out"));
308 g_socket_details_from_fd (GSocket *socket)
310 struct sockaddr_storage address;
317 /* See bug #611756 */
318 BOOL bool_val = FALSE;
323 fd = socket->priv->fd;
324 optlen = sizeof value;
325 if (getsockopt (fd, SOL_SOCKET, SO_TYPE, (void *)&value, &optlen) != 0)
327 errsv = get_socket_errno ();
338 /* programmer error */
339 g_error ("creating GSocket from fd %d: %s\n",
340 fd, socket_strerror (errsv));
348 g_assert (optlen == sizeof value);
352 socket->priv->type = G_SOCKET_TYPE_STREAM;
356 socket->priv->type = G_SOCKET_TYPE_DATAGRAM;
360 socket->priv->type = G_SOCKET_TYPE_SEQPACKET;
364 socket->priv->type = G_SOCKET_TYPE_INVALID;
368 addrlen = sizeof address;
369 if (getsockname (fd, (struct sockaddr *) &address, &addrlen) != 0)
371 errsv = get_socket_errno ();
375 g_assert (G_STRUCT_OFFSET (struct sockaddr, sa_family) +
376 sizeof address.ss_family <= addrlen);
377 switch (address.ss_family)
379 case G_SOCKET_FAMILY_IPV4:
380 case G_SOCKET_FAMILY_IPV6:
381 socket->priv->family = address.ss_family;
382 switch (socket->priv->type)
384 case G_SOCKET_TYPE_STREAM:
385 socket->priv->protocol = G_SOCKET_PROTOCOL_TCP;
388 case G_SOCKET_TYPE_DATAGRAM:
389 socket->priv->protocol = G_SOCKET_PROTOCOL_UDP;
392 case G_SOCKET_TYPE_SEQPACKET:
393 socket->priv->protocol = G_SOCKET_PROTOCOL_SCTP;
401 case G_SOCKET_FAMILY_UNIX:
402 socket->priv->family = G_SOCKET_FAMILY_UNIX;
403 socket->priv->protocol = G_SOCKET_PROTOCOL_DEFAULT;
407 socket->priv->family = G_SOCKET_FAMILY_INVALID;
411 if (socket->priv->family != G_SOCKET_FAMILY_INVALID)
413 addrlen = sizeof address;
414 if (getpeername (fd, (struct sockaddr *) &address, &addrlen) >= 0)
415 socket->priv->connected = TRUE;
418 optlen = sizeof bool_val;
419 if (getsockopt (fd, SOL_SOCKET, SO_KEEPALIVE,
420 (void *)&bool_val, &optlen) == 0)
423 /* Experimentation indicates that the SO_KEEPALIVE value is
424 * actually a char on Windows, even if documentation claims it
425 * to be a BOOL which is a typedef for int. So this g_assert()
426 * fails. See bug #611756.
428 g_assert (optlen == sizeof bool_val);
430 socket->priv->keepalive = !!bool_val;
434 /* Can't read, maybe not supported, assume FALSE */
435 socket->priv->keepalive = FALSE;
441 g_set_error (&socket->priv->construct_error, G_IO_ERROR,
442 socket_io_error_from_errno (errsv),
443 _("creating GSocket from fd: %s"),
444 socket_strerror (errsv));
448 g_socket_create_socket (GSocketFamily family,
458 case G_SOCKET_TYPE_STREAM:
459 native_type = SOCK_STREAM;
462 case G_SOCKET_TYPE_DATAGRAM:
463 native_type = SOCK_DGRAM;
466 case G_SOCKET_TYPE_SEQPACKET:
467 native_type = SOCK_SEQPACKET;
471 g_assert_not_reached ();
476 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
477 _("Unable to create socket: %s"), _("Unknown protocol was specified"));
482 fd = socket (family, native_type | SOCK_CLOEXEC, protocol);
483 /* It's possible that libc has SOCK_CLOEXEC but the kernel does not */
484 if (fd < 0 && errno == EINVAL)
486 fd = socket (family, native_type, protocol);
490 int errsv = get_socket_errno ();
492 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
493 _("Unable to create socket: %s"), socket_strerror (errsv));
500 /* We always want to set close-on-exec to protect users. If you
501 need to so some weird inheritance to exec you can re-enable this
502 using lower level hacks with g_socket_get_fd(). */
503 flags = fcntl (fd, F_GETFD, 0);
505 (flags & FD_CLOEXEC) == 0)
508 fcntl (fd, F_SETFD, flags);
517 g_socket_constructed (GObject *object)
519 GSocket *socket = G_SOCKET (object);
521 if (socket->priv->fd >= 0)
522 /* create socket->priv info from the fd */
523 g_socket_details_from_fd (socket);
526 /* create the fd from socket->priv info */
527 socket->priv->fd = g_socket_create_socket (socket->priv->family,
529 socket->priv->protocol,
530 &socket->priv->construct_error);
532 /* Always use native nonblocking sockets, as
533 windows sets sockets to nonblocking automatically
534 in certain operations. This way we make things work
535 the same on all platforms */
536 if (socket->priv->fd != -1)
537 set_fd_nonblocking (socket->priv->fd);
541 g_socket_get_property (GObject *object,
546 GSocket *socket = G_SOCKET (object);
547 GSocketAddress *address;
552 g_value_set_enum (value, socket->priv->family);
556 g_value_set_enum (value, socket->priv->type);
560 g_value_set_enum (value, socket->priv->protocol);
564 g_value_set_int (value, socket->priv->fd);
568 g_value_set_boolean (value, socket->priv->blocking);
571 case PROP_LISTEN_BACKLOG:
572 g_value_set_int (value, socket->priv->listen_backlog);
576 g_value_set_boolean (value, socket->priv->keepalive);
579 case PROP_LOCAL_ADDRESS:
580 address = g_socket_get_local_address (socket, NULL);
581 g_value_take_object (value, address);
584 case PROP_REMOTE_ADDRESS:
585 address = g_socket_get_remote_address (socket, NULL);
586 g_value_take_object (value, address);
590 g_value_set_uint (value, socket->priv->timeout);
594 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
599 g_socket_set_property (GObject *object,
604 GSocket *socket = G_SOCKET (object);
609 socket->priv->family = g_value_get_enum (value);
613 socket->priv->type = g_value_get_enum (value);
617 socket->priv->protocol = g_value_get_enum (value);
621 socket->priv->fd = g_value_get_int (value);
625 g_socket_set_blocking (socket, g_value_get_boolean (value));
628 case PROP_LISTEN_BACKLOG:
629 g_socket_set_listen_backlog (socket, g_value_get_int (value));
633 g_socket_set_keepalive (socket, g_value_get_boolean (value));
637 g_socket_set_timeout (socket, g_value_get_uint (value));
641 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
646 g_socket_finalize (GObject *object)
648 GSocket *socket = G_SOCKET (object);
650 g_clear_error (&socket->priv->construct_error);
652 if (socket->priv->fd != -1 &&
653 !socket->priv->closed)
654 g_socket_close (socket, NULL);
656 if (socket->priv->remote_address)
657 g_object_unref (socket->priv->remote_address);
660 if (socket->priv->event != WSA_INVALID_EVENT)
662 WSACloseEvent (socket->priv->event);
663 socket->priv->event = WSA_INVALID_EVENT;
666 g_assert (socket->priv->requested_conditions == NULL);
669 if (G_OBJECT_CLASS (g_socket_parent_class)->finalize)
670 (*G_OBJECT_CLASS (g_socket_parent_class)->finalize) (object);
674 g_socket_class_init (GSocketClass *klass)
676 GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
679 /* Make sure winsock has been initialized */
680 type = g_inet_address_get_type ();
681 (type); /* To avoid -Wunused-but-set-variable */
684 /* There is no portable, thread-safe way to avoid having the process
685 * be killed by SIGPIPE when calling send() or sendmsg(), so we are
686 * forced to simply ignore the signal process-wide.
688 signal (SIGPIPE, SIG_IGN);
691 g_type_class_add_private (klass, sizeof (GSocketPrivate));
693 gobject_class->finalize = g_socket_finalize;
694 gobject_class->constructed = g_socket_constructed;
695 gobject_class->set_property = g_socket_set_property;
696 gobject_class->get_property = g_socket_get_property;
698 g_object_class_install_property (gobject_class, PROP_FAMILY,
699 g_param_spec_enum ("family",
701 P_("The sockets address family"),
702 G_TYPE_SOCKET_FAMILY,
703 G_SOCKET_FAMILY_INVALID,
704 G_PARAM_CONSTRUCT_ONLY |
706 G_PARAM_STATIC_STRINGS));
708 g_object_class_install_property (gobject_class, PROP_TYPE,
709 g_param_spec_enum ("type",
711 P_("The sockets type"),
713 G_SOCKET_TYPE_STREAM,
714 G_PARAM_CONSTRUCT_ONLY |
716 G_PARAM_STATIC_STRINGS));
718 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
719 g_param_spec_enum ("protocol",
720 P_("Socket protocol"),
721 P_("The id of the protocol to use, or -1 for unknown"),
722 G_TYPE_SOCKET_PROTOCOL,
723 G_SOCKET_PROTOCOL_UNKNOWN,
724 G_PARAM_CONSTRUCT_ONLY |
726 G_PARAM_STATIC_STRINGS));
728 g_object_class_install_property (gobject_class, PROP_FD,
729 g_param_spec_int ("fd",
730 P_("File descriptor"),
731 P_("The sockets file descriptor"),
735 G_PARAM_CONSTRUCT_ONLY |
737 G_PARAM_STATIC_STRINGS));
739 g_object_class_install_property (gobject_class, PROP_BLOCKING,
740 g_param_spec_boolean ("blocking",
742 P_("Whether or not I/O on this socket is blocking"),
745 G_PARAM_STATIC_STRINGS));
747 g_object_class_install_property (gobject_class, PROP_LISTEN_BACKLOG,
748 g_param_spec_int ("listen-backlog",
749 P_("Listen backlog"),
750 P_("Outstanding connections in the listen queue"),
755 G_PARAM_STATIC_STRINGS));
757 g_object_class_install_property (gobject_class, PROP_KEEPALIVE,
758 g_param_spec_boolean ("keepalive",
759 P_("Keep connection alive"),
760 P_("Keep connection alive by sending periodic pings"),
763 G_PARAM_STATIC_STRINGS));
765 g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
766 g_param_spec_object ("local-address",
768 P_("The local address the socket is bound to"),
769 G_TYPE_SOCKET_ADDRESS,
771 G_PARAM_STATIC_STRINGS));
773 g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
774 g_param_spec_object ("remote-address",
775 P_("Remote address"),
776 P_("The remote address the socket is connected to"),
777 G_TYPE_SOCKET_ADDRESS,
779 G_PARAM_STATIC_STRINGS));
784 * The timeout in seconds on socket I/O
788 g_object_class_install_property (gobject_class, PROP_TIMEOUT,
789 g_param_spec_uint ("timeout",
791 P_("The timeout in seconds on socket I/O"),
796 G_PARAM_STATIC_STRINGS));
800 g_socket_initable_iface_init (GInitableIface *iface)
802 iface->init = g_socket_initable_init;
806 g_socket_init (GSocket *socket)
808 socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket, G_TYPE_SOCKET, GSocketPrivate);
810 socket->priv->fd = -1;
811 socket->priv->blocking = TRUE;
812 socket->priv->listen_backlog = 10;
813 socket->priv->construct_error = NULL;
815 socket->priv->event = WSA_INVALID_EVENT;
820 g_socket_initable_init (GInitable *initable,
821 GCancellable *cancellable,
826 g_return_val_if_fail (G_IS_SOCKET (initable), FALSE);
828 socket = G_SOCKET (initable);
830 if (cancellable != NULL)
832 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
833 _("Cancellable initialization not supported"));
837 socket->priv->inited = TRUE;
839 if (socket->priv->construct_error)
842 *error = g_error_copy (socket->priv->construct_error);
852 * @family: the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.
853 * @type: the socket type to use.
854 * @protocol: the id of the protocol to use, or 0 for default.
855 * @error: #GError for error reporting, or %NULL to ignore.
857 * Creates a new #GSocket with the defined family, type and protocol.
858 * If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type
859 * for the family and type is used.
861 * The @protocol is a family and type specific int that specifies what
862 * kind of protocol to use. #GSocketProtocol lists several common ones.
863 * Many families only support one protocol, and use 0 for this, others
864 * support several and using 0 means to use the default protocol for
865 * the family and type.
867 * The protocol id is passed directly to the operating
868 * system, so you can use protocols not listed in #GSocketProtocol if you
869 * know the protocol number used for it.
871 * Returns: a #GSocket or %NULL on error.
872 * Free the returned object with g_object_unref().
877 g_socket_new (GSocketFamily family,
879 GSocketProtocol protocol,
882 return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
886 "protocol", protocol,
891 * g_socket_new_from_fd:
892 * @fd: a native socket file descriptor.
893 * @error: #GError for error reporting, or %NULL to ignore.
895 * Creates a new #GSocket from a native file descriptor
896 * or winsock SOCKET handle.
898 * This reads all the settings from the file descriptor so that
899 * all properties should work. Note that the file descriptor
900 * will be set to non-blocking mode, independent on the blocking
901 * mode of the #GSocket.
903 * Returns: a #GSocket or %NULL on error.
904 * Free the returned object with g_object_unref().
909 g_socket_new_from_fd (gint fd,
912 return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
919 * g_socket_set_blocking:
920 * @socket: a #GSocket.
921 * @blocking: Whether to use blocking I/O or not.
923 * Sets the blocking mode of the socket. In blocking mode
924 * all operations block until they succeed or there is an error. In
925 * non-blocking mode all functions return results immediately or
926 * with a %G_IO_ERROR_WOULD_BLOCK error.
928 * All sockets are created in blocking mode. However, note that the
929 * platform level socket is always non-blocking, and blocking mode
930 * is a GSocket level feature.
935 g_socket_set_blocking (GSocket *socket,
938 g_return_if_fail (G_IS_SOCKET (socket));
940 blocking = !!blocking;
942 if (socket->priv->blocking == blocking)
945 socket->priv->blocking = blocking;
946 g_object_notify (G_OBJECT (socket), "blocking");
950 * g_socket_get_blocking:
951 * @socket: a #GSocket.
953 * Gets the blocking mode of the socket. For details on blocking I/O,
954 * see g_socket_set_blocking().
956 * Returns: %TRUE if blocking I/O is used, %FALSE otherwise.
961 g_socket_get_blocking (GSocket *socket)
963 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
965 return socket->priv->blocking;
969 * g_socket_set_keepalive:
970 * @socket: a #GSocket.
971 * @keepalive: Value for the keepalive flag
973 * Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When
974 * this flag is set on a socket, the system will attempt to verify that the
975 * remote socket endpoint is still present if a sufficiently long period of
976 * time passes with no data being exchanged. If the system is unable to
977 * verify the presence of the remote endpoint, it will automatically close
980 * This option is only functional on certain kinds of sockets. (Notably,
981 * %G_SOCKET_PROTOCOL_TCP sockets.)
983 * The exact time between pings is system- and protocol-dependent, but will
984 * normally be at least two hours. Most commonly, you would set this flag
985 * on a server socket if you want to allow clients to remain idle for long
986 * periods of time, but also want to ensure that connections are eventually
987 * garbage-collected if clients crash or become unreachable.
992 g_socket_set_keepalive (GSocket *socket,
997 g_return_if_fail (G_IS_SOCKET (socket));
999 keepalive = !!keepalive;
1000 if (socket->priv->keepalive == keepalive)
1003 value = (gint) keepalive;
1004 if (setsockopt (socket->priv->fd, SOL_SOCKET, SO_KEEPALIVE,
1005 (gpointer) &value, sizeof (value)) < 0)
1007 int errsv = get_socket_errno ();
1008 g_warning ("error setting keepalive: %s", socket_strerror (errsv));
1012 socket->priv->keepalive = keepalive;
1013 g_object_notify (G_OBJECT (socket), "keepalive");
1017 * g_socket_get_keepalive:
1018 * @socket: a #GSocket.
1020 * Gets the keepalive mode of the socket. For details on this,
1021 * see g_socket_set_keepalive().
1023 * Returns: %TRUE if keepalive is active, %FALSE otherwise.
1028 g_socket_get_keepalive (GSocket *socket)
1030 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1032 return socket->priv->keepalive;
1036 * g_socket_get_listen_backlog:
1037 * @socket: a #GSocket.
1039 * Gets the listen backlog setting of the socket. For details on this,
1040 * see g_socket_set_listen_backlog().
1042 * Returns: the maximum number of pending connections.
1047 g_socket_get_listen_backlog (GSocket *socket)
1049 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1051 return socket->priv->listen_backlog;
1055 * g_socket_set_listen_backlog:
1056 * @socket: a #GSocket.
1057 * @backlog: the maximum number of pending connections.
1059 * Sets the maximum number of outstanding connections allowed
1060 * when listening on this socket. If more clients than this are
1061 * connecting to the socket and the application is not handling them
1062 * on time then the new connections will be refused.
1064 * Note that this must be called before g_socket_listen() and has no
1065 * effect if called after that.
1070 g_socket_set_listen_backlog (GSocket *socket,
1073 g_return_if_fail (G_IS_SOCKET (socket));
1074 g_return_if_fail (!socket->priv->listening);
1076 if (backlog != socket->priv->listen_backlog)
1078 socket->priv->listen_backlog = backlog;
1079 g_object_notify (G_OBJECT (socket), "listen-backlog");
1084 * g_socket_get_timeout:
1085 * @socket: a #GSocket.
1087 * Gets the timeout setting of the socket. For details on this, see
1088 * g_socket_set_timeout().
1090 * Returns: the timeout in seconds
1095 g_socket_get_timeout (GSocket *socket)
1097 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1099 return socket->priv->timeout;
1103 * g_socket_set_timeout:
1104 * @socket: a #GSocket.
1105 * @timeout: the timeout for @socket, in seconds, or 0 for none
1107 * Sets the time in seconds after which I/O operations on @socket will
1108 * time out if they have not yet completed.
1110 * On a blocking socket, this means that any blocking #GSocket
1111 * operation will time out after @timeout seconds of inactivity,
1112 * returning %G_IO_ERROR_TIMED_OUT.
1114 * On a non-blocking socket, calls to g_socket_condition_wait() will
1115 * also fail with %G_IO_ERROR_TIMED_OUT after the given time. Sources
1116 * created with g_socket_create_source() will trigger after
1117 * @timeout seconds of inactivity, with the requested condition
1118 * set, at which point calling g_socket_receive(), g_socket_send(),
1119 * g_socket_check_connect_result(), etc, will fail with
1120 * %G_IO_ERROR_TIMED_OUT.
1122 * If @timeout is 0 (the default), operations will never time out
1125 * Note that if an I/O operation is interrupted by a signal, this may
1126 * cause the timeout to be reset.
1131 g_socket_set_timeout (GSocket *socket,
1134 g_return_if_fail (G_IS_SOCKET (socket));
1136 if (timeout != socket->priv->timeout)
1138 socket->priv->timeout = timeout;
1139 g_object_notify (G_OBJECT (socket), "timeout");
1144 * g_socket_get_family:
1145 * @socket: a #GSocket.
1147 * Gets the socket family of the socket.
1149 * Returns: a #GSocketFamily
1154 g_socket_get_family (GSocket *socket)
1156 g_return_val_if_fail (G_IS_SOCKET (socket), G_SOCKET_FAMILY_INVALID);
1158 return socket->priv->family;
1162 * g_socket_get_socket_type:
1163 * @socket: a #GSocket.
1165 * Gets the socket type of the socket.
1167 * Returns: a #GSocketType
1172 g_socket_get_socket_type (GSocket *socket)
1174 g_return_val_if_fail (G_IS_SOCKET (socket), G_SOCKET_TYPE_INVALID);
1176 return socket->priv->type;
1180 * g_socket_get_protocol:
1181 * @socket: a #GSocket.
1183 * Gets the socket protocol id the socket was created with.
1184 * In case the protocol is unknown, -1 is returned.
1186 * Returns: a protocol id, or -1 if unknown
1191 g_socket_get_protocol (GSocket *socket)
1193 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
1195 return socket->priv->protocol;
1200 * @socket: a #GSocket.
1202 * Returns the underlying OS socket object. On unix this
1203 * is a socket file descriptor, and on windows this is
1204 * a Winsock2 SOCKET handle. This may be useful for
1205 * doing platform specific or otherwise unusual operations
1208 * Returns: the file descriptor of the socket.
1213 g_socket_get_fd (GSocket *socket)
1215 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
1217 return socket->priv->fd;
1221 * g_socket_get_local_address:
1222 * @socket: a #GSocket.
1223 * @error: #GError for error reporting, or %NULL to ignore.
1225 * Try to get the local address of a bound socket. This is only
1226 * useful if the socket has been bound to a local address,
1227 * either explicitly or implicitly when connecting.
1229 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
1230 * Free the returned object with g_object_unref().
1235 g_socket_get_local_address (GSocket *socket,
1238 struct sockaddr_storage buffer;
1239 guint32 len = sizeof (buffer);
1241 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1243 if (getsockname (socket->priv->fd, (struct sockaddr *) &buffer, &len) < 0)
1245 int errsv = get_socket_errno ();
1246 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1247 _("could not get local address: %s"), socket_strerror (errsv));
1251 return g_socket_address_new_from_native (&buffer, len);
1255 * g_socket_get_remote_address:
1256 * @socket: a #GSocket.
1257 * @error: #GError for error reporting, or %NULL to ignore.
1259 * Try to get the remove address of a connected socket. This is only
1260 * useful for connection oriented sockets that have been connected.
1262 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
1263 * Free the returned object with g_object_unref().
1268 g_socket_get_remote_address (GSocket *socket,
1271 struct sockaddr_storage buffer;
1272 guint32 len = sizeof (buffer);
1274 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1276 if (socket->priv->connect_pending)
1278 if (!g_socket_check_connect_result (socket, error))
1281 socket->priv->connect_pending = FALSE;
1284 if (!socket->priv->remote_address)
1286 if (getpeername (socket->priv->fd, (struct sockaddr *) &buffer, &len) < 0)
1288 int errsv = get_socket_errno ();
1289 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1290 _("could not get remote address: %s"), socket_strerror (errsv));
1294 socket->priv->remote_address = g_socket_address_new_from_native (&buffer, len);
1297 return g_object_ref (socket->priv->remote_address);
1301 * g_socket_is_connected:
1302 * @socket: a #GSocket.
1304 * Check whether the socket is connected. This is only useful for
1305 * connection-oriented sockets.
1307 * Returns: %TRUE if socket is connected, %FALSE otherwise.
1312 g_socket_is_connected (GSocket *socket)
1314 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1316 return socket->priv->connected;
1321 * @socket: a #GSocket.
1322 * @error: #GError for error reporting, or %NULL to ignore.
1324 * Marks the socket as a server socket, i.e. a socket that is used
1325 * to accept incoming requests using g_socket_accept().
1327 * Before calling this the socket must be bound to a local address using
1330 * To set the maximum amount of outstanding clients, use
1331 * g_socket_set_listen_backlog().
1333 * Returns: %TRUE on success, %FALSE on error.
1338 g_socket_listen (GSocket *socket,
1341 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1343 if (!check_socket (socket, error))
1346 if (listen (socket->priv->fd, socket->priv->listen_backlog) < 0)
1348 int errsv = get_socket_errno ();
1350 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1351 _("could not listen: %s"), socket_strerror (errsv));
1355 socket->priv->listening = TRUE;
1362 * @socket: a #GSocket.
1363 * @address: a #GSocketAddress specifying the local address.
1364 * @allow_reuse: whether to allow reusing this address
1365 * @error: #GError for error reporting, or %NULL to ignore.
1367 * When a socket is created it is attached to an address family, but it
1368 * doesn't have an address in this family. g_socket_bind() assigns the
1369 * address (sometimes called name) of the socket.
1371 * It is generally required to bind to a local address before you can
1372 * receive connections. (See g_socket_listen() and g_socket_accept() ).
1373 * In certain situations, you may also want to bind a socket that will be
1374 * used to initiate connections, though this is not normally required.
1376 * @allow_reuse should be %TRUE for server sockets (sockets that you will
1377 * eventually call g_socket_accept() on), and %FALSE for client sockets.
1378 * (Specifically, if it is %TRUE, then g_socket_bind() will set the
1379 * %SO_REUSEADDR flag on the socket, allowing it to bind @address even if
1380 * that address was previously used by another socket that has not yet been
1381 * fully cleaned-up by the kernel. Failing to set this flag on a server
1382 * socket may cause the bind call to return %G_IO_ERROR_ADDRESS_IN_USE if
1383 * the server program is stopped and then immediately restarted.)
1385 * Returns: %TRUE on success, %FALSE on error.
1390 g_socket_bind (GSocket *socket,
1391 GSocketAddress *address,
1392 gboolean reuse_address,
1395 struct sockaddr_storage addr;
1397 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
1399 if (!check_socket (socket, error))
1402 /* SO_REUSEADDR on windows means something else and is not what we want.
1403 It always allows the unix variant of SO_REUSEADDR anyway */
1408 value = (int) !!reuse_address;
1409 /* Ignore errors here, the only likely error is "not supported", and
1410 this is a "best effort" thing mainly */
1411 setsockopt (socket->priv->fd, SOL_SOCKET, SO_REUSEADDR,
1412 (gpointer) &value, sizeof (value));
1416 if (!g_socket_address_to_native (address, &addr, sizeof addr, error))
1419 if (bind (socket->priv->fd, (struct sockaddr *) &addr,
1420 g_socket_address_get_native_size (address)) < 0)
1422 int errsv = get_socket_errno ();
1424 G_IO_ERROR, socket_io_error_from_errno (errsv),
1425 _("Error binding to address: %s"), socket_strerror (errsv));
1433 * g_socket_speaks_ipv4:
1434 * @socket: a #GSocket
1436 * Checks if a socket is capable of speaking IPv4.
1438 * IPv4 sockets are capable of speaking IPv4. On some operating systems
1439 * and under some combinations of circumstances IPv6 sockets are also
1440 * capable of speaking IPv4. See RFC 3493 section 3.7 for more
1443 * No other types of sockets are currently considered as being capable
1446 * Returns: %TRUE if this socket can be used with IPv4.
1451 g_socket_speaks_ipv4 (GSocket *socket)
1453 switch (socket->priv->family)
1455 case G_SOCKET_FAMILY_IPV4:
1458 case G_SOCKET_FAMILY_IPV6:
1459 #if defined (IPPROTO_IPV6) && defined (IPV6_V6ONLY)
1461 guint sizeof_int = sizeof (int);
1464 if (getsockopt (socket->priv->fd,
1465 IPPROTO_IPV6, IPV6_V6ONLY,
1466 &v6_only, &sizeof_int) != 0)
1482 * @socket: a #GSocket.
1483 * @cancellable: (allow-none): a %GCancellable or %NULL
1484 * @error: #GError for error reporting, or %NULL to ignore.
1486 * Accept incoming connections on a connection-based socket. This removes
1487 * the first outstanding connection request from the listening socket and
1488 * creates a #GSocket object for it.
1490 * The @socket must be bound to a local address with g_socket_bind() and
1491 * must be listening for incoming connections (g_socket_listen()).
1493 * If there are no outstanding connections then the operation will block
1494 * or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled.
1495 * To be notified of an incoming connection, wait for the %G_IO_IN condition.
1497 * Returns: (transfer full): a new #GSocket, or %NULL on error.
1498 * Free the returned object with g_object_unref().
1503 g_socket_accept (GSocket *socket,
1504 GCancellable *cancellable,
1507 GSocket *new_socket;
1510 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1512 if (!check_socket (socket, error))
1517 if (socket->priv->blocking &&
1518 !g_socket_condition_wait (socket,
1519 G_IO_IN, cancellable, error))
1522 if ((ret = accept (socket->priv->fd, NULL, 0)) < 0)
1524 int errsv = get_socket_errno ();
1526 win32_unset_event_mask (socket, FD_ACCEPT);
1531 if (socket->priv->blocking)
1533 #ifdef WSAEWOULDBLOCK
1534 if (errsv == WSAEWOULDBLOCK)
1537 if (errsv == EWOULDBLOCK ||
1543 g_set_error (error, G_IO_ERROR,
1544 socket_io_error_from_errno (errsv),
1545 _("Error accepting connection: %s"), socket_strerror (errsv));
1551 win32_unset_event_mask (socket, FD_ACCEPT);
1555 /* The socket inherits the accepting sockets event mask and even object,
1556 we need to remove that */
1557 WSAEventSelect (ret, NULL, 0);
1563 /* We always want to set close-on-exec to protect users. If you
1564 need to so some weird inheritance to exec you can re-enable this
1565 using lower level hacks with g_socket_get_fd(). */
1566 flags = fcntl (ret, F_GETFD, 0);
1568 (flags & FD_CLOEXEC) == 0)
1570 flags |= FD_CLOEXEC;
1571 fcntl (ret, F_SETFD, flags);
1576 new_socket = g_socket_new_from_fd (ret, error);
1577 if (new_socket == NULL)
1586 new_socket->priv->protocol = socket->priv->protocol;
1593 * @socket: a #GSocket.
1594 * @address: a #GSocketAddress specifying the remote address.
1595 * @cancellable: (allow-none): a %GCancellable or %NULL
1596 * @error: #GError for error reporting, or %NULL to ignore.
1598 * Connect the socket to the specified remote address.
1600 * For connection oriented socket this generally means we attempt to make
1601 * a connection to the @address. For a connection-less socket it sets
1602 * the default address for g_socket_send() and discards all incoming datagrams
1603 * from other sources.
1605 * Generally connection oriented sockets can only connect once, but
1606 * connection-less sockets can connect multiple times to change the
1609 * If the connect call needs to do network I/O it will block, unless
1610 * non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned
1611 * and the user can be notified of the connection finishing by waiting
1612 * for the G_IO_OUT condition. The result of the connection can then be
1613 * checked with g_socket_check_connect_result().
1615 * Returns: %TRUE if connected, %FALSE on error.
1620 g_socket_connect (GSocket *socket,
1621 GSocketAddress *address,
1622 GCancellable *cancellable,
1625 struct sockaddr_storage buffer;
1627 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
1629 if (!check_socket (socket, error))
1632 if (!g_socket_address_to_native (address, &buffer, sizeof buffer, error))
1635 if (socket->priv->remote_address)
1636 g_object_unref (socket->priv->remote_address);
1637 socket->priv->remote_address = g_object_ref (address);
1641 if (connect (socket->priv->fd, (struct sockaddr *) &buffer,
1642 g_socket_address_get_native_size (address)) < 0)
1644 int errsv = get_socket_errno ();
1650 if (errsv == EINPROGRESS)
1652 if (errsv == WSAEWOULDBLOCK)
1655 if (socket->priv->blocking)
1657 if (g_socket_condition_wait (socket, G_IO_OUT, cancellable, error))
1659 if (g_socket_check_connect_result (socket, error))
1662 g_prefix_error (error, _("Error connecting: "));
1666 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
1667 _("Connection in progress"));
1668 socket->priv->connect_pending = TRUE;
1672 g_set_error (error, G_IO_ERROR,
1673 socket_io_error_from_errno (errsv),
1674 _("Error connecting: %s"), socket_strerror (errsv));
1681 win32_unset_event_mask (socket, FD_CONNECT);
1683 socket->priv->connected = TRUE;
1689 * g_socket_check_connect_result:
1690 * @socket: a #GSocket
1691 * @error: #GError for error reporting, or %NULL to ignore.
1693 * Checks and resets the pending connect error for the socket.
1694 * This is used to check for errors when g_socket_connect() is
1695 * used in non-blocking mode.
1697 * Returns: %TRUE if no error, %FALSE otherwise, setting @error to the error
1702 g_socket_check_connect_result (GSocket *socket,
1708 if (!check_socket (socket, error))
1711 optlen = sizeof (value);
1712 if (getsockopt (socket->priv->fd, SOL_SOCKET, SO_ERROR, (void *)&value, &optlen) != 0)
1714 int errsv = get_socket_errno ();
1716 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1717 _("Unable to get pending error: %s"), socket_strerror (errsv));
1723 g_set_error_literal (error, G_IO_ERROR, socket_io_error_from_errno (value),
1724 socket_strerror (value));
1725 if (socket->priv->remote_address)
1727 g_object_unref (socket->priv->remote_address);
1728 socket->priv->remote_address = NULL;
1737 * @socket: a #GSocket
1738 * @buffer: a buffer to read data into (which should be at least @size
1740 * @size: the number of bytes you want to read from the socket
1741 * @cancellable: (allow-none): a %GCancellable or %NULL
1742 * @error: #GError for error reporting, or %NULL to ignore.
1744 * Receive data (up to @size bytes) from a socket. This is mainly used by
1745 * connection-oriented sockets; it is identical to g_socket_receive_from()
1746 * with @address set to %NULL.
1748 * For %G_SOCKET_TYPE_DATAGRAM and %G_SOCKET_TYPE_SEQPACKET sockets,
1749 * g_socket_receive() will always read either 0 or 1 complete messages from
1750 * the socket. If the received message is too large to fit in @buffer, then
1751 * the data beyond @size bytes will be discarded, without any explicit
1752 * indication that this has occurred.
1754 * For %G_SOCKET_TYPE_STREAM sockets, g_socket_receive() can return any
1755 * number of bytes, up to @size. If more than @size bytes have been
1756 * received, the additional data will be returned in future calls to
1757 * g_socket_receive().
1759 * If the socket is in blocking mode the call will block until there
1760 * is some data to receive, the connection is closed, or there is an
1761 * error. If there is no data available and the socket is in
1762 * non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error will be
1763 * returned. To be notified when data is available, wait for the
1764 * %G_IO_IN condition.
1766 * On error -1 is returned and @error is set accordingly.
1768 * Returns: Number of bytes read, or 0 if the connection was closed by
1769 * the peer, or -1 on error
1774 g_socket_receive (GSocket *socket,
1777 GCancellable *cancellable,
1780 return g_socket_receive_with_blocking (socket, buffer, size,
1781 socket->priv->blocking,
1782 cancellable, error);
1786 * g_socket_receive_with_blocking:
1787 * @socket: a #GSocket
1788 * @buffer: a buffer to read data into (which should be at least @size
1790 * @size: the number of bytes you want to read from the socket
1791 * @blocking: whether to do blocking or non-blocking I/O
1792 * @cancellable: (allow-none): a %GCancellable or %NULL
1793 * @error: #GError for error reporting, or %NULL to ignore.
1795 * This behaves exactly the same as g_socket_receive(), except that
1796 * the choice of blocking or non-blocking behavior is determined by
1797 * the @blocking argument rather than by @socket's properties.
1799 * Returns: Number of bytes read, or 0 if the connection was closed by
1800 * the peer, or -1 on error
1805 g_socket_receive_with_blocking (GSocket *socket,
1809 GCancellable *cancellable,
1814 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
1816 if (!check_socket (socket, error))
1819 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1825 !g_socket_condition_wait (socket,
1826 G_IO_IN, cancellable, error))
1829 if ((ret = recv (socket->priv->fd, buffer, size, 0)) < 0)
1831 int errsv = get_socket_errno ();
1838 #ifdef WSAEWOULDBLOCK
1839 if (errsv == WSAEWOULDBLOCK)
1842 if (errsv == EWOULDBLOCK ||
1848 win32_unset_event_mask (socket, FD_READ);
1850 g_set_error (error, G_IO_ERROR,
1851 socket_io_error_from_errno (errsv),
1852 _("Error receiving data: %s"), socket_strerror (errsv));
1856 win32_unset_event_mask (socket, FD_READ);
1865 * g_socket_receive_from:
1866 * @socket: a #GSocket
1867 * @address: a pointer to a #GSocketAddress pointer, or %NULL
1868 * @buffer: a buffer to read data into (which should be at least @size
1870 * @size: the number of bytes you want to read from the socket
1871 * @cancellable: (allow-none): a %GCancellable or %NULL
1872 * @error: #GError for error reporting, or %NULL to ignore.
1874 * Receive data (up to @size bytes) from a socket.
1876 * If @address is non-%NULL then @address will be set equal to the
1877 * source address of the received packet.
1878 * @address is owned by the caller.
1880 * See g_socket_receive() for additional information.
1882 * Returns: Number of bytes read, or 0 if the connection was closed by
1883 * the peer, or -1 on error
1888 g_socket_receive_from (GSocket *socket,
1889 GSocketAddress **address,
1892 GCancellable *cancellable,
1900 return g_socket_receive_message (socket,
1908 /* Although we ignore SIGPIPE, gdb will still stop if the app receives
1909 * one, which can be confusing and annoying. So if possible, we want
1910 * to suppress the signal entirely.
1913 #define G_SOCKET_DEFAULT_SEND_FLAGS MSG_NOSIGNAL
1915 #define G_SOCKET_DEFAULT_SEND_FLAGS 0
1920 * @socket: a #GSocket
1921 * @buffer: (array length=size): the buffer containing the data to send.
1922 * @size: the number of bytes to send
1923 * @cancellable: (allow-none): a %GCancellable or %NULL
1924 * @error: #GError for error reporting, or %NULL to ignore.
1926 * Tries to send @size bytes from @buffer on the socket. This is
1927 * mainly used by connection-oriented sockets; it is identical to
1928 * g_socket_send_to() with @address set to %NULL.
1930 * If the socket is in blocking mode the call will block until there is
1931 * space for the data in the socket queue. If there is no space available
1932 * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
1933 * will be returned. To be notified when space is available, wait for the
1934 * %G_IO_OUT condition. Note though that you may still receive
1935 * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
1936 * notified of a %G_IO_OUT condition. (On Windows in particular, this is
1937 * very common due to the way the underlying APIs work.)
1939 * On error -1 is returned and @error is set accordingly.
1941 * Returns: Number of bytes written (which may be less than @size), or -1
1947 g_socket_send (GSocket *socket,
1948 const gchar *buffer,
1950 GCancellable *cancellable,
1953 return g_socket_send_with_blocking (socket, buffer, size,
1954 socket->priv->blocking,
1955 cancellable, error);
1959 * g_socket_send_with_blocking:
1960 * @socket: a #GSocket
1961 * @buffer: (array length=size): the buffer containing the data to send.
1962 * @size: the number of bytes to send
1963 * @blocking: whether to do blocking or non-blocking I/O
1964 * @cancellable: (allow-none): a %GCancellable or %NULL
1965 * @error: #GError for error reporting, or %NULL to ignore.
1967 * This behaves exactly the same as g_socket_send(), except that
1968 * the choice of blocking or non-blocking behavior is determined by
1969 * the @blocking argument rather than by @socket's properties.
1971 * Returns: Number of bytes written (which may be less than @size), or -1
1977 g_socket_send_with_blocking (GSocket *socket,
1978 const gchar *buffer,
1981 GCancellable *cancellable,
1986 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
1988 if (!check_socket (socket, error))
1991 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1997 !g_socket_condition_wait (socket,
1998 G_IO_OUT, cancellable, error))
2001 if ((ret = send (socket->priv->fd, buffer, size, G_SOCKET_DEFAULT_SEND_FLAGS)) < 0)
2003 int errsv = get_socket_errno ();
2008 #ifdef WSAEWOULDBLOCK
2009 if (errsv == WSAEWOULDBLOCK)
2010 win32_unset_event_mask (socket, FD_WRITE);
2015 #ifdef WSAEWOULDBLOCK
2016 if (errsv == WSAEWOULDBLOCK)
2019 if (errsv == EWOULDBLOCK ||
2025 g_set_error (error, G_IO_ERROR,
2026 socket_io_error_from_errno (errsv),
2027 _("Error sending data: %s"), socket_strerror (errsv));
2038 * @socket: a #GSocket
2039 * @address: a #GSocketAddress, or %NULL
2040 * @buffer: (array length=size): the buffer containing the data to send.
2041 * @size: the number of bytes to send
2042 * @cancellable: (allow-none): a %GCancellable or %NULL
2043 * @error: #GError for error reporting, or %NULL to ignore.
2045 * Tries to send @size bytes from @buffer to @address. If @address is
2046 * %NULL then the message is sent to the default receiver (set by
2047 * g_socket_connect()).
2049 * See g_socket_send() for additional information.
2051 * Returns: Number of bytes written (which may be less than @size), or -1
2057 g_socket_send_to (GSocket *socket,
2058 GSocketAddress *address,
2059 const gchar *buffer,
2061 GCancellable *cancellable,
2069 return g_socket_send_message (socket,
2079 * g_socket_shutdown:
2080 * @socket: a #GSocket
2081 * @shutdown_read: whether to shut down the read side
2082 * @shutdown_write: whether to shut down the write side
2083 * @error: #GError for error reporting, or %NULL to ignore.
2085 * Shut down part of a full-duplex connection.
2087 * If @shutdown_read is %TRUE then the recieving side of the connection
2088 * is shut down, and further reading is disallowed.
2090 * If @shutdown_write is %TRUE then the sending side of the connection
2091 * is shut down, and further writing is disallowed.
2093 * It is allowed for both @shutdown_read and @shutdown_write to be %TRUE.
2095 * One example where this is used is graceful disconnect for TCP connections
2096 * where you close the sending side, then wait for the other side to close
2097 * the connection, thus ensuring that the other side saw all sent data.
2099 * Returns: %TRUE on success, %FALSE on error
2104 g_socket_shutdown (GSocket *socket,
2105 gboolean shutdown_read,
2106 gboolean shutdown_write,
2111 g_return_val_if_fail (G_IS_SOCKET (socket), TRUE);
2113 if (!check_socket (socket, NULL))
2117 if (!shutdown_read && !shutdown_write)
2121 if (shutdown_read && shutdown_write)
2123 else if (shutdown_read)
2128 if (shutdown_read && shutdown_write)
2130 else if (shutdown_read)
2136 if (shutdown (socket->priv->fd, how) != 0)
2138 int errsv = get_socket_errno ();
2139 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
2140 _("Unable to create socket: %s"), socket_strerror (errsv));
2144 if (shutdown_read && shutdown_write)
2145 socket->priv->connected = FALSE;
2152 * @socket: a #GSocket
2153 * @error: #GError for error reporting, or %NULL to ignore.
2155 * Closes the socket, shutting down any active connection.
2157 * Closing a socket does not wait for all outstanding I/O operations
2158 * to finish, so the caller should not rely on them to be guaranteed
2159 * to complete even if the close returns with no error.
2161 * Once the socket is closed, all other operations will return
2162 * %G_IO_ERROR_CLOSED. Closing a socket multiple times will not
2165 * Sockets will be automatically closed when the last reference
2166 * is dropped, but you might want to call this function to make sure
2167 * resources are released as early as possible.
2169 * Beware that due to the way that TCP works, it is possible for
2170 * recently-sent data to be lost if either you close a socket while the
2171 * %G_IO_IN condition is set, or else if the remote connection tries to
2172 * send something to you after you close the socket but before it has
2173 * finished reading all of the data you sent. There is no easy generic
2174 * way to avoid this problem; the easiest fix is to design the network
2175 * protocol such that the client will never send data "out of turn".
2176 * Another solution is for the server to half-close the connection by
2177 * calling g_socket_shutdown() with only the @shutdown_write flag set,
2178 * and then wait for the client to notice this and close its side of the
2179 * connection, after which the server can safely call g_socket_close().
2180 * (This is what #GTcpConnection does if you call
2181 * g_tcp_connection_set_graceful_disconnect(). But of course, this
2182 * only works if the client will close its connection after the server
2185 * Returns: %TRUE on success, %FALSE on error
2190 g_socket_close (GSocket *socket,
2195 g_return_val_if_fail (G_IS_SOCKET (socket), TRUE);
2197 if (socket->priv->closed)
2198 return TRUE; /* Multiple close not an error */
2200 if (!check_socket (socket, NULL))
2206 res = closesocket (socket->priv->fd);
2208 res = close (socket->priv->fd);
2212 int errsv = get_socket_errno ();
2217 g_set_error (error, G_IO_ERROR,
2218 socket_io_error_from_errno (errsv),
2219 _("Error closing socket: %s"),
2220 socket_strerror (errsv));
2226 socket->priv->connected = FALSE;
2227 socket->priv->closed = TRUE;
2228 if (socket->priv->remote_address)
2230 g_object_unref (socket->priv->remote_address);
2231 socket->priv->remote_address = NULL;
2238 * g_socket_is_closed:
2239 * @socket: a #GSocket
2241 * Checks whether a socket is closed.
2243 * Returns: %TRUE if socket is closed, %FALSE otherwise
2248 g_socket_is_closed (GSocket *socket)
2250 return socket->priv->closed;
2254 /* Broken source, used on errors */
2256 broken_prepare (GSource *source,
2263 broken_check (GSource *source)
2269 broken_dispatch (GSource *source,
2270 GSourceFunc callback,
2276 static GSourceFuncs broken_funcs =
2285 network_events_for_condition (GIOCondition condition)
2289 if (condition & G_IO_IN)
2290 event_mask |= (FD_READ | FD_ACCEPT);
2291 if (condition & G_IO_OUT)
2292 event_mask |= (FD_WRITE | FD_CONNECT);
2293 event_mask |= FD_CLOSE;
2299 ensure_event (GSocket *socket)
2301 if (socket->priv->event == WSA_INVALID_EVENT)
2302 socket->priv->event = WSACreateEvent();
2306 update_select_events (GSocket *socket)
2313 ensure_event (socket);
2316 for (l = socket->priv->requested_conditions; l != NULL; l = l->next)
2319 event_mask |= network_events_for_condition (*ptr);
2322 if (event_mask != socket->priv->selected_events)
2324 /* If no events selected, disable event so we can unset
2327 if (event_mask == 0)
2330 event = socket->priv->event;
2332 if (WSAEventSelect (socket->priv->fd, event, event_mask) == 0)
2333 socket->priv->selected_events = event_mask;
2338 add_condition_watch (GSocket *socket,
2339 GIOCondition *condition)
2341 g_assert (g_list_find (socket->priv->requested_conditions, condition) == NULL);
2343 socket->priv->requested_conditions =
2344 g_list_prepend (socket->priv->requested_conditions, condition);
2346 update_select_events (socket);
2350 remove_condition_watch (GSocket *socket,
2351 GIOCondition *condition)
2353 g_assert (g_list_find (socket->priv->requested_conditions, condition) != NULL);
2355 socket->priv->requested_conditions =
2356 g_list_remove (socket->priv->requested_conditions, condition);
2358 update_select_events (socket);
2362 update_condition (GSocket *socket)
2364 WSANETWORKEVENTS events;
2365 GIOCondition condition;
2367 if (WSAEnumNetworkEvents (socket->priv->fd,
2368 socket->priv->event,
2371 socket->priv->current_events |= events.lNetworkEvents;
2372 if (events.lNetworkEvents & FD_WRITE &&
2373 events.iErrorCode[FD_WRITE_BIT] != 0)
2374 socket->priv->current_errors |= FD_WRITE;
2375 if (events.lNetworkEvents & FD_CONNECT &&
2376 events.iErrorCode[FD_CONNECT_BIT] != 0)
2377 socket->priv->current_errors |= FD_CONNECT;
2381 if (socket->priv->current_events & (FD_READ | FD_ACCEPT))
2382 condition |= G_IO_IN;
2384 if (socket->priv->current_events & FD_CLOSE ||
2385 socket->priv->closed)
2386 condition |= G_IO_HUP;
2388 /* Never report both G_IO_OUT and HUP, these are
2389 mutually exclusive (can't write to a closed socket) */
2390 if ((condition & G_IO_HUP) == 0 &&
2391 socket->priv->current_events & FD_WRITE)
2393 if (socket->priv->current_errors & FD_WRITE)
2394 condition |= G_IO_ERR;
2396 condition |= G_IO_OUT;
2400 if (socket->priv->current_events & FD_CONNECT)
2402 if (socket->priv->current_errors & FD_CONNECT)
2403 condition |= (G_IO_HUP | G_IO_ERR);
2405 condition |= G_IO_OUT;
2417 GIOCondition condition;
2418 GCancellable *cancellable;
2419 GPollFD cancel_pollfd;
2420 gint64 timeout_time;
2424 socket_source_prepare (GSource *source,
2427 GSocketSource *socket_source = (GSocketSource *)source;
2429 if (g_cancellable_is_cancelled (socket_source->cancellable))
2432 if (socket_source->timeout_time)
2436 now = g_source_get_time (source);
2437 /* Round up to ensure that we don't try again too early */
2438 *timeout = (socket_source->timeout_time - now + 999) / 1000;
2441 socket_source->socket->priv->timed_out = TRUE;
2442 socket_source->pollfd.revents = socket_source->condition & (G_IO_IN | G_IO_OUT);
2451 socket_source->pollfd.revents = update_condition (socket_source->socket);
2454 if ((socket_source->condition & socket_source->pollfd.revents) != 0)
2461 socket_source_check (GSource *source)
2465 return socket_source_prepare (source, &timeout);
2469 socket_source_dispatch (GSource *source,
2470 GSourceFunc callback,
2473 GSocketSourceFunc func = (GSocketSourceFunc)callback;
2474 GSocketSource *socket_source = (GSocketSource *)source;
2477 socket_source->pollfd.revents = update_condition (socket_source->socket);
2480 return (*func) (socket_source->socket,
2481 socket_source->pollfd.revents & socket_source->condition,
2486 socket_source_finalize (GSource *source)
2488 GSocketSource *socket_source = (GSocketSource *)source;
2491 socket = socket_source->socket;
2494 remove_condition_watch (socket, &socket_source->condition);
2497 g_object_unref (socket);
2499 if (socket_source->cancellable)
2501 g_cancellable_release_fd (socket_source->cancellable);
2502 g_object_unref (socket_source->cancellable);
2507 socket_source_closure_callback (GSocket *socket,
2508 GIOCondition condition,
2511 GClosure *closure = data;
2513 GValue params[2] = { { 0, }, { 0, } };
2514 GValue result_value = { 0, };
2517 g_value_init (&result_value, G_TYPE_BOOLEAN);
2519 g_value_init (¶ms[0], G_TYPE_SOCKET);
2520 g_value_set_object (¶ms[0], socket);
2521 g_value_init (¶ms[1], G_TYPE_IO_CONDITION);
2522 g_value_set_flags (¶ms[1], condition);
2524 g_closure_invoke (closure, &result_value, 2, params, NULL);
2526 result = g_value_get_boolean (&result_value);
2527 g_value_unset (&result_value);
2528 g_value_unset (¶ms[0]);
2529 g_value_unset (¶ms[1]);
2534 static GSourceFuncs socket_source_funcs =
2536 socket_source_prepare,
2537 socket_source_check,
2538 socket_source_dispatch,
2539 socket_source_finalize,
2540 (GSourceFunc)socket_source_closure_callback,
2541 (GSourceDummyMarshal)_gio_marshal_BOOLEAN__FLAGS,
2545 socket_source_new (GSocket *socket,
2546 GIOCondition condition,
2547 GCancellable *cancellable)
2550 GSocketSource *socket_source;
2553 ensure_event (socket);
2555 if (socket->priv->event == WSA_INVALID_EVENT)
2557 g_warning ("Failed to create WSAEvent");
2558 return g_source_new (&broken_funcs, sizeof (GSource));
2562 condition |= G_IO_HUP | G_IO_ERR;
2564 source = g_source_new (&socket_source_funcs, sizeof (GSocketSource));
2565 g_source_set_name (source, "GSocket");
2566 socket_source = (GSocketSource *)source;
2568 socket_source->socket = g_object_ref (socket);
2569 socket_source->condition = condition;
2571 if (g_cancellable_make_pollfd (cancellable,
2572 &socket_source->cancel_pollfd))
2574 socket_source->cancellable = g_object_ref (cancellable);
2575 g_source_add_poll (source, &socket_source->cancel_pollfd);
2579 add_condition_watch (socket, &socket_source->condition);
2580 socket_source->pollfd.fd = (gintptr) socket->priv->event;
2582 socket_source->pollfd.fd = socket->priv->fd;
2585 socket_source->pollfd.events = condition;
2586 socket_source->pollfd.revents = 0;
2587 g_source_add_poll (source, &socket_source->pollfd);
2589 if (socket->priv->timeout)
2590 socket_source->timeout_time = g_get_monotonic_time () +
2591 socket->priv->timeout * 1000000;
2594 socket_source->timeout_time = 0;
2600 * g_socket_create_source: (skip)
2601 * @socket: a #GSocket
2602 * @condition: a #GIOCondition mask to monitor
2603 * @cancellable: (allow-none): a %GCancellable or %NULL
2605 * Creates a %GSource that can be attached to a %GMainContext to monitor
2606 * for the availibility of the specified @condition on the socket.
2608 * The callback on the source is of the #GSocketSourceFunc type.
2610 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in @condition;
2611 * these conditions will always be reported output if they are true.
2613 * @cancellable if not %NULL can be used to cancel the source, which will
2614 * cause the source to trigger, reporting the current condition (which
2615 * is likely 0 unless cancellation happened at the same time as a
2616 * condition change). You can check for this in the callback using
2617 * g_cancellable_is_cancelled().
2619 * If @socket has a timeout set, and it is reached before @condition
2620 * occurs, the source will then trigger anyway, reporting %G_IO_IN or
2621 * %G_IO_OUT depending on @condition. However, @socket will have been
2622 * marked as having had a timeout, and so the next #GSocket I/O method
2623 * you call will then fail with a %G_IO_ERROR_TIMED_OUT.
2625 * Returns: (transfer full): a newly allocated %GSource, free with g_source_unref().
2630 g_socket_create_source (GSocket *socket,
2631 GIOCondition condition,
2632 GCancellable *cancellable)
2634 g_return_val_if_fail (G_IS_SOCKET (socket) && (cancellable == NULL || G_IS_CANCELLABLE (cancellable)), NULL);
2636 return socket_source_new (socket, condition, cancellable);
2640 * g_socket_condition_check:
2641 * @socket: a #GSocket
2642 * @condition: a #GIOCondition mask to check
2644 * Checks on the readiness of @socket to perform operations.
2645 * The operations specified in @condition are checked for and masked
2646 * against the currently-satisfied conditions on @socket. The result
2649 * Note that on Windows, it is possible for an operation to return
2650 * %G_IO_ERROR_WOULD_BLOCK even immediately after
2651 * g_socket_condition_check() has claimed that the socket is ready for
2652 * writing. Rather than calling g_socket_condition_check() and then
2653 * writing to the socket if it succeeds, it is generally better to
2654 * simply try writing to the socket right away, and try again later if
2655 * the initial attempt returns %G_IO_ERROR_WOULD_BLOCK.
2657 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition;
2658 * these conditions will always be set in the output if they are true.
2660 * This call never blocks.
2662 * Returns: the @GIOCondition mask of the current state
2667 g_socket_condition_check (GSocket *socket,
2668 GIOCondition condition)
2670 if (!check_socket (socket, NULL))
2675 GIOCondition current_condition;
2677 condition |= G_IO_ERR | G_IO_HUP;
2679 add_condition_watch (socket, &condition);
2680 current_condition = update_condition (socket);
2681 remove_condition_watch (socket, &condition);
2682 return condition & current_condition;
2688 poll_fd.fd = socket->priv->fd;
2689 poll_fd.events = condition;
2692 result = g_poll (&poll_fd, 1, 0);
2693 while (result == -1 && get_socket_errno () == EINTR);
2695 return poll_fd.revents;
2701 * g_socket_condition_wait:
2702 * @socket: a #GSocket
2703 * @condition: a #GIOCondition mask to wait for
2704 * @cancellable: (allow-none): a #GCancellable, or %NULL
2705 * @error: a #GError pointer, or %NULL
2707 * Waits for @condition to become true on @socket. When the condition
2708 * is met, %TRUE is returned.
2710 * If @cancellable is cancelled before the condition is met, or if the
2711 * socket has a timeout set and it is reached before the condition is
2712 * met, then %FALSE is returned and @error, if non-%NULL, is set to
2713 * the appropriate value (%G_IO_ERROR_CANCELLED or
2714 * %G_IO_ERROR_TIMED_OUT).
2716 * Returns: %TRUE if the condition was met, %FALSE otherwise
2721 g_socket_condition_wait (GSocket *socket,
2722 GIOCondition condition,
2723 GCancellable *cancellable,
2726 if (!check_socket (socket, error))
2729 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2734 GIOCondition current_condition;
2740 /* Always check these */
2741 condition |= G_IO_ERR | G_IO_HUP;
2743 add_condition_watch (socket, &condition);
2746 events[num_events++] = socket->priv->event;
2748 if (g_cancellable_make_pollfd (cancellable, &cancel_fd))
2749 events[num_events++] = (WSAEVENT)cancel_fd.fd;
2751 if (socket->priv->timeout)
2752 timeout = socket->priv->timeout * 1000;
2754 timeout = WSA_INFINITE;
2756 current_condition = update_condition (socket);
2757 while ((condition & current_condition) == 0)
2759 res = WSAWaitForMultipleEvents(num_events, events,
2760 FALSE, timeout, FALSE);
2761 if (res == WSA_WAIT_FAILED)
2763 int errsv = get_socket_errno ();
2765 g_set_error (error, G_IO_ERROR,
2766 socket_io_error_from_errno (errsv),
2767 _("Waiting for socket condition: %s"),
2768 socket_strerror (errsv));
2771 else if (res == WSA_WAIT_TIMEOUT)
2773 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
2774 _("Socket I/O timed out"));
2778 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2781 current_condition = update_condition (socket);
2783 remove_condition_watch (socket, &condition);
2785 g_cancellable_release_fd (cancellable);
2787 return (condition & current_condition) != 0;
2796 poll_fd[0].fd = socket->priv->fd;
2797 poll_fd[0].events = condition;
2800 if (g_cancellable_make_pollfd (cancellable, &poll_fd[1]))
2803 if (socket->priv->timeout)
2804 timeout = socket->priv->timeout * 1000;
2809 result = g_poll (poll_fd, num, timeout);
2810 while (result == -1 && get_socket_errno () == EINTR);
2813 g_cancellable_release_fd (cancellable);
2817 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
2818 _("Socket I/O timed out"));
2822 return !g_cancellable_set_error_if_cancelled (cancellable, error);
2828 * g_socket_send_message:
2829 * @socket: a #GSocket
2830 * @address: a #GSocketAddress, or %NULL
2831 * @vectors: (array length=num_vectors): an array of #GOutputVector structs
2832 * @num_vectors: the number of elements in @vectors, or -1
2833 * @messages: (array length=num_messages) (allow-none): a pointer to an
2834 * array of #GSocketControlMessages, or %NULL.
2835 * @num_messages: number of elements in @messages, or -1.
2836 * @flags: an int containing #GSocketMsgFlags flags
2837 * @cancellable: (allow-none): a %GCancellable or %NULL
2838 * @error: #GError for error reporting, or %NULL to ignore.
2840 * Send data to @address on @socket. This is the most complicated and
2841 * fully-featured version of this call. For easier use, see
2842 * g_socket_send() and g_socket_send_to().
2844 * If @address is %NULL then the message is sent to the default receiver
2845 * (set by g_socket_connect()).
2847 * @vectors must point to an array of #GOutputVector structs and
2848 * @num_vectors must be the length of this array. (If @num_vectors is -1,
2849 * then @vectors is assumed to be terminated by a #GOutputVector with a
2850 * %NULL buffer pointer.) The #GOutputVector structs describe the buffers
2851 * that the sent data will be gathered from. Using multiple
2852 * #GOutputVector<!-- -->s is more memory-efficient than manually copying
2853 * data from multiple sources into a single buffer, and more
2854 * network-efficient than making multiple calls to g_socket_send().
2856 * @messages, if non-%NULL, is taken to point to an array of @num_messages
2857 * #GSocketControlMessage instances. These correspond to the control
2858 * messages to be sent on the socket.
2859 * If @num_messages is -1 then @messages is treated as a %NULL-terminated
2862 * @flags modify how the message is sent. The commonly available arguments
2863 * for this are available in the #GSocketMsgFlags enum, but the
2864 * values there are the same as the system values, and the flags
2865 * are passed in as-is, so you can pass in system-specific flags too.
2867 * If the socket is in blocking mode the call will block until there is
2868 * space for the data in the socket queue. If there is no space available
2869 * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
2870 * will be returned. To be notified when space is available, wait for the
2871 * %G_IO_OUT condition. Note though that you may still receive
2872 * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
2873 * notified of a %G_IO_OUT condition. (On Windows in particular, this is
2874 * very common due to the way the underlying APIs work.)
2876 * On error -1 is returned and @error is set accordingly.
2878 * Returns: Number of bytes written (which may be less than @size), or -1
2884 g_socket_send_message (GSocket *socket,
2885 GSocketAddress *address,
2886 GOutputVector *vectors,
2888 GSocketControlMessage **messages,
2891 GCancellable *cancellable,
2894 GOutputVector one_vector;
2897 if (!check_socket (socket, error))
2900 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2903 if (num_vectors == -1)
2905 for (num_vectors = 0;
2906 vectors[num_vectors].buffer != NULL;
2911 if (num_messages == -1)
2913 for (num_messages = 0;
2914 messages != NULL && messages[num_messages] != NULL;
2919 if (num_vectors == 0)
2923 one_vector.buffer = &zero;
2924 one_vector.size = 1;
2926 vectors = &one_vector;
2939 msg.msg_namelen = g_socket_address_get_native_size (address);
2940 msg.msg_name = g_alloca (msg.msg_namelen);
2941 if (!g_socket_address_to_native (address, msg.msg_name, msg.msg_namelen, error))
2946 msg.msg_name = NULL;
2947 msg.msg_namelen = 0;
2952 /* this entire expression will be evaluated at compile time */
2953 if (sizeof *msg.msg_iov == sizeof *vectors &&
2954 sizeof msg.msg_iov->iov_base == sizeof vectors->buffer &&
2955 G_STRUCT_OFFSET (struct iovec, iov_base) ==
2956 G_STRUCT_OFFSET (GOutputVector, buffer) &&
2957 sizeof msg.msg_iov->iov_len == sizeof vectors->size &&
2958 G_STRUCT_OFFSET (struct iovec, iov_len) ==
2959 G_STRUCT_OFFSET (GOutputVector, size))
2960 /* ABI is compatible */
2962 msg.msg_iov = (struct iovec *) vectors;
2963 msg.msg_iovlen = num_vectors;
2966 /* ABI is incompatible */
2970 msg.msg_iov = g_newa (struct iovec, num_vectors);
2971 for (i = 0; i < num_vectors; i++)
2973 msg.msg_iov[i].iov_base = (void *) vectors[i].buffer;
2974 msg.msg_iov[i].iov_len = vectors[i].size;
2976 msg.msg_iovlen = num_vectors;
2982 struct cmsghdr *cmsg;
2985 msg.msg_controllen = 0;
2986 for (i = 0; i < num_messages; i++)
2987 msg.msg_controllen += CMSG_SPACE (g_socket_control_message_get_size (messages[i]));
2989 if (msg.msg_controllen == 0)
2990 msg.msg_control = NULL;
2993 msg.msg_control = g_alloca (msg.msg_controllen);
2994 memset (msg.msg_control, '\0', msg.msg_controllen);
2997 cmsg = CMSG_FIRSTHDR (&msg);
2998 for (i = 0; i < num_messages; i++)
3000 cmsg->cmsg_level = g_socket_control_message_get_level (messages[i]);
3001 cmsg->cmsg_type = g_socket_control_message_get_msg_type (messages[i]);
3002 cmsg->cmsg_len = CMSG_LEN (g_socket_control_message_get_size (messages[i]));
3003 g_socket_control_message_serialize (messages[i],
3005 cmsg = CMSG_NXTHDR (&msg, cmsg);
3007 g_assert (cmsg == NULL);
3012 if (socket->priv->blocking &&
3013 !g_socket_condition_wait (socket,
3014 G_IO_OUT, cancellable, error))
3017 result = sendmsg (socket->priv->fd, &msg, flags | G_SOCKET_DEFAULT_SEND_FLAGS);
3020 int errsv = get_socket_errno ();
3025 if (socket->priv->blocking &&
3026 (errsv == EWOULDBLOCK ||
3030 g_set_error (error, G_IO_ERROR,
3031 socket_io_error_from_errno (errsv),
3032 _("Error sending message: %s"), socket_strerror (errsv));
3043 struct sockaddr_storage addr;
3050 /* Win32 doesn't support control messages.
3051 Actually this is possible for raw and datagram sockets
3052 via WSASendMessage on Vista or later, but that doesn't
3054 if (num_messages != 0)
3056 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3057 _("GSocketControlMessage not supported on windows"));
3062 bufs = g_newa (WSABUF, num_vectors);
3063 for (i = 0; i < num_vectors; i++)
3065 bufs[i].buf = (char *)vectors[i].buffer;
3066 bufs[i].len = (gulong)vectors[i].size;
3070 addrlen = 0; /* Avoid warning */
3073 addrlen = g_socket_address_get_native_size (address);
3074 if (!g_socket_address_to_native (address, &addr, sizeof addr, error))
3080 if (socket->priv->blocking &&
3081 !g_socket_condition_wait (socket,
3082 G_IO_OUT, cancellable, error))
3086 result = WSASendTo (socket->priv->fd,
3089 (const struct sockaddr *)&addr, addrlen,
3092 result = WSASend (socket->priv->fd,
3099 int errsv = get_socket_errno ();
3101 if (errsv == WSAEINTR)
3104 if (errsv == WSAEWOULDBLOCK)
3105 win32_unset_event_mask (socket, FD_WRITE);
3107 if (socket->priv->blocking &&
3108 errsv == WSAEWOULDBLOCK)
3111 g_set_error (error, G_IO_ERROR,
3112 socket_io_error_from_errno (errsv),
3113 _("Error sending message: %s"), socket_strerror (errsv));
3126 * g_socket_receive_message:
3127 * @socket: a #GSocket
3128 * @address: a pointer to a #GSocketAddress pointer, or %NULL
3129 * @vectors: (array length=num_vectors): an array of #GInputVector structs
3130 * @num_vectors: the number of elements in @vectors, or -1
3131 * @messages: (array length=num_messages) (allow-none): a pointer which
3132 * may be filled with an array of #GSocketControlMessages, or %NULL
3133 * @num_messages: a pointer which will be filled with the number of
3134 * elements in @messages, or %NULL
3135 * @flags: a pointer to an int containing #GSocketMsgFlags flags
3136 * @cancellable: (allow-none): a %GCancellable or %NULL
3137 * @error: a #GError pointer, or %NULL
3139 * Receive data from a socket. This is the most complicated and
3140 * fully-featured version of this call. For easier use, see
3141 * g_socket_receive() and g_socket_receive_from().
3143 * If @address is non-%NULL then @address will be set equal to the
3144 * source address of the received packet.
3145 * @address is owned by the caller.
3147 * @vector must point to an array of #GInputVector structs and
3148 * @num_vectors must be the length of this array. These structs
3149 * describe the buffers that received data will be scattered into.
3150 * If @num_vectors is -1, then @vectors is assumed to be terminated
3151 * by a #GInputVector with a %NULL buffer pointer.
3153 * As a special case, if @num_vectors is 0 (in which case, @vectors
3154 * may of course be %NULL), then a single byte is received and
3155 * discarded. This is to facilitate the common practice of sending a
3156 * single '\0' byte for the purposes of transferring ancillary data.
3158 * @messages, if non-%NULL, will be set to point to a newly-allocated
3159 * array of #GSocketControlMessage instances or %NULL if no such
3160 * messages was received. These correspond to the control messages
3161 * received from the kernel, one #GSocketControlMessage per message
3162 * from the kernel. This array is %NULL-terminated and must be freed
3163 * by the caller using g_free() after calling g_object_unref() on each
3164 * element. If @messages is %NULL, any control messages received will
3167 * @num_messages, if non-%NULL, will be set to the number of control
3168 * messages received.
3170 * If both @messages and @num_messages are non-%NULL, then
3171 * @num_messages gives the number of #GSocketControlMessage instances
3172 * in @messages (ie: not including the %NULL terminator).
3174 * @flags is an in/out parameter. The commonly available arguments
3175 * for this are available in the #GSocketMsgFlags enum, but the
3176 * values there are the same as the system values, and the flags
3177 * are passed in as-is, so you can pass in system-specific flags too
3178 * (and g_socket_receive_message() may pass system-specific flags out).
3180 * As with g_socket_receive(), data may be discarded if @socket is
3181 * %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not
3182 * provide enough buffer space to read a complete message. You can pass
3183 * %G_SOCKET_MSG_PEEK in @flags to peek at the current message without
3184 * removing it from the receive queue, but there is no portable way to find
3185 * out the length of the message other than by reading it into a
3186 * sufficiently-large buffer.
3188 * If the socket is in blocking mode the call will block until there
3189 * is some data to receive, the connection is closed, or there is an
3190 * error. If there is no data available and the socket is in
3191 * non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error will be
3192 * returned. To be notified when data is available, wait for the
3193 * %G_IO_IN condition.
3195 * On error -1 is returned and @error is set accordingly.
3197 * Returns: Number of bytes read, or 0 if the connection was closed by
3198 * the peer, or -1 on error
3203 g_socket_receive_message (GSocket *socket,
3204 GSocketAddress **address,
3205 GInputVector *vectors,
3207 GSocketControlMessage ***messages,
3210 GCancellable *cancellable,
3213 GInputVector one_vector;
3216 if (!check_socket (socket, error))
3219 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3222 if (num_vectors == -1)
3224 for (num_vectors = 0;
3225 vectors[num_vectors].buffer != NULL;
3230 if (num_vectors == 0)
3232 one_vector.buffer = &one_byte;
3233 one_vector.size = 1;
3235 vectors = &one_vector;
3242 struct sockaddr_storage one_sockaddr;
3247 msg.msg_name = &one_sockaddr;
3248 msg.msg_namelen = sizeof (struct sockaddr_storage);
3252 msg.msg_name = NULL;
3253 msg.msg_namelen = 0;
3257 /* this entire expression will be evaluated at compile time */
3258 if (sizeof *msg.msg_iov == sizeof *vectors &&
3259 sizeof msg.msg_iov->iov_base == sizeof vectors->buffer &&
3260 G_STRUCT_OFFSET (struct iovec, iov_base) ==
3261 G_STRUCT_OFFSET (GInputVector, buffer) &&
3262 sizeof msg.msg_iov->iov_len == sizeof vectors->size &&
3263 G_STRUCT_OFFSET (struct iovec, iov_len) ==
3264 G_STRUCT_OFFSET (GInputVector, size))
3265 /* ABI is compatible */
3267 msg.msg_iov = (struct iovec *) vectors;
3268 msg.msg_iovlen = num_vectors;
3271 /* ABI is incompatible */
3275 msg.msg_iov = g_newa (struct iovec, num_vectors);
3276 for (i = 0; i < num_vectors; i++)
3278 msg.msg_iov[i].iov_base = vectors[i].buffer;
3279 msg.msg_iov[i].iov_len = vectors[i].size;
3281 msg.msg_iovlen = num_vectors;
3285 msg.msg_control = g_alloca (2048);
3286 msg.msg_controllen = 2048;
3290 msg.msg_flags = *flags;
3297 if (socket->priv->blocking &&
3298 !g_socket_condition_wait (socket,
3299 G_IO_IN, cancellable, error))
3302 result = recvmsg (socket->priv->fd, &msg, msg.msg_flags);
3306 int errsv = get_socket_errno ();
3311 if (socket->priv->blocking &&
3312 (errsv == EWOULDBLOCK ||
3316 g_set_error (error, G_IO_ERROR,
3317 socket_io_error_from_errno (errsv),
3318 _("Error receiving message: %s"), socket_strerror (errsv));
3325 /* decode address */
3326 if (address != NULL)
3328 if (msg.msg_namelen > 0)
3329 *address = g_socket_address_new_from_native (msg.msg_name,
3335 /* decode control messages */
3337 GPtrArray *my_messages = NULL;
3338 struct cmsghdr *cmsg;
3340 for (cmsg = CMSG_FIRSTHDR (&msg); cmsg; cmsg = CMSG_NXTHDR (&msg, cmsg))
3342 GSocketControlMessage *message;
3344 message = g_socket_control_message_deserialize (cmsg->cmsg_level,
3346 cmsg->cmsg_len - ((char *)CMSG_DATA (cmsg) - (char *)cmsg),
3348 if (message == NULL)
3349 /* We've already spewed about the problem in the
3350 deserialization code, so just continue */
3353 if (messages == NULL)
3355 /* we have to do it this way if the user ignores the
3356 * messages so that we will close any received fds.
3358 g_object_unref (message);
3362 if (my_messages == NULL)
3363 my_messages = g_ptr_array_new ();
3364 g_ptr_array_add (my_messages, message);
3369 *num_messages = my_messages != NULL ? my_messages->len : 0;
3373 if (my_messages == NULL)
3379 g_ptr_array_add (my_messages, NULL);
3380 *messages = (GSocketControlMessage **) g_ptr_array_free (my_messages, FALSE);
3385 g_assert (my_messages == NULL);
3389 /* capture the flags */
3391 *flags = msg.msg_flags;
3397 struct sockaddr_storage addr;
3399 DWORD bytes_received;
3406 bufs = g_newa (WSABUF, num_vectors);
3407 for (i = 0; i < num_vectors; i++)
3409 bufs[i].buf = (char *)vectors[i].buffer;
3410 bufs[i].len = (gulong)vectors[i].size;
3422 if (socket->priv->blocking &&
3423 !g_socket_condition_wait (socket,
3424 G_IO_IN, cancellable, error))
3427 addrlen = sizeof addr;
3429 result = WSARecvFrom (socket->priv->fd,
3431 &bytes_received, &win_flags,
3432 (struct sockaddr *)&addr, &addrlen,
3435 result = WSARecv (socket->priv->fd,
3437 &bytes_received, &win_flags,
3441 int errsv = get_socket_errno ();
3443 if (errsv == WSAEINTR)
3446 win32_unset_event_mask (socket, FD_READ);
3448 if (socket->priv->blocking &&
3449 errsv == WSAEWOULDBLOCK)
3452 g_set_error (error, G_IO_ERROR,
3453 socket_io_error_from_errno (errsv),
3454 _("Error receiving message: %s"), socket_strerror (errsv));
3458 win32_unset_event_mask (socket, FD_READ);
3462 /* decode address */
3463 if (address != NULL)
3466 *address = g_socket_address_new_from_native (&addr, addrlen);
3471 /* capture the flags */
3475 if (messages != NULL)
3477 if (num_messages != NULL)
3480 return bytes_received;
3486 * g_socket_get_credentials:
3487 * @socket: a #GSocket.
3488 * @error: #GError for error reporting, or %NULL to ignore.
3490 * Returns the credentials of the foreign process connected to this
3491 * socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX
3494 * If this operation isn't supported on the OS, the method fails with
3495 * the %G_IO_ERROR_NOT_SUPPORTED error. On Linux this is implemented
3496 * by reading the %SO_PEERCRED option on the underlying socket.
3498 * Other ways to obtain credentials from a foreign peer includes the
3499 * #GUnixCredentialsMessage type and
3500 * g_unix_connection_send_credentials() /
3501 * g_unix_connection_receive_credentials() functions.
3503 * Returns: (transfer full): %NULL if @error is set, otherwise a #GCredentials object
3504 * that must be freed with g_object_unref().
3509 g_socket_get_credentials (GSocket *socket,
3514 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
3515 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3521 struct ucred native_creds;
3523 optlen = sizeof (struct ucred);
3524 if (getsockopt (socket->priv->fd,
3527 (void *)&native_creds,
3530 int errsv = get_socket_errno ();
3533 socket_io_error_from_errno (errsv),
3534 _("Unable to get pending error: %s"),
3535 socket_strerror (errsv));
3539 ret = g_credentials_new ();
3540 g_credentials_set_native (ret,
3541 G_CREDENTIALS_TYPE_LINUX_UCRED,
3546 g_set_error_literal (error,
3548 G_IO_ERROR_NOT_SUPPORTED,
3549 _("g_socket_get_credentials not implemented for this OS"));