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>
33 #include "glib-unix.h"
44 # include <sys/ioctl.h>
47 #ifdef HAVE_SYS_FILIO_H
48 # include <sys/filio.h>
55 #include "gcancellable.h"
56 #include "gioenumtypes.h"
57 #include "ginetaddress.h"
58 #include "ginitable.h"
62 #include "gnetworking.h"
63 #include "gsocketaddress.h"
64 #include "gsocketcontrolmessage.h"
65 #include "gcredentials.h"
70 * @short_description: Low-level socket object
72 * @see_also: #GInitable, <link linkend="gio-gnetworking.h">gnetworking.h</link>
74 * A #GSocket is a low-level networking primitive. It is a more or less
75 * direct mapping of the BSD socket API in a portable GObject based API.
76 * It supports both the UNIX socket implementations and winsock2 on Windows.
78 * #GSocket is the platform independent base upon which the higher level
79 * network primitives are based. Applications are not typically meant to
80 * use it directly, but rather through classes like #GSocketClient,
81 * #GSocketService and #GSocketConnection. However there may be cases where
82 * direct use of #GSocket is useful.
84 * #GSocket implements the #GInitable interface, so if it is manually constructed
85 * by e.g. g_object_new() you must call g_initable_init() and check the
86 * results before using the object. This is done automatically in
87 * g_socket_new() and g_socket_new_from_fd(), so these functions can return
90 * Sockets operate in two general modes, blocking or non-blocking. When
91 * in blocking mode all operations block until the requested operation
92 * is finished or there is an error. In non-blocking mode all calls that
93 * would block return immediately with a %G_IO_ERROR_WOULD_BLOCK error.
94 * To know when a call would successfully run you can call g_socket_condition_check(),
95 * or g_socket_condition_wait(). You can also use g_socket_create_source() and
96 * attach it to a #GMainContext to get callbacks when I/O is possible.
97 * Note that all sockets are always set to non blocking mode in the system, and
98 * blocking mode is emulated in GSocket.
100 * When working in non-blocking mode applications should always be able to
101 * handle getting a %G_IO_ERROR_WOULD_BLOCK error even when some other
102 * function said that I/O was possible. This can easily happen in case
103 * of a race condition in the application, but it can also happen for other
104 * reasons. For instance, on Windows a socket is always seen as writable
105 * until a write returns %G_IO_ERROR_WOULD_BLOCK.
107 * #GSocket<!-- -->s can be either connection oriented or datagram based.
108 * For connection oriented types you must first establish a connection by
109 * either connecting to an address or accepting a connection from another
110 * address. For connectionless socket types the target/source address is
111 * specified or received in each I/O operation.
113 * All socket file descriptors are set to be close-on-exec.
115 * Note that creating a #GSocket causes the signal %SIGPIPE to be
116 * ignored for the remainder of the program. If you are writing a
117 * command-line utility that uses #GSocket, you may need to take into
118 * account the fact that your program will not automatically be killed
119 * if it tries to write to %stdout after it has been closed.
124 static void g_socket_initable_iface_init (GInitableIface *iface);
125 static gboolean g_socket_initable_init (GInitable *initable,
126 GCancellable *cancellable,
129 G_DEFINE_TYPE_WITH_CODE (GSocket, g_socket, G_TYPE_OBJECT,
130 g_networking_init ();
131 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE,
132 g_socket_initable_iface_init));
149 PROP_MULTICAST_LOOPBACK,
153 /* Size of the receiver cache for g_socket_receive_from() */
154 #define RECV_ADDR_CACHE_SIZE 8
156 struct _GSocketPrivate
158 GSocketFamily family;
160 GSocketProtocol protocol;
164 GError *construct_error;
165 GSocketAddress *remote_address;
173 guint connect_pending : 1;
179 GList *requested_conditions; /* list of requested GIOCondition * */
183 GSocketAddress *addr;
184 struct sockaddr *native;
187 } recv_addr_cache[RECV_ADDR_CACHE_SIZE];
191 get_socket_errno (void)
196 return WSAGetLastError ();
201 socket_io_error_from_errno (int err)
204 return g_io_error_from_errno (err);
209 return G_IO_ERROR_ADDRESS_IN_USE;
211 return G_IO_ERROR_WOULD_BLOCK;
213 return G_IO_ERROR_PERMISSION_DENIED;
214 case WSA_INVALID_HANDLE:
215 case WSA_INVALID_PARAMETER:
218 return G_IO_ERROR_INVALID_ARGUMENT;
219 case WSAEPROTONOSUPPORT:
220 return G_IO_ERROR_NOT_SUPPORTED;
222 return G_IO_ERROR_CANCELLED;
223 case WSAESOCKTNOSUPPORT:
225 case WSAEPFNOSUPPORT:
226 case WSAEAFNOSUPPORT:
227 return G_IO_ERROR_NOT_SUPPORTED;
229 return G_IO_ERROR_FAILED;
235 socket_strerror (int err)
238 return g_strerror (err);
243 msg = g_win32_error_message (err);
245 msg_ret = g_intern_string (msg);
253 #define win32_unset_event_mask(_socket, _mask) _win32_unset_event_mask (_socket, _mask)
255 _win32_unset_event_mask (GSocket *socket, int mask)
257 socket->priv->current_events &= ~mask;
258 socket->priv->current_errors &= ~mask;
261 #define win32_unset_event_mask(_socket, _mask)
264 /* Windows has broken prototypes... */
266 #define getsockopt(sockfd, level, optname, optval, optlen) \
267 getsockopt (sockfd, level, optname, (gpointer) optval, (int*) optlen)
268 #define setsockopt(sockfd, level, optname, optval, optlen) \
269 setsockopt (sockfd, level, optname, (gpointer) optval, optlen)
270 #define getsockname(sockfd, addr, addrlen) \
271 getsockname (sockfd, addr, (int *)addrlen)
272 #define getpeername(sockfd, addr, addrlen) \
273 getpeername (sockfd, addr, (int *)addrlen)
274 #define recv(sockfd, buf, len, flags) \
275 recv (sockfd, (gpointer)buf, len, flags)
279 set_fd_nonblocking (int fd)
282 GError *error = NULL;
288 if (!g_unix_set_fd_nonblocking (fd, TRUE, &error))
290 g_warning ("Error setting socket nonblocking: %s", error->message);
291 g_clear_error (&error);
296 if (ioctlsocket (fd, FIONBIO, &arg) == SOCKET_ERROR)
298 int errsv = get_socket_errno ();
299 g_warning ("Error setting socket status flags: %s", socket_strerror (errsv));
305 check_socket (GSocket *socket,
308 if (!socket->priv->inited)
310 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_INITIALIZED,
311 _("Invalid socket, not initialized"));
315 if (socket->priv->construct_error)
317 g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_INITIALIZED,
318 _("Invalid socket, initialization failed due to: %s"),
319 socket->priv->construct_error->message);
323 if (socket->priv->closed)
325 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
326 _("Socket is already closed"));
330 if (socket->priv->timed_out)
332 socket->priv->timed_out = FALSE;
333 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
334 _("Socket I/O timed out"));
342 g_socket_details_from_fd (GSocket *socket)
344 struct sockaddr_storage address;
350 fd = socket->priv->fd;
351 if (!g_socket_get_option (socket, SOL_SOCKET, SO_TYPE, &value, NULL))
353 errsv = get_socket_errno ();
365 /* programmer error */
366 g_error ("creating GSocket from fd %d: %s\n",
367 fd, socket_strerror (errsv));
378 socket->priv->type = G_SOCKET_TYPE_STREAM;
382 socket->priv->type = G_SOCKET_TYPE_DATAGRAM;
386 socket->priv->type = G_SOCKET_TYPE_SEQPACKET;
390 socket->priv->type = G_SOCKET_TYPE_INVALID;
394 addrlen = sizeof address;
395 if (getsockname (fd, (struct sockaddr *) &address, &addrlen) != 0)
397 errsv = get_socket_errno ();
403 g_assert (G_STRUCT_OFFSET (struct sockaddr, sa_family) +
404 sizeof address.ss_family <= addrlen);
405 family = address.ss_family;
409 /* On Solaris, this happens if the socket is not yet connected.
410 * But we can use SO_DOMAIN as a workaround there.
413 if (!g_socket_get_option (socket, SOL_SOCKET, SO_DOMAIN, &family, NULL))
415 errsv = get_socket_errno ();
419 /* This will translate to G_IO_ERROR_FAILED on either unix or windows */
427 case G_SOCKET_FAMILY_IPV4:
428 case G_SOCKET_FAMILY_IPV6:
429 socket->priv->family = address.ss_family;
430 switch (socket->priv->type)
432 case G_SOCKET_TYPE_STREAM:
433 socket->priv->protocol = G_SOCKET_PROTOCOL_TCP;
436 case G_SOCKET_TYPE_DATAGRAM:
437 socket->priv->protocol = G_SOCKET_PROTOCOL_UDP;
440 case G_SOCKET_TYPE_SEQPACKET:
441 socket->priv->protocol = G_SOCKET_PROTOCOL_SCTP;
449 case G_SOCKET_FAMILY_UNIX:
450 socket->priv->family = G_SOCKET_FAMILY_UNIX;
451 socket->priv->protocol = G_SOCKET_PROTOCOL_DEFAULT;
455 socket->priv->family = G_SOCKET_FAMILY_INVALID;
459 if (socket->priv->family != G_SOCKET_FAMILY_INVALID)
461 addrlen = sizeof address;
462 if (getpeername (fd, (struct sockaddr *) &address, &addrlen) >= 0)
463 socket->priv->connected = TRUE;
466 if (g_socket_get_option (socket, SOL_SOCKET, SO_KEEPALIVE, &value, NULL))
468 socket->priv->keepalive = !!value;
472 /* Can't read, maybe not supported, assume FALSE */
473 socket->priv->keepalive = FALSE;
479 g_set_error (&socket->priv->construct_error, G_IO_ERROR,
480 socket_io_error_from_errno (errsv),
481 _("creating GSocket from fd: %s"),
482 socket_strerror (errsv));
486 g_socket_create_socket (GSocketFamily family,
496 case G_SOCKET_TYPE_STREAM:
497 native_type = SOCK_STREAM;
500 case G_SOCKET_TYPE_DATAGRAM:
501 native_type = SOCK_DGRAM;
504 case G_SOCKET_TYPE_SEQPACKET:
505 native_type = SOCK_SEQPACKET;
509 g_assert_not_reached ();
514 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
515 _("Unable to create socket: %s"), _("Unknown family was specified"));
521 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
522 _("Unable to create socket: %s"), _("Unknown protocol was specified"));
527 fd = socket (family, native_type | SOCK_CLOEXEC, protocol);
528 /* It's possible that libc has SOCK_CLOEXEC but the kernel does not */
529 if (fd < 0 && errno == EINVAL)
531 fd = socket (family, native_type, protocol);
535 int errsv = get_socket_errno ();
537 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
538 _("Unable to create socket: %s"), socket_strerror (errsv));
545 /* We always want to set close-on-exec to protect users. If you
546 need to so some weird inheritance to exec you can re-enable this
547 using lower level hacks with g_socket_get_fd(). */
548 flags = fcntl (fd, F_GETFD, 0);
550 (flags & FD_CLOEXEC) == 0)
553 fcntl (fd, F_SETFD, flags);
562 g_socket_constructed (GObject *object)
564 GSocket *socket = G_SOCKET (object);
566 if (socket->priv->fd >= 0)
567 /* create socket->priv info from the fd */
568 g_socket_details_from_fd (socket);
571 /* create the fd from socket->priv info */
572 socket->priv->fd = g_socket_create_socket (socket->priv->family,
574 socket->priv->protocol,
575 &socket->priv->construct_error);
577 /* Always use native nonblocking sockets, as
578 windows sets sockets to nonblocking automatically
579 in certain operations. This way we make things work
580 the same on all platforms */
581 if (socket->priv->fd != -1)
582 set_fd_nonblocking (socket->priv->fd);
586 g_socket_get_property (GObject *object,
591 GSocket *socket = G_SOCKET (object);
592 GSocketAddress *address;
597 g_value_set_enum (value, socket->priv->family);
601 g_value_set_enum (value, socket->priv->type);
605 g_value_set_enum (value, socket->priv->protocol);
609 g_value_set_int (value, socket->priv->fd);
613 g_value_set_boolean (value, socket->priv->blocking);
616 case PROP_LISTEN_BACKLOG:
617 g_value_set_int (value, socket->priv->listen_backlog);
621 g_value_set_boolean (value, socket->priv->keepalive);
624 case PROP_LOCAL_ADDRESS:
625 address = g_socket_get_local_address (socket, NULL);
626 g_value_take_object (value, address);
629 case PROP_REMOTE_ADDRESS:
630 address = g_socket_get_remote_address (socket, NULL);
631 g_value_take_object (value, address);
635 g_value_set_uint (value, socket->priv->timeout);
639 g_value_set_uint (value, g_socket_get_ttl (socket));
643 g_value_set_boolean (value, g_socket_get_broadcast (socket));
646 case PROP_MULTICAST_LOOPBACK:
647 g_value_set_boolean (value, g_socket_get_multicast_loopback (socket));
650 case PROP_MULTICAST_TTL:
651 g_value_set_uint (value, g_socket_get_multicast_ttl (socket));
655 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
660 g_socket_set_property (GObject *object,
665 GSocket *socket = G_SOCKET (object);
670 socket->priv->family = g_value_get_enum (value);
674 socket->priv->type = g_value_get_enum (value);
678 socket->priv->protocol = g_value_get_enum (value);
682 socket->priv->fd = g_value_get_int (value);
686 g_socket_set_blocking (socket, g_value_get_boolean (value));
689 case PROP_LISTEN_BACKLOG:
690 g_socket_set_listen_backlog (socket, g_value_get_int (value));
694 g_socket_set_keepalive (socket, g_value_get_boolean (value));
698 g_socket_set_timeout (socket, g_value_get_uint (value));
702 g_socket_set_ttl (socket, g_value_get_uint (value));
706 g_socket_set_broadcast (socket, g_value_get_boolean (value));
709 case PROP_MULTICAST_LOOPBACK:
710 g_socket_set_multicast_loopback (socket, g_value_get_boolean (value));
713 case PROP_MULTICAST_TTL:
714 g_socket_set_multicast_ttl (socket, g_value_get_uint (value));
718 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
723 g_socket_finalize (GObject *object)
725 GSocket *socket = G_SOCKET (object);
728 g_clear_error (&socket->priv->construct_error);
730 if (socket->priv->fd != -1 &&
731 !socket->priv->closed)
732 g_socket_close (socket, NULL);
734 if (socket->priv->remote_address)
735 g_object_unref (socket->priv->remote_address);
738 if (socket->priv->event != WSA_INVALID_EVENT)
740 WSACloseEvent (socket->priv->event);
741 socket->priv->event = WSA_INVALID_EVENT;
744 g_assert (socket->priv->requested_conditions == NULL);
747 for (i = 0; i < RECV_ADDR_CACHE_SIZE; i++)
749 if (socket->priv->recv_addr_cache[i].addr)
751 g_object_unref (socket->priv->recv_addr_cache[i].addr);
752 g_free (socket->priv->recv_addr_cache[i].native);
756 if (G_OBJECT_CLASS (g_socket_parent_class)->finalize)
757 (*G_OBJECT_CLASS (g_socket_parent_class)->finalize) (object);
761 g_socket_class_init (GSocketClass *klass)
763 GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
766 /* There is no portable, thread-safe way to avoid having the process
767 * be killed by SIGPIPE when calling send() or sendmsg(), so we are
768 * forced to simply ignore the signal process-wide.
770 signal (SIGPIPE, SIG_IGN);
773 g_type_class_add_private (klass, sizeof (GSocketPrivate));
775 gobject_class->finalize = g_socket_finalize;
776 gobject_class->constructed = g_socket_constructed;
777 gobject_class->set_property = g_socket_set_property;
778 gobject_class->get_property = g_socket_get_property;
780 g_object_class_install_property (gobject_class, PROP_FAMILY,
781 g_param_spec_enum ("family",
783 P_("The sockets address family"),
784 G_TYPE_SOCKET_FAMILY,
785 G_SOCKET_FAMILY_INVALID,
786 G_PARAM_CONSTRUCT_ONLY |
788 G_PARAM_STATIC_STRINGS));
790 g_object_class_install_property (gobject_class, PROP_TYPE,
791 g_param_spec_enum ("type",
793 P_("The sockets type"),
795 G_SOCKET_TYPE_STREAM,
796 G_PARAM_CONSTRUCT_ONLY |
798 G_PARAM_STATIC_STRINGS));
800 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
801 g_param_spec_enum ("protocol",
802 P_("Socket protocol"),
803 P_("The id of the protocol to use, or -1 for unknown"),
804 G_TYPE_SOCKET_PROTOCOL,
805 G_SOCKET_PROTOCOL_UNKNOWN,
806 G_PARAM_CONSTRUCT_ONLY |
808 G_PARAM_STATIC_STRINGS));
810 g_object_class_install_property (gobject_class, PROP_FD,
811 g_param_spec_int ("fd",
812 P_("File descriptor"),
813 P_("The sockets file descriptor"),
817 G_PARAM_CONSTRUCT_ONLY |
819 G_PARAM_STATIC_STRINGS));
821 g_object_class_install_property (gobject_class, PROP_BLOCKING,
822 g_param_spec_boolean ("blocking",
824 P_("Whether or not I/O on this socket is blocking"),
827 G_PARAM_STATIC_STRINGS));
829 g_object_class_install_property (gobject_class, PROP_LISTEN_BACKLOG,
830 g_param_spec_int ("listen-backlog",
831 P_("Listen backlog"),
832 P_("Outstanding connections in the listen queue"),
837 G_PARAM_STATIC_STRINGS));
839 g_object_class_install_property (gobject_class, PROP_KEEPALIVE,
840 g_param_spec_boolean ("keepalive",
841 P_("Keep connection alive"),
842 P_("Keep connection alive by sending periodic pings"),
845 G_PARAM_STATIC_STRINGS));
847 g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
848 g_param_spec_object ("local-address",
850 P_("The local address the socket is bound to"),
851 G_TYPE_SOCKET_ADDRESS,
853 G_PARAM_STATIC_STRINGS));
855 g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
856 g_param_spec_object ("remote-address",
857 P_("Remote address"),
858 P_("The remote address the socket is connected to"),
859 G_TYPE_SOCKET_ADDRESS,
861 G_PARAM_STATIC_STRINGS));
866 * The timeout in seconds on socket I/O
870 g_object_class_install_property (gobject_class, PROP_TIMEOUT,
871 g_param_spec_uint ("timeout",
873 P_("The timeout in seconds on socket I/O"),
878 G_PARAM_STATIC_STRINGS));
883 * Whether the socket should allow sending to and receiving from broadcast addresses.
887 g_object_class_install_property (gobject_class, PROP_BROADCAST,
888 g_param_spec_boolean ("broadcast",
890 P_("Whether to allow sending to and receiving from broadcast addresses"),
893 G_PARAM_STATIC_STRINGS));
898 * Time-to-live for outgoing unicast packets
902 g_object_class_install_property (gobject_class, PROP_TTL,
903 g_param_spec_uint ("ttl",
905 P_("Time-to-live of outgoing unicast packets"),
908 G_PARAM_STATIC_STRINGS));
911 * GSocket:multicast-loopback:
913 * Whether outgoing multicast packets loop back to the local host.
917 g_object_class_install_property (gobject_class, PROP_MULTICAST_LOOPBACK,
918 g_param_spec_boolean ("multicast-loopback",
919 P_("Multicast loopback"),
920 P_("Whether outgoing multicast packets loop back to the local host"),
923 G_PARAM_STATIC_STRINGS));
926 * GSocket:multicast-ttl:
928 * Time-to-live out outgoing multicast packets
932 g_object_class_install_property (gobject_class, PROP_MULTICAST_TTL,
933 g_param_spec_uint ("multicast-ttl",
935 P_("Time-to-live of outgoing multicast packets"),
938 G_PARAM_STATIC_STRINGS));
942 g_socket_initable_iface_init (GInitableIface *iface)
944 iface->init = g_socket_initable_init;
948 g_socket_init (GSocket *socket)
950 socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket, G_TYPE_SOCKET, GSocketPrivate);
952 socket->priv->fd = -1;
953 socket->priv->blocking = TRUE;
954 socket->priv->listen_backlog = 10;
955 socket->priv->construct_error = NULL;
957 socket->priv->event = WSA_INVALID_EVENT;
962 g_socket_initable_init (GInitable *initable,
963 GCancellable *cancellable,
968 g_return_val_if_fail (G_IS_SOCKET (initable), FALSE);
970 socket = G_SOCKET (initable);
972 if (cancellable != NULL)
974 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
975 _("Cancellable initialization not supported"));
979 socket->priv->inited = TRUE;
981 if (socket->priv->construct_error)
984 *error = g_error_copy (socket->priv->construct_error);
994 * @family: the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.
995 * @type: the socket type to use.
996 * @protocol: the id of the protocol to use, or 0 for default.
997 * @error: #GError for error reporting, or %NULL to ignore.
999 * Creates a new #GSocket with the defined family, type and protocol.
1000 * If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type
1001 * for the family and type is used.
1003 * The @protocol is a family and type specific int that specifies what
1004 * kind of protocol to use. #GSocketProtocol lists several common ones.
1005 * Many families only support one protocol, and use 0 for this, others
1006 * support several and using 0 means to use the default protocol for
1007 * the family and type.
1009 * The protocol id is passed directly to the operating
1010 * system, so you can use protocols not listed in #GSocketProtocol if you
1011 * know the protocol number used for it.
1013 * Returns: a #GSocket or %NULL on error.
1014 * Free the returned object with g_object_unref().
1019 g_socket_new (GSocketFamily family,
1021 GSocketProtocol protocol,
1024 return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
1028 "protocol", protocol,
1033 * g_socket_new_from_fd:
1034 * @fd: a native socket file descriptor.
1035 * @error: #GError for error reporting, or %NULL to ignore.
1037 * Creates a new #GSocket from a native file descriptor
1038 * or winsock SOCKET handle.
1040 * This reads all the settings from the file descriptor so that
1041 * all properties should work. Note that the file descriptor
1042 * will be set to non-blocking mode, independent on the blocking
1043 * mode of the #GSocket.
1045 * Returns: a #GSocket or %NULL on error.
1046 * Free the returned object with g_object_unref().
1051 g_socket_new_from_fd (gint fd,
1054 return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
1061 * g_socket_set_blocking:
1062 * @socket: a #GSocket.
1063 * @blocking: Whether to use blocking I/O or not.
1065 * Sets the blocking mode of the socket. In blocking mode
1066 * all operations block until they succeed or there is an error. In
1067 * non-blocking mode all functions return results immediately or
1068 * with a %G_IO_ERROR_WOULD_BLOCK error.
1070 * All sockets are created in blocking mode. However, note that the
1071 * platform level socket is always non-blocking, and blocking mode
1072 * is a GSocket level feature.
1077 g_socket_set_blocking (GSocket *socket,
1080 g_return_if_fail (G_IS_SOCKET (socket));
1082 blocking = !!blocking;
1084 if (socket->priv->blocking == blocking)
1087 socket->priv->blocking = blocking;
1088 g_object_notify (G_OBJECT (socket), "blocking");
1092 * g_socket_get_blocking:
1093 * @socket: a #GSocket.
1095 * Gets the blocking mode of the socket. For details on blocking I/O,
1096 * see g_socket_set_blocking().
1098 * Returns: %TRUE if blocking I/O is used, %FALSE otherwise.
1103 g_socket_get_blocking (GSocket *socket)
1105 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1107 return socket->priv->blocking;
1111 * g_socket_set_keepalive:
1112 * @socket: a #GSocket.
1113 * @keepalive: Value for the keepalive flag
1115 * Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When
1116 * this flag is set on a socket, the system will attempt to verify that the
1117 * remote socket endpoint is still present if a sufficiently long period of
1118 * time passes with no data being exchanged. If the system is unable to
1119 * verify the presence of the remote endpoint, it will automatically close
1122 * This option is only functional on certain kinds of sockets. (Notably,
1123 * %G_SOCKET_PROTOCOL_TCP sockets.)
1125 * The exact time between pings is system- and protocol-dependent, but will
1126 * normally be at least two hours. Most commonly, you would set this flag
1127 * on a server socket if you want to allow clients to remain idle for long
1128 * periods of time, but also want to ensure that connections are eventually
1129 * garbage-collected if clients crash or become unreachable.
1134 g_socket_set_keepalive (GSocket *socket,
1137 GError *error = NULL;
1139 g_return_if_fail (G_IS_SOCKET (socket));
1141 keepalive = !!keepalive;
1142 if (socket->priv->keepalive == keepalive)
1145 if (!g_socket_set_option (socket, SOL_SOCKET, SO_KEEPALIVE,
1148 g_warning ("error setting keepalive: %s", error->message);
1149 g_error_free (error);
1153 socket->priv->keepalive = keepalive;
1154 g_object_notify (G_OBJECT (socket), "keepalive");
1158 * g_socket_get_keepalive:
1159 * @socket: a #GSocket.
1161 * Gets the keepalive mode of the socket. For details on this,
1162 * see g_socket_set_keepalive().
1164 * Returns: %TRUE if keepalive is active, %FALSE otherwise.
1169 g_socket_get_keepalive (GSocket *socket)
1171 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1173 return socket->priv->keepalive;
1177 * g_socket_get_listen_backlog:
1178 * @socket: a #GSocket.
1180 * Gets the listen backlog setting of the socket. For details on this,
1181 * see g_socket_set_listen_backlog().
1183 * Returns: the maximum number of pending connections.
1188 g_socket_get_listen_backlog (GSocket *socket)
1190 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1192 return socket->priv->listen_backlog;
1196 * g_socket_set_listen_backlog:
1197 * @socket: a #GSocket.
1198 * @backlog: the maximum number of pending connections.
1200 * Sets the maximum number of outstanding connections allowed
1201 * when listening on this socket. If more clients than this are
1202 * connecting to the socket and the application is not handling them
1203 * on time then the new connections will be refused.
1205 * Note that this must be called before g_socket_listen() and has no
1206 * effect if called after that.
1211 g_socket_set_listen_backlog (GSocket *socket,
1214 g_return_if_fail (G_IS_SOCKET (socket));
1215 g_return_if_fail (!socket->priv->listening);
1217 if (backlog != socket->priv->listen_backlog)
1219 socket->priv->listen_backlog = backlog;
1220 g_object_notify (G_OBJECT (socket), "listen-backlog");
1225 * g_socket_get_timeout:
1226 * @socket: a #GSocket.
1228 * Gets the timeout setting of the socket. For details on this, see
1229 * g_socket_set_timeout().
1231 * Returns: the timeout in seconds
1236 g_socket_get_timeout (GSocket *socket)
1238 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1240 return socket->priv->timeout;
1244 * g_socket_set_timeout:
1245 * @socket: a #GSocket.
1246 * @timeout: the timeout for @socket, in seconds, or 0 for none
1248 * Sets the time in seconds after which I/O operations on @socket will
1249 * time out if they have not yet completed.
1251 * On a blocking socket, this means that any blocking #GSocket
1252 * operation will time out after @timeout seconds of inactivity,
1253 * returning %G_IO_ERROR_TIMED_OUT.
1255 * On a non-blocking socket, calls to g_socket_condition_wait() will
1256 * also fail with %G_IO_ERROR_TIMED_OUT after the given time. Sources
1257 * created with g_socket_create_source() will trigger after
1258 * @timeout seconds of inactivity, with the requested condition
1259 * set, at which point calling g_socket_receive(), g_socket_send(),
1260 * g_socket_check_connect_result(), etc, will fail with
1261 * %G_IO_ERROR_TIMED_OUT.
1263 * If @timeout is 0 (the default), operations will never time out
1266 * Note that if an I/O operation is interrupted by a signal, this may
1267 * cause the timeout to be reset.
1272 g_socket_set_timeout (GSocket *socket,
1275 g_return_if_fail (G_IS_SOCKET (socket));
1277 if (timeout != socket->priv->timeout)
1279 socket->priv->timeout = timeout;
1280 g_object_notify (G_OBJECT (socket), "timeout");
1286 * @socket: a #GSocket.
1288 * Gets the unicast time-to-live setting on @socket; see
1289 * g_socket_set_ttl() for more details.
1291 * Returns: the time-to-live setting on @socket
1296 g_socket_get_ttl (GSocket *socket)
1298 GError *error = NULL;
1301 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1303 if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1305 g_socket_get_option (socket, IPPROTO_IP, IP_TTL,
1308 else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1310 g_socket_get_option (socket, IPPROTO_IPV6, IPV6_UNICAST_HOPS,
1314 g_return_val_if_reached (0);
1318 g_warning ("error getting unicast ttl: %s", error->message);
1319 g_error_free (error);
1328 * @socket: a #GSocket.
1329 * @ttl: the time-to-live value for all unicast packets on @socket
1331 * Sets the time-to-live for outgoing unicast packets on @socket.
1332 * By default the platform-specific default value is used.
1337 g_socket_set_ttl (GSocket *socket,
1340 GError *error = NULL;
1342 g_return_if_fail (G_IS_SOCKET (socket));
1344 if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1346 g_socket_set_option (socket, IPPROTO_IP, IP_TTL,
1349 else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1351 g_socket_set_option (socket, IPPROTO_IP, IP_TTL,
1353 g_socket_set_option (socket, IPPROTO_IPV6, IPV6_UNICAST_HOPS,
1357 g_return_if_reached ();
1361 g_warning ("error setting unicast ttl: %s", error->message);
1362 g_error_free (error);
1366 g_object_notify (G_OBJECT (socket), "ttl");
1370 * g_socket_get_broadcast:
1371 * @socket: a #GSocket.
1373 * Gets the broadcast setting on @socket; if %TRUE,
1374 * it is possible to send packets to broadcast
1375 * addresses or receive from broadcast addresses.
1377 * Returns: the broadcast setting on @socket
1382 g_socket_get_broadcast (GSocket *socket)
1384 GError *error = NULL;
1387 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1389 if (!g_socket_get_option (socket, SOL_SOCKET, SO_BROADCAST,
1392 g_warning ("error getting broadcast: %s", error->message);
1393 g_error_free (error);
1401 * g_socket_set_broadcast:
1402 * @socket: a #GSocket.
1403 * @broadcast: whether @socket should allow sending to and receiving
1404 * from broadcast addresses
1406 * Sets whether @socket should allow sending to and receiving from
1407 * broadcast addresses. This is %FALSE by default.
1412 g_socket_set_broadcast (GSocket *socket,
1415 GError *error = NULL;
1417 g_return_if_fail (G_IS_SOCKET (socket));
1419 broadcast = !!broadcast;
1421 if (!g_socket_set_option (socket, SOL_SOCKET, SO_BROADCAST,
1424 g_warning ("error setting broadcast: %s", error->message);
1425 g_error_free (error);
1429 g_object_notify (G_OBJECT (socket), "broadcast");
1433 * g_socket_get_multicast_loopback:
1434 * @socket: a #GSocket.
1436 * Gets the multicast loopback setting on @socket; if %TRUE (the
1437 * default), outgoing multicast packets will be looped back to
1438 * multicast listeners on the same host.
1440 * Returns: the multicast loopback setting on @socket
1445 g_socket_get_multicast_loopback (GSocket *socket)
1447 GError *error = NULL;
1450 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1452 if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1454 g_socket_get_option (socket, IPPROTO_IP, IP_MULTICAST_LOOP,
1457 else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1459 g_socket_get_option (socket, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
1463 g_return_val_if_reached (FALSE);
1467 g_warning ("error getting multicast loopback: %s", error->message);
1468 g_error_free (error);
1476 * g_socket_set_multicast_loopback:
1477 * @socket: a #GSocket.
1478 * @loopback: whether @socket should receive messages sent to its
1479 * multicast groups from the local host
1481 * Sets whether outgoing multicast packets will be received by sockets
1482 * listening on that multicast address on the same host. This is %TRUE
1488 g_socket_set_multicast_loopback (GSocket *socket,
1491 GError *error = NULL;
1493 g_return_if_fail (G_IS_SOCKET (socket));
1495 loopback = !!loopback;
1497 if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1499 g_socket_set_option (socket, IPPROTO_IP, IP_MULTICAST_LOOP,
1502 else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1504 g_socket_set_option (socket, IPPROTO_IP, IP_MULTICAST_LOOP,
1506 g_socket_set_option (socket, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
1510 g_return_if_reached ();
1514 g_warning ("error setting multicast loopback: %s", error->message);
1515 g_error_free (error);
1519 g_object_notify (G_OBJECT (socket), "multicast-loopback");
1523 * g_socket_get_multicast_ttl:
1524 * @socket: a #GSocket.
1526 * Gets the multicast time-to-live setting on @socket; see
1527 * g_socket_set_multicast_ttl() for more details.
1529 * Returns: the multicast time-to-live setting on @socket
1534 g_socket_get_multicast_ttl (GSocket *socket)
1536 GError *error = NULL;
1539 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1541 if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1543 g_socket_get_option (socket, IPPROTO_IP, IP_MULTICAST_TTL,
1546 else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1548 g_socket_get_option (socket, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
1552 g_return_val_if_reached (FALSE);
1556 g_warning ("error getting multicast ttl: %s", error->message);
1557 g_error_free (error);
1565 * g_socket_set_multicast_ttl:
1566 * @socket: a #GSocket.
1567 * @ttl: the time-to-live value for all multicast datagrams on @socket
1569 * Sets the time-to-live for outgoing multicast datagrams on @socket.
1570 * By default, this is 1, meaning that multicast packets will not leave
1571 * the local network.
1576 g_socket_set_multicast_ttl (GSocket *socket,
1579 GError *error = NULL;
1581 g_return_if_fail (G_IS_SOCKET (socket));
1583 if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1585 g_socket_set_option (socket, IPPROTO_IP, IP_MULTICAST_TTL,
1588 else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1590 g_socket_set_option (socket, IPPROTO_IP, IP_MULTICAST_TTL,
1592 g_socket_set_option (socket, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
1596 g_return_if_reached ();
1600 g_warning ("error setting multicast ttl: %s", error->message);
1601 g_error_free (error);
1605 g_object_notify (G_OBJECT (socket), "multicast-ttl");
1609 * g_socket_get_family:
1610 * @socket: a #GSocket.
1612 * Gets the socket family of the socket.
1614 * Returns: a #GSocketFamily
1619 g_socket_get_family (GSocket *socket)
1621 g_return_val_if_fail (G_IS_SOCKET (socket), G_SOCKET_FAMILY_INVALID);
1623 return socket->priv->family;
1627 * g_socket_get_socket_type:
1628 * @socket: a #GSocket.
1630 * Gets the socket type of the socket.
1632 * Returns: a #GSocketType
1637 g_socket_get_socket_type (GSocket *socket)
1639 g_return_val_if_fail (G_IS_SOCKET (socket), G_SOCKET_TYPE_INVALID);
1641 return socket->priv->type;
1645 * g_socket_get_protocol:
1646 * @socket: a #GSocket.
1648 * Gets the socket protocol id the socket was created with.
1649 * In case the protocol is unknown, -1 is returned.
1651 * Returns: a protocol id, or -1 if unknown
1656 g_socket_get_protocol (GSocket *socket)
1658 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
1660 return socket->priv->protocol;
1665 * @socket: a #GSocket.
1667 * Returns the underlying OS socket object. On unix this
1668 * is a socket file descriptor, and on Windows this is
1669 * a Winsock2 SOCKET handle. This may be useful for
1670 * doing platform specific or otherwise unusual operations
1673 * Returns: the file descriptor of the socket.
1678 g_socket_get_fd (GSocket *socket)
1680 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
1682 return socket->priv->fd;
1686 * g_socket_get_local_address:
1687 * @socket: a #GSocket.
1688 * @error: #GError for error reporting, or %NULL to ignore.
1690 * Try to get the local address of a bound socket. This is only
1691 * useful if the socket has been bound to a local address,
1692 * either explicitly or implicitly when connecting.
1694 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
1695 * Free the returned object with g_object_unref().
1700 g_socket_get_local_address (GSocket *socket,
1703 struct sockaddr_storage buffer;
1704 guint len = sizeof (buffer);
1706 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1708 if (getsockname (socket->priv->fd, (struct sockaddr *) &buffer, &len) < 0)
1710 int errsv = get_socket_errno ();
1711 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1712 _("could not get local address: %s"), socket_strerror (errsv));
1716 return g_socket_address_new_from_native (&buffer, len);
1720 * g_socket_get_remote_address:
1721 * @socket: a #GSocket.
1722 * @error: #GError for error reporting, or %NULL to ignore.
1724 * Try to get the remove address of a connected socket. This is only
1725 * useful for connection oriented sockets that have been connected.
1727 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
1728 * Free the returned object with g_object_unref().
1733 g_socket_get_remote_address (GSocket *socket,
1736 struct sockaddr_storage buffer;
1737 guint len = sizeof (buffer);
1739 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1741 if (socket->priv->connect_pending)
1743 if (!g_socket_check_connect_result (socket, error))
1746 socket->priv->connect_pending = FALSE;
1749 if (!socket->priv->remote_address)
1751 if (getpeername (socket->priv->fd, (struct sockaddr *) &buffer, &len) < 0)
1753 int errsv = get_socket_errno ();
1754 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1755 _("could not get remote address: %s"), socket_strerror (errsv));
1759 socket->priv->remote_address = g_socket_address_new_from_native (&buffer, len);
1762 return g_object_ref (socket->priv->remote_address);
1766 * g_socket_is_connected:
1767 * @socket: a #GSocket.
1769 * Check whether the socket is connected. This is only useful for
1770 * connection-oriented sockets.
1772 * Returns: %TRUE if socket is connected, %FALSE otherwise.
1777 g_socket_is_connected (GSocket *socket)
1779 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1781 return socket->priv->connected;
1786 * @socket: a #GSocket.
1787 * @error: #GError for error reporting, or %NULL to ignore.
1789 * Marks the socket as a server socket, i.e. a socket that is used
1790 * to accept incoming requests using g_socket_accept().
1792 * Before calling this the socket must be bound to a local address using
1795 * To set the maximum amount of outstanding clients, use
1796 * g_socket_set_listen_backlog().
1798 * Returns: %TRUE on success, %FALSE on error.
1803 g_socket_listen (GSocket *socket,
1806 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1808 if (!check_socket (socket, error))
1811 if (listen (socket->priv->fd, socket->priv->listen_backlog) < 0)
1813 int errsv = get_socket_errno ();
1815 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1816 _("could not listen: %s"), socket_strerror (errsv));
1820 socket->priv->listening = TRUE;
1827 * @socket: a #GSocket.
1828 * @address: a #GSocketAddress specifying the local address.
1829 * @allow_reuse: whether to allow reusing this address
1830 * @error: #GError for error reporting, or %NULL to ignore.
1832 * When a socket is created it is attached to an address family, but it
1833 * doesn't have an address in this family. g_socket_bind() assigns the
1834 * address (sometimes called name) of the socket.
1836 * It is generally required to bind to a local address before you can
1837 * receive connections. (See g_socket_listen() and g_socket_accept() ).
1838 * In certain situations, you may also want to bind a socket that will be
1839 * used to initiate connections, though this is not normally required.
1841 * @allow_reuse should be %TRUE for server sockets (sockets that you will
1842 * eventually call g_socket_accept() on), and %FALSE for client sockets.
1843 * (Specifically, if it is %TRUE, then g_socket_bind() will set the
1844 * %SO_REUSEADDR flag on the socket, allowing it to bind @address even if
1845 * that address was previously used by another socket that has not yet been
1846 * fully cleaned-up by the kernel. Failing to set this flag on a server
1847 * socket may cause the bind call to return %G_IO_ERROR_ADDRESS_IN_USE if
1848 * the server program is stopped and then immediately restarted.)
1850 * Returns: %TRUE on success, %FALSE on error.
1855 g_socket_bind (GSocket *socket,
1856 GSocketAddress *address,
1857 gboolean reuse_address,
1860 struct sockaddr_storage addr;
1862 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
1864 if (!check_socket (socket, error))
1867 /* SO_REUSEADDR on Windows means something else and is not what we want.
1868 It always allows the unix variant of SO_REUSEADDR anyway */
1871 reuse_address = !!reuse_address;
1872 /* Ignore errors here, the only likely error is "not supported", and
1873 this is a "best effort" thing mainly */
1874 g_socket_set_option (socket, SOL_SOCKET, SO_REUSEADDR,
1875 reuse_address, NULL);
1879 if (!g_socket_address_to_native (address, &addr, sizeof addr, error))
1882 if (bind (socket->priv->fd, (struct sockaddr *) &addr,
1883 g_socket_address_get_native_size (address)) < 0)
1885 int errsv = get_socket_errno ();
1887 G_IO_ERROR, socket_io_error_from_errno (errsv),
1888 _("Error binding to address: %s"), socket_strerror (errsv));
1896 g_socket_multicast_group_operation (GSocket *socket,
1897 GInetAddress *group,
1898 gboolean source_specific,
1900 gboolean join_group,
1903 const guint8 *native_addr;
1904 gint optname, result;
1906 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1907 g_return_val_if_fail (socket->priv->type == G_SOCKET_TYPE_DATAGRAM, FALSE);
1908 g_return_val_if_fail (G_IS_INET_ADDRESS (group), FALSE);
1910 if (!check_socket (socket, error))
1913 native_addr = g_inet_address_to_bytes (group);
1914 if (g_inet_address_get_family (group) == G_SOCKET_FAMILY_IPV4)
1916 #ifdef HAVE_IP_MREQN
1917 struct ip_mreqn mc_req;
1919 struct ip_mreq mc_req;
1922 memset (&mc_req, 0, sizeof (mc_req));
1923 memcpy (&mc_req.imr_multiaddr, native_addr, sizeof (struct in_addr));
1925 #ifdef HAVE_IP_MREQN
1927 mc_req.imr_ifindex = if_nametoindex (iface);
1929 mc_req.imr_ifindex = 0; /* Pick any. */
1931 mc_req.imr_interface.s_addr = g_htonl (INADDR_ANY);
1934 if (source_specific)
1936 #ifdef IP_ADD_SOURCE_MEMBERSHIP
1937 optname = join_group ? IP_ADD_SOURCE_MEMBERSHIP : IP_DROP_SOURCE_MEMBERSHIP;
1939 g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
1941 _("Error joining multicast group: %s") :
1942 _("Error leaving multicast group: %s"),
1943 _("No support for source-specific multicast"));
1948 optname = join_group ? IP_ADD_MEMBERSHIP : IP_DROP_MEMBERSHIP;
1949 result = setsockopt (socket->priv->fd, IPPROTO_IP, optname,
1950 &mc_req, sizeof (mc_req));
1952 else if (g_inet_address_get_family (group) == G_SOCKET_FAMILY_IPV6)
1954 struct ipv6_mreq mc_req_ipv6;
1956 memset (&mc_req_ipv6, 0, sizeof (mc_req_ipv6));
1957 memcpy (&mc_req_ipv6.ipv6mr_multiaddr, native_addr, sizeof (struct in6_addr));
1958 #ifdef HAVE_IF_NAMETOINDEX
1960 mc_req_ipv6.ipv6mr_interface = if_nametoindex (iface);
1963 mc_req_ipv6.ipv6mr_interface = 0;
1965 optname = join_group ? IPV6_JOIN_GROUP : IPV6_LEAVE_GROUP;
1966 result = setsockopt (socket->priv->fd, IPPROTO_IPV6, optname,
1967 &mc_req_ipv6, sizeof (mc_req_ipv6));
1970 g_return_val_if_reached (FALSE);
1974 int errsv = get_socket_errno ();
1976 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1978 _("Error joining multicast group: %s") :
1979 _("Error leaving multicast group: %s"),
1980 socket_strerror (errsv));
1988 * g_socket_join_multicast_group:
1989 * @socket: a #GSocket.
1990 * @group: a #GInetAddress specifying the group address to join.
1991 * @iface: (allow-none): Name of the interface to use, or %NULL
1992 * @source_specific: %TRUE if source-specific multicast should be used
1993 * @error: #GError for error reporting, or %NULL to ignore.
1995 * Registers @socket to receive multicast messages sent to @group.
1996 * @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have
1997 * been bound to an appropriate interface and port with
2000 * If @iface is %NULL, the system will automatically pick an interface
2001 * to bind to based on @group.
2003 * If @source_specific is %TRUE, source-specific multicast as defined
2004 * in RFC 4604 is used. Note that on older platforms this may fail
2005 * with a %G_IO_ERROR_NOT_SUPPORTED error.
2007 * Returns: %TRUE on success, %FALSE on error.
2012 g_socket_join_multicast_group (GSocket *socket,
2013 GInetAddress *group,
2014 gboolean source_specific,
2018 return g_socket_multicast_group_operation (socket, group, source_specific, iface, TRUE, error);
2022 * g_socket_leave_multicast_group:
2023 * @socket: a #GSocket.
2024 * @group: a #GInetAddress specifying the group address to leave.
2025 * @iface: (allow-none): Interface used
2026 * @source_specific: %TRUE if source-specific multicast was used
2027 * @error: #GError for error reporting, or %NULL to ignore.
2029 * Removes @socket from the multicast group defined by @group, @iface,
2030 * and @source_specific (which must all have the same values they had
2031 * when you joined the group).
2033 * @socket remains bound to its address and port, and can still receive
2034 * unicast messages after calling this.
2036 * Returns: %TRUE on success, %FALSE on error.
2041 g_socket_leave_multicast_group (GSocket *socket,
2042 GInetAddress *group,
2043 gboolean source_specific,
2047 return g_socket_multicast_group_operation (socket, group, source_specific, iface, FALSE, error);
2051 * g_socket_speaks_ipv4:
2052 * @socket: a #GSocket
2054 * Checks if a socket is capable of speaking IPv4.
2056 * IPv4 sockets are capable of speaking IPv4. On some operating systems
2057 * and under some combinations of circumstances IPv6 sockets are also
2058 * capable of speaking IPv4. See RFC 3493 section 3.7 for more
2061 * No other types of sockets are currently considered as being capable
2064 * Returns: %TRUE if this socket can be used with IPv4.
2069 g_socket_speaks_ipv4 (GSocket *socket)
2071 switch (socket->priv->family)
2073 case G_SOCKET_FAMILY_IPV4:
2076 case G_SOCKET_FAMILY_IPV6:
2077 #if defined (IPPROTO_IPV6) && defined (IPV6_V6ONLY)
2081 if (!g_socket_get_option (socket,
2082 IPPROTO_IPV6, IPV6_V6ONLY,
2099 * @socket: a #GSocket.
2100 * @cancellable: (allow-none): a %GCancellable or %NULL
2101 * @error: #GError for error reporting, or %NULL to ignore.
2103 * Accept incoming connections on a connection-based socket. This removes
2104 * the first outstanding connection request from the listening socket and
2105 * creates a #GSocket object for it.
2107 * The @socket must be bound to a local address with g_socket_bind() and
2108 * must be listening for incoming connections (g_socket_listen()).
2110 * If there are no outstanding connections then the operation will block
2111 * or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled.
2112 * To be notified of an incoming connection, wait for the %G_IO_IN condition.
2114 * Returns: (transfer full): a new #GSocket, or %NULL on error.
2115 * Free the returned object with g_object_unref().
2120 g_socket_accept (GSocket *socket,
2121 GCancellable *cancellable,
2124 GSocket *new_socket;
2127 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
2129 if (!check_socket (socket, error))
2134 if (socket->priv->blocking &&
2135 !g_socket_condition_wait (socket,
2136 G_IO_IN, cancellable, error))
2139 if ((ret = accept (socket->priv->fd, NULL, 0)) < 0)
2141 int errsv = get_socket_errno ();
2143 win32_unset_event_mask (socket, FD_ACCEPT);
2148 if (socket->priv->blocking)
2150 #ifdef WSAEWOULDBLOCK
2151 if (errsv == WSAEWOULDBLOCK)
2154 if (errsv == EWOULDBLOCK ||
2160 g_set_error (error, G_IO_ERROR,
2161 socket_io_error_from_errno (errsv),
2162 _("Error accepting connection: %s"), socket_strerror (errsv));
2168 win32_unset_event_mask (socket, FD_ACCEPT);
2172 /* The socket inherits the accepting sockets event mask and even object,
2173 we need to remove that */
2174 WSAEventSelect (ret, NULL, 0);
2180 /* We always want to set close-on-exec to protect users. If you
2181 need to so some weird inheritance to exec you can re-enable this
2182 using lower level hacks with g_socket_get_fd(). */
2183 flags = fcntl (ret, F_GETFD, 0);
2185 (flags & FD_CLOEXEC) == 0)
2187 flags |= FD_CLOEXEC;
2188 fcntl (ret, F_SETFD, flags);
2193 new_socket = g_socket_new_from_fd (ret, error);
2194 if (new_socket == NULL)
2203 new_socket->priv->protocol = socket->priv->protocol;
2210 * @socket: a #GSocket.
2211 * @address: a #GSocketAddress specifying the remote address.
2212 * @cancellable: (allow-none): a %GCancellable or %NULL
2213 * @error: #GError for error reporting, or %NULL to ignore.
2215 * Connect the socket to the specified remote address.
2217 * For connection oriented socket this generally means we attempt to make
2218 * a connection to the @address. For a connection-less socket it sets
2219 * the default address for g_socket_send() and discards all incoming datagrams
2220 * from other sources.
2222 * Generally connection oriented sockets can only connect once, but
2223 * connection-less sockets can connect multiple times to change the
2226 * If the connect call needs to do network I/O it will block, unless
2227 * non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned
2228 * and the user can be notified of the connection finishing by waiting
2229 * for the G_IO_OUT condition. The result of the connection must then be
2230 * checked with g_socket_check_connect_result().
2232 * Returns: %TRUE if connected, %FALSE on error.
2237 g_socket_connect (GSocket *socket,
2238 GSocketAddress *address,
2239 GCancellable *cancellable,
2242 struct sockaddr_storage buffer;
2244 g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
2246 if (!check_socket (socket, error))
2249 if (!g_socket_address_to_native (address, &buffer, sizeof buffer, error))
2252 if (socket->priv->remote_address)
2253 g_object_unref (socket->priv->remote_address);
2254 socket->priv->remote_address = g_object_ref (address);
2258 if (connect (socket->priv->fd, (struct sockaddr *) &buffer,
2259 g_socket_address_get_native_size (address)) < 0)
2261 int errsv = get_socket_errno ();
2267 if (errsv == EINPROGRESS)
2269 if (errsv == WSAEWOULDBLOCK)
2272 if (socket->priv->blocking)
2274 if (g_socket_condition_wait (socket, G_IO_OUT, cancellable, error))
2276 if (g_socket_check_connect_result (socket, error))
2282 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
2283 _("Connection in progress"));
2284 socket->priv->connect_pending = TRUE;
2288 g_set_error_literal (error, G_IO_ERROR,
2289 socket_io_error_from_errno (errsv),
2290 socket_strerror (errsv));
2297 win32_unset_event_mask (socket, FD_CONNECT);
2299 socket->priv->connected = TRUE;
2305 * g_socket_check_connect_result:
2306 * @socket: a #GSocket
2307 * @error: #GError for error reporting, or %NULL to ignore.
2309 * Checks and resets the pending connect error for the socket.
2310 * This is used to check for errors when g_socket_connect() is
2311 * used in non-blocking mode.
2313 * Returns: %TRUE if no error, %FALSE otherwise, setting @error to the error
2318 g_socket_check_connect_result (GSocket *socket,
2323 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
2325 if (!check_socket (socket, error))
2328 if (!g_socket_get_option (socket, SOL_SOCKET, SO_ERROR, &value, error))
2330 g_prefix_error (error, _("Unable to get pending error: "));
2336 g_set_error_literal (error, G_IO_ERROR, socket_io_error_from_errno (value),
2337 socket_strerror (value));
2338 if (socket->priv->remote_address)
2340 g_object_unref (socket->priv->remote_address);
2341 socket->priv->remote_address = NULL;
2346 socket->priv->connected = TRUE;
2351 * g_socket_get_available_bytes:
2352 * @socket: a #GSocket
2354 * Get the amount of data pending in the OS input buffer.
2356 * Returns: the number of bytes that can be read from the socket
2357 * without blocking or -1 on error.
2362 g_socket_get_available_bytes (GSocket *socket)
2366 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
2369 if (ioctl (socket->priv->fd, FIONREAD, &avail) < 0)
2372 if (ioctlsocket (socket->priv->fd, FIONREAD, &avail) == SOCKET_ERROR)
2381 * @socket: a #GSocket
2382 * @buffer: a buffer to read data into (which should be at least @size
2384 * @size: the number of bytes you want to read from the socket
2385 * @cancellable: (allow-none): a %GCancellable or %NULL
2386 * @error: #GError for error reporting, or %NULL to ignore.
2388 * Receive data (up to @size bytes) from a socket. This is mainly used by
2389 * connection-oriented sockets; it is identical to g_socket_receive_from()
2390 * with @address set to %NULL.
2392 * For %G_SOCKET_TYPE_DATAGRAM and %G_SOCKET_TYPE_SEQPACKET sockets,
2393 * g_socket_receive() will always read either 0 or 1 complete messages from
2394 * the socket. If the received message is too large to fit in @buffer, then
2395 * the data beyond @size bytes will be discarded, without any explicit
2396 * indication that this has occurred.
2398 * For %G_SOCKET_TYPE_STREAM sockets, g_socket_receive() can return any
2399 * number of bytes, up to @size. If more than @size bytes have been
2400 * received, the additional data will be returned in future calls to
2401 * g_socket_receive().
2403 * If the socket is in blocking mode the call will block until there
2404 * is some data to receive, the connection is closed, or there is an
2405 * error. If there is no data available and the socket is in
2406 * non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error will be
2407 * returned. To be notified when data is available, wait for the
2408 * %G_IO_IN condition.
2410 * On error -1 is returned and @error is set accordingly.
2412 * Returns: Number of bytes read, or 0 if the connection was closed by
2413 * the peer, or -1 on error
2418 g_socket_receive (GSocket *socket,
2421 GCancellable *cancellable,
2424 return g_socket_receive_with_blocking (socket, buffer, size,
2425 socket->priv->blocking,
2426 cancellable, error);
2430 * g_socket_receive_with_blocking:
2431 * @socket: a #GSocket
2432 * @buffer: a buffer to read data into (which should be at least @size
2434 * @size: the number of bytes you want to read from the socket
2435 * @blocking: whether to do blocking or non-blocking I/O
2436 * @cancellable: (allow-none): a %GCancellable or %NULL
2437 * @error: #GError for error reporting, or %NULL to ignore.
2439 * This behaves exactly the same as g_socket_receive(), except that
2440 * the choice of blocking or non-blocking behavior is determined by
2441 * the @blocking argument rather than by @socket's properties.
2443 * Returns: Number of bytes read, or 0 if the connection was closed by
2444 * the peer, or -1 on error
2449 g_socket_receive_with_blocking (GSocket *socket,
2453 GCancellable *cancellable,
2458 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, -1);
2460 if (!check_socket (socket, error))
2463 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2469 !g_socket_condition_wait (socket,
2470 G_IO_IN, cancellable, error))
2473 if ((ret = recv (socket->priv->fd, buffer, size, 0)) < 0)
2475 int errsv = get_socket_errno ();
2482 #ifdef WSAEWOULDBLOCK
2483 if (errsv == WSAEWOULDBLOCK)
2486 if (errsv == EWOULDBLOCK ||
2492 win32_unset_event_mask (socket, FD_READ);
2494 g_set_error (error, G_IO_ERROR,
2495 socket_io_error_from_errno (errsv),
2496 _("Error receiving data: %s"), socket_strerror (errsv));
2500 win32_unset_event_mask (socket, FD_READ);
2509 * g_socket_receive_from:
2510 * @socket: a #GSocket
2511 * @address: (out) (allow-none): a pointer to a #GSocketAddress
2513 * @buffer: (array length=size) (element-type guint8): a buffer to
2514 * read data into (which should be at least @size bytes long).
2515 * @size: the number of bytes you want to read from the socket
2516 * @cancellable: (allow-none): a %GCancellable or %NULL
2517 * @error: #GError for error reporting, or %NULL to ignore.
2519 * Receive data (up to @size bytes) from a socket.
2521 * If @address is non-%NULL then @address will be set equal to the
2522 * source address of the received packet.
2523 * @address is owned by the caller.
2525 * See g_socket_receive() for additional information.
2527 * Returns: Number of bytes read, or 0 if the connection was closed by
2528 * the peer, or -1 on error
2533 g_socket_receive_from (GSocket *socket,
2534 GSocketAddress **address,
2537 GCancellable *cancellable,
2545 return g_socket_receive_message (socket,
2553 /* Although we ignore SIGPIPE, gdb will still stop if the app receives
2554 * one, which can be confusing and annoying. So if possible, we want
2555 * to suppress the signal entirely.
2558 #define G_SOCKET_DEFAULT_SEND_FLAGS MSG_NOSIGNAL
2560 #define G_SOCKET_DEFAULT_SEND_FLAGS 0
2565 * @socket: a #GSocket
2566 * @buffer: (array length=size) (element-type guint8): the buffer
2567 * containing the data to send.
2568 * @size: the number of bytes to send
2569 * @cancellable: (allow-none): a %GCancellable or %NULL
2570 * @error: #GError for error reporting, or %NULL to ignore.
2572 * Tries to send @size bytes from @buffer on the socket. This is
2573 * mainly used by connection-oriented sockets; it is identical to
2574 * g_socket_send_to() with @address set to %NULL.
2576 * If the socket is in blocking mode the call will block until there is
2577 * space for the data in the socket queue. If there is no space available
2578 * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
2579 * will be returned. To be notified when space is available, wait for the
2580 * %G_IO_OUT condition. Note though that you may still receive
2581 * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
2582 * notified of a %G_IO_OUT condition. (On Windows in particular, this is
2583 * very common due to the way the underlying APIs work.)
2585 * On error -1 is returned and @error is set accordingly.
2587 * Returns: Number of bytes written (which may be less than @size), or -1
2593 g_socket_send (GSocket *socket,
2594 const gchar *buffer,
2596 GCancellable *cancellable,
2599 return g_socket_send_with_blocking (socket, buffer, size,
2600 socket->priv->blocking,
2601 cancellable, error);
2605 * g_socket_send_with_blocking:
2606 * @socket: a #GSocket
2607 * @buffer: (array length=size) (element-type guint8): the buffer
2608 * containing the data to send.
2609 * @size: the number of bytes to send
2610 * @blocking: whether to do blocking or non-blocking I/O
2611 * @cancellable: (allow-none): a %GCancellable or %NULL
2612 * @error: #GError for error reporting, or %NULL to ignore.
2614 * This behaves exactly the same as g_socket_send(), except that
2615 * the choice of blocking or non-blocking behavior is determined by
2616 * the @blocking argument rather than by @socket's properties.
2618 * Returns: Number of bytes written (which may be less than @size), or -1
2624 g_socket_send_with_blocking (GSocket *socket,
2625 const gchar *buffer,
2628 GCancellable *cancellable,
2633 g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, -1);
2635 if (!check_socket (socket, error))
2638 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2644 !g_socket_condition_wait (socket,
2645 G_IO_OUT, cancellable, error))
2648 if ((ret = send (socket->priv->fd, buffer, size, G_SOCKET_DEFAULT_SEND_FLAGS)) < 0)
2650 int errsv = get_socket_errno ();
2655 #ifdef WSAEWOULDBLOCK
2656 if (errsv == WSAEWOULDBLOCK)
2657 win32_unset_event_mask (socket, FD_WRITE);
2662 #ifdef WSAEWOULDBLOCK
2663 if (errsv == WSAEWOULDBLOCK)
2666 if (errsv == EWOULDBLOCK ||
2672 g_set_error (error, G_IO_ERROR,
2673 socket_io_error_from_errno (errsv),
2674 _("Error sending data: %s"), socket_strerror (errsv));
2685 * @socket: a #GSocket
2686 * @address: (allow-none): a #GSocketAddress, or %NULL
2687 * @buffer: (array length=size) (element-type guint8): the buffer
2688 * containing the data to send.
2689 * @size: the number of bytes to send
2690 * @cancellable: (allow-none): a %GCancellable or %NULL
2691 * @error: #GError for error reporting, or %NULL to ignore.
2693 * Tries to send @size bytes from @buffer to @address. If @address is
2694 * %NULL then the message is sent to the default receiver (set by
2695 * g_socket_connect()).
2697 * See g_socket_send() for additional information.
2699 * Returns: Number of bytes written (which may be less than @size), or -1
2705 g_socket_send_to (GSocket *socket,
2706 GSocketAddress *address,
2707 const gchar *buffer,
2709 GCancellable *cancellable,
2717 return g_socket_send_message (socket,
2727 * g_socket_shutdown:
2728 * @socket: a #GSocket
2729 * @shutdown_read: whether to shut down the read side
2730 * @shutdown_write: whether to shut down the write side
2731 * @error: #GError for error reporting, or %NULL to ignore.
2733 * Shut down part of a full-duplex connection.
2735 * If @shutdown_read is %TRUE then the receiving side of the connection
2736 * is shut down, and further reading is disallowed.
2738 * If @shutdown_write is %TRUE then the sending side of the connection
2739 * is shut down, and further writing is disallowed.
2741 * It is allowed for both @shutdown_read and @shutdown_write to be %TRUE.
2743 * One example where this is used is graceful disconnect for TCP connections
2744 * where you close the sending side, then wait for the other side to close
2745 * the connection, thus ensuring that the other side saw all sent data.
2747 * Returns: %TRUE on success, %FALSE on error
2752 g_socket_shutdown (GSocket *socket,
2753 gboolean shutdown_read,
2754 gboolean shutdown_write,
2759 g_return_val_if_fail (G_IS_SOCKET (socket), TRUE);
2761 if (!check_socket (socket, error))
2765 if (!shutdown_read && !shutdown_write)
2769 if (shutdown_read && shutdown_write)
2771 else if (shutdown_read)
2776 if (shutdown_read && shutdown_write)
2778 else if (shutdown_read)
2784 if (shutdown (socket->priv->fd, how) != 0)
2786 int errsv = get_socket_errno ();
2787 g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
2788 _("Unable to shutdown socket: %s"), socket_strerror (errsv));
2792 if (shutdown_read && shutdown_write)
2793 socket->priv->connected = FALSE;
2800 * @socket: a #GSocket
2801 * @error: #GError for error reporting, or %NULL to ignore.
2803 * Closes the socket, shutting down any active connection.
2805 * Closing a socket does not wait for all outstanding I/O operations
2806 * to finish, so the caller should not rely on them to be guaranteed
2807 * to complete even if the close returns with no error.
2809 * Once the socket is closed, all other operations will return
2810 * %G_IO_ERROR_CLOSED. Closing a socket multiple times will not
2813 * Sockets will be automatically closed when the last reference
2814 * is dropped, but you might want to call this function to make sure
2815 * resources are released as early as possible.
2817 * Beware that due to the way that TCP works, it is possible for
2818 * recently-sent data to be lost if either you close a socket while the
2819 * %G_IO_IN condition is set, or else if the remote connection tries to
2820 * send something to you after you close the socket but before it has
2821 * finished reading all of the data you sent. There is no easy generic
2822 * way to avoid this problem; the easiest fix is to design the network
2823 * protocol such that the client will never send data "out of turn".
2824 * Another solution is for the server to half-close the connection by
2825 * calling g_socket_shutdown() with only the @shutdown_write flag set,
2826 * and then wait for the client to notice this and close its side of the
2827 * connection, after which the server can safely call g_socket_close().
2828 * (This is what #GTcpConnection does if you call
2829 * g_tcp_connection_set_graceful_disconnect(). But of course, this
2830 * only works if the client will close its connection after the server
2833 * Returns: %TRUE on success, %FALSE on error
2838 g_socket_close (GSocket *socket,
2843 g_return_val_if_fail (G_IS_SOCKET (socket), TRUE);
2845 if (socket->priv->closed)
2846 return TRUE; /* Multiple close not an error */
2848 if (!check_socket (socket, error))
2854 res = closesocket (socket->priv->fd);
2856 res = close (socket->priv->fd);
2860 int errsv = get_socket_errno ();
2865 g_set_error (error, G_IO_ERROR,
2866 socket_io_error_from_errno (errsv),
2867 _("Error closing socket: %s"),
2868 socket_strerror (errsv));
2874 socket->priv->connected = FALSE;
2875 socket->priv->closed = TRUE;
2876 if (socket->priv->remote_address)
2878 g_object_unref (socket->priv->remote_address);
2879 socket->priv->remote_address = NULL;
2886 * g_socket_is_closed:
2887 * @socket: a #GSocket
2889 * Checks whether a socket is closed.
2891 * Returns: %TRUE if socket is closed, %FALSE otherwise
2896 g_socket_is_closed (GSocket *socket)
2898 return socket->priv->closed;
2902 /* Broken source, used on errors */
2904 broken_prepare (GSource *source,
2911 broken_check (GSource *source)
2917 broken_dispatch (GSource *source,
2918 GSourceFunc callback,
2924 static GSourceFuncs broken_funcs =
2933 network_events_for_condition (GIOCondition condition)
2937 if (condition & G_IO_IN)
2938 event_mask |= (FD_READ | FD_ACCEPT);
2939 if (condition & G_IO_OUT)
2940 event_mask |= (FD_WRITE | FD_CONNECT);
2941 event_mask |= FD_CLOSE;
2947 ensure_event (GSocket *socket)
2949 if (socket->priv->event == WSA_INVALID_EVENT)
2950 socket->priv->event = WSACreateEvent();
2954 update_select_events (GSocket *socket)
2961 ensure_event (socket);
2964 for (l = socket->priv->requested_conditions; l != NULL; l = l->next)
2967 event_mask |= network_events_for_condition (*ptr);
2970 if (event_mask != socket->priv->selected_events)
2972 /* If no events selected, disable event so we can unset
2975 if (event_mask == 0)
2978 event = socket->priv->event;
2980 if (WSAEventSelect (socket->priv->fd, event, event_mask) == 0)
2981 socket->priv->selected_events = event_mask;
2986 add_condition_watch (GSocket *socket,
2987 GIOCondition *condition)
2989 g_assert (g_list_find (socket->priv->requested_conditions, condition) == NULL);
2991 socket->priv->requested_conditions =
2992 g_list_prepend (socket->priv->requested_conditions, condition);
2994 update_select_events (socket);
2998 remove_condition_watch (GSocket *socket,
2999 GIOCondition *condition)
3001 g_assert (g_list_find (socket->priv->requested_conditions, condition) != NULL);
3003 socket->priv->requested_conditions =
3004 g_list_remove (socket->priv->requested_conditions, condition);
3006 update_select_events (socket);
3010 update_condition (GSocket *socket)
3012 WSANETWORKEVENTS events;
3013 GIOCondition condition;
3015 if (WSAEnumNetworkEvents (socket->priv->fd,
3016 socket->priv->event,
3019 socket->priv->current_events |= events.lNetworkEvents;
3020 if (events.lNetworkEvents & FD_WRITE &&
3021 events.iErrorCode[FD_WRITE_BIT] != 0)
3022 socket->priv->current_errors |= FD_WRITE;
3023 if (events.lNetworkEvents & FD_CONNECT &&
3024 events.iErrorCode[FD_CONNECT_BIT] != 0)
3025 socket->priv->current_errors |= FD_CONNECT;
3029 if (socket->priv->current_events & (FD_READ | FD_ACCEPT))
3030 condition |= G_IO_IN;
3032 if (socket->priv->current_events & FD_CLOSE)
3034 int r, errsv, buffer;
3036 r = recv (socket->priv->fd, &buffer, sizeof (buffer), MSG_PEEK);
3038 errsv = get_socket_errno ();
3041 (r < 0 && errsv == WSAENOTCONN))
3042 condition |= G_IO_IN;
3044 (r < 0 && (errsv == WSAESHUTDOWN || errsv == WSAECONNRESET ||
3045 errsv == WSAECONNABORTED || errsv == WSAENETRESET)))
3046 condition |= G_IO_HUP;
3048 condition |= G_IO_ERR;
3051 if (socket->priv->closed)
3052 condition |= G_IO_HUP;
3054 /* Never report both G_IO_OUT and HUP, these are
3055 mutually exclusive (can't write to a closed socket) */
3056 if ((condition & G_IO_HUP) == 0 &&
3057 socket->priv->current_events & FD_WRITE)
3059 if (socket->priv->current_errors & FD_WRITE)
3060 condition |= G_IO_ERR;
3062 condition |= G_IO_OUT;
3066 if (socket->priv->current_events & FD_CONNECT)
3068 if (socket->priv->current_errors & FD_CONNECT)
3069 condition |= (G_IO_HUP | G_IO_ERR);
3071 condition |= G_IO_OUT;
3083 GIOCondition condition;
3084 GCancellable *cancellable;
3085 GPollFD cancel_pollfd;
3086 gint64 timeout_time;
3090 socket_source_prepare (GSource *source,
3093 GSocketSource *socket_source = (GSocketSource *)source;
3095 if (g_cancellable_is_cancelled (socket_source->cancellable))
3098 if (socket_source->timeout_time)
3102 now = g_source_get_time (source);
3103 /* Round up to ensure that we don't try again too early */
3104 *timeout = (socket_source->timeout_time - now + 999) / 1000;
3107 socket_source->socket->priv->timed_out = TRUE;
3116 socket_source->pollfd.revents = update_condition (socket_source->socket);
3119 if ((socket_source->condition & socket_source->pollfd.revents) != 0)
3126 socket_source_check (GSource *source)
3130 return socket_source_prepare (source, &timeout);
3134 socket_source_dispatch (GSource *source,
3135 GSourceFunc callback,
3138 GSocketSourceFunc func = (GSocketSourceFunc)callback;
3139 GSocketSource *socket_source = (GSocketSource *)source;
3140 GSocket *socket = socket_source->socket;
3144 socket_source->pollfd.revents = update_condition (socket_source->socket);
3146 if (socket_source->socket->priv->timed_out)
3147 socket_source->pollfd.revents |= socket_source->condition & (G_IO_IN | G_IO_OUT);
3149 ret = (*func) (socket,
3150 socket_source->pollfd.revents & socket_source->condition,
3153 if (socket->priv->timeout)
3154 socket_source->timeout_time = g_get_monotonic_time () +
3155 socket->priv->timeout * 1000000;
3158 socket_source->timeout_time = 0;
3164 socket_source_finalize (GSource *source)
3166 GSocketSource *socket_source = (GSocketSource *)source;
3169 socket = socket_source->socket;
3172 remove_condition_watch (socket, &socket_source->condition);
3175 g_object_unref (socket);
3177 if (socket_source->cancellable)
3179 g_cancellable_release_fd (socket_source->cancellable);
3180 g_object_unref (socket_source->cancellable);
3185 socket_source_closure_callback (GSocket *socket,
3186 GIOCondition condition,
3189 GClosure *closure = data;
3191 GValue params[2] = { G_VALUE_INIT, G_VALUE_INIT };
3192 GValue result_value = G_VALUE_INIT;
3195 g_value_init (&result_value, G_TYPE_BOOLEAN);
3197 g_value_init (¶ms[0], G_TYPE_SOCKET);
3198 g_value_set_object (¶ms[0], socket);
3199 g_value_init (¶ms[1], G_TYPE_IO_CONDITION);
3200 g_value_set_flags (¶ms[1], condition);
3202 g_closure_invoke (closure, &result_value, 2, params, NULL);
3204 result = g_value_get_boolean (&result_value);
3205 g_value_unset (&result_value);
3206 g_value_unset (¶ms[0]);
3207 g_value_unset (¶ms[1]);
3212 static GSourceFuncs socket_source_funcs =
3214 socket_source_prepare,
3215 socket_source_check,
3216 socket_source_dispatch,
3217 socket_source_finalize,
3218 (GSourceFunc)socket_source_closure_callback,
3219 (GSourceDummyMarshal)g_cclosure_marshal_generic,
3223 socket_source_new (GSocket *socket,
3224 GIOCondition condition,
3225 GCancellable *cancellable)
3228 GSocketSource *socket_source;
3231 ensure_event (socket);
3233 if (socket->priv->event == WSA_INVALID_EVENT)
3235 g_warning ("Failed to create WSAEvent");
3236 return g_source_new (&broken_funcs, sizeof (GSource));
3240 condition |= G_IO_HUP | G_IO_ERR;
3242 source = g_source_new (&socket_source_funcs, sizeof (GSocketSource));
3243 g_source_set_name (source, "GSocket");
3244 socket_source = (GSocketSource *)source;
3246 socket_source->socket = g_object_ref (socket);
3247 socket_source->condition = condition;
3249 if (g_cancellable_make_pollfd (cancellable,
3250 &socket_source->cancel_pollfd))
3252 socket_source->cancellable = g_object_ref (cancellable);
3253 g_source_add_poll (source, &socket_source->cancel_pollfd);
3257 add_condition_watch (socket, &socket_source->condition);
3258 socket_source->pollfd.fd = (gintptr) socket->priv->event;
3260 socket_source->pollfd.fd = socket->priv->fd;
3263 socket_source->pollfd.events = condition;
3264 socket_source->pollfd.revents = 0;
3265 g_source_add_poll (source, &socket_source->pollfd);
3267 if (socket->priv->timeout)
3268 socket_source->timeout_time = g_get_monotonic_time () +
3269 socket->priv->timeout * 1000000;
3272 socket_source->timeout_time = 0;
3278 * g_socket_create_source: (skip)
3279 * @socket: a #GSocket
3280 * @condition: a #GIOCondition mask to monitor
3281 * @cancellable: (allow-none): a %GCancellable or %NULL
3283 * Creates a %GSource that can be attached to a %GMainContext to monitor
3284 * for the availibility of the specified @condition on the socket.
3286 * The callback on the source is of the #GSocketSourceFunc type.
3288 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in @condition;
3289 * these conditions will always be reported output if they are true.
3291 * @cancellable if not %NULL can be used to cancel the source, which will
3292 * cause the source to trigger, reporting the current condition (which
3293 * is likely 0 unless cancellation happened at the same time as a
3294 * condition change). You can check for this in the callback using
3295 * g_cancellable_is_cancelled().
3297 * If @socket has a timeout set, and it is reached before @condition
3298 * occurs, the source will then trigger anyway, reporting %G_IO_IN or
3299 * %G_IO_OUT depending on @condition. However, @socket will have been
3300 * marked as having had a timeout, and so the next #GSocket I/O method
3301 * you call will then fail with a %G_IO_ERROR_TIMED_OUT.
3303 * Returns: (transfer full): a newly allocated %GSource, free with g_source_unref().
3308 g_socket_create_source (GSocket *socket,
3309 GIOCondition condition,
3310 GCancellable *cancellable)
3312 g_return_val_if_fail (G_IS_SOCKET (socket) && (cancellable == NULL || G_IS_CANCELLABLE (cancellable)), NULL);
3314 return socket_source_new (socket, condition, cancellable);
3318 * g_socket_condition_check:
3319 * @socket: a #GSocket
3320 * @condition: a #GIOCondition mask to check
3322 * Checks on the readiness of @socket to perform operations.
3323 * The operations specified in @condition are checked for and masked
3324 * against the currently-satisfied conditions on @socket. The result
3327 * Note that on Windows, it is possible for an operation to return
3328 * %G_IO_ERROR_WOULD_BLOCK even immediately after
3329 * g_socket_condition_check() has claimed that the socket is ready for
3330 * writing. Rather than calling g_socket_condition_check() and then
3331 * writing to the socket if it succeeds, it is generally better to
3332 * simply try writing to the socket right away, and try again later if
3333 * the initial attempt returns %G_IO_ERROR_WOULD_BLOCK.
3335 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition;
3336 * these conditions will always be set in the output if they are true.
3338 * This call never blocks.
3340 * Returns: the @GIOCondition mask of the current state
3345 g_socket_condition_check (GSocket *socket,
3346 GIOCondition condition)
3348 g_return_val_if_fail (G_IS_SOCKET (socket), 0);
3350 if (!check_socket (socket, NULL))
3355 GIOCondition current_condition;
3357 condition |= G_IO_ERR | G_IO_HUP;
3359 add_condition_watch (socket, &condition);
3360 current_condition = update_condition (socket);
3361 remove_condition_watch (socket, &condition);
3362 return condition & current_condition;
3368 poll_fd.fd = socket->priv->fd;
3369 poll_fd.events = condition;
3370 poll_fd.revents = 0;
3373 result = g_poll (&poll_fd, 1, 0);
3374 while (result == -1 && get_socket_errno () == EINTR);
3376 return poll_fd.revents;
3382 * g_socket_condition_wait:
3383 * @socket: a #GSocket
3384 * @condition: a #GIOCondition mask to wait for
3385 * @cancellable: (allow-none): a #GCancellable, or %NULL
3386 * @error: a #GError pointer, or %NULL
3388 * Waits for @condition to become true on @socket. When the condition
3389 * is met, %TRUE is returned.
3391 * If @cancellable is cancelled before the condition is met, or if the
3392 * socket has a timeout set and it is reached before the condition is
3393 * met, then %FALSE is returned and @error, if non-%NULL, is set to
3394 * the appropriate value (%G_IO_ERROR_CANCELLED or
3395 * %G_IO_ERROR_TIMED_OUT).
3397 * See also g_socket_condition_timed_wait().
3399 * Returns: %TRUE if the condition was met, %FALSE otherwise
3404 g_socket_condition_wait (GSocket *socket,
3405 GIOCondition condition,
3406 GCancellable *cancellable,
3409 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
3411 return g_socket_condition_timed_wait (socket, condition, -1,
3412 cancellable, error);
3416 * g_socket_condition_timed_wait:
3417 * @socket: a #GSocket
3418 * @condition: a #GIOCondition mask to wait for
3419 * @timeout: the maximum time (in microseconds) to wait, or -1
3420 * @cancellable: (allow-none): a #GCancellable, or %NULL
3421 * @error: a #GError pointer, or %NULL
3423 * Waits for up to @timeout microseconds for @condition to become true
3424 * on @socket. If the condition is met, %TRUE is returned.
3426 * If @cancellable is cancelled before the condition is met, or if
3427 * @timeout (or the socket's #GSocket:timeout) is reached before the
3428 * condition is met, then %FALSE is returned and @error, if non-%NULL,
3429 * is set to the appropriate value (%G_IO_ERROR_CANCELLED or
3430 * %G_IO_ERROR_TIMED_OUT).
3432 * If you don't want a timeout, use g_socket_condition_wait().
3433 * (Alternatively, you can pass -1 for @timeout.)
3435 * Note that although @timeout is in microseconds for consistency with
3436 * other GLib APIs, this function actually only has millisecond
3437 * resolution, and the behavior is undefined if @timeout is not an
3438 * exact number of milliseconds.
3440 * Returns: %TRUE if the condition was met, %FALSE otherwise
3445 g_socket_condition_timed_wait (GSocket *socket,
3446 GIOCondition condition,
3448 GCancellable *cancellable,
3453 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
3455 if (!check_socket (socket, error))
3458 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3461 if (socket->priv->timeout &&
3462 (timeout < 0 || socket->priv->timeout < timeout / G_USEC_PER_SEC))
3463 timeout = socket->priv->timeout * 1000;
3464 else if (timeout != -1)
3465 timeout = timeout / 1000;
3467 start_time = g_get_monotonic_time ();
3471 GIOCondition current_condition;
3477 /* Always check these */
3478 condition |= G_IO_ERR | G_IO_HUP;
3480 add_condition_watch (socket, &condition);
3483 events[num_events++] = socket->priv->event;
3485 if (g_cancellable_make_pollfd (cancellable, &cancel_fd))
3486 events[num_events++] = (WSAEVENT)cancel_fd.fd;
3489 timeout = WSA_INFINITE;
3491 current_condition = update_condition (socket);
3492 while ((condition & current_condition) == 0)
3494 res = WSAWaitForMultipleEvents (num_events, events,
3495 FALSE, timeout, FALSE);
3496 if (res == WSA_WAIT_FAILED)
3498 int errsv = get_socket_errno ();
3500 g_set_error (error, G_IO_ERROR,
3501 socket_io_error_from_errno (errsv),
3502 _("Waiting for socket condition: %s"),
3503 socket_strerror (errsv));
3506 else if (res == WSA_WAIT_TIMEOUT)
3508 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
3509 _("Socket I/O timed out"));
3513 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3516 current_condition = update_condition (socket);
3518 if (timeout != WSA_INFINITE)
3520 timeout -= (g_get_monotonic_time () - start_time) * 1000;
3525 remove_condition_watch (socket, &condition);
3527 g_cancellable_release_fd (cancellable);
3529 return (condition & current_condition) != 0;
3537 poll_fd[0].fd = socket->priv->fd;
3538 poll_fd[0].events = condition;
3541 if (g_cancellable_make_pollfd (cancellable, &poll_fd[1]))
3546 result = g_poll (poll_fd, num, timeout);
3547 if (result != -1 || errno != EINTR)
3552 timeout -= (g_get_monotonic_time () - start_time) * 1000;
3559 g_cancellable_release_fd (cancellable);
3563 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
3564 _("Socket I/O timed out"));
3568 return !g_cancellable_set_error_if_cancelled (cancellable, error);
3574 * g_socket_send_message:
3575 * @socket: a #GSocket
3576 * @address: (allow-none): a #GSocketAddress, or %NULL
3577 * @vectors: (array length=num_vectors): an array of #GOutputVector structs
3578 * @num_vectors: the number of elements in @vectors, or -1
3579 * @messages: (array length=num_messages) (allow-none): a pointer to an
3580 * array of #GSocketControlMessages, or %NULL.
3581 * @num_messages: number of elements in @messages, or -1.
3582 * @flags: an int containing #GSocketMsgFlags flags
3583 * @cancellable: (allow-none): a %GCancellable or %NULL
3584 * @error: #GError for error reporting, or %NULL to ignore.
3586 * Send data to @address on @socket. This is the most complicated and
3587 * fully-featured version of this call. For easier use, see
3588 * g_socket_send() and g_socket_send_to().
3590 * If @address is %NULL then the message is sent to the default receiver
3591 * (set by g_socket_connect()).
3593 * @vectors must point to an array of #GOutputVector structs and
3594 * @num_vectors must be the length of this array. (If @num_vectors is -1,
3595 * then @vectors is assumed to be terminated by a #GOutputVector with a
3596 * %NULL buffer pointer.) The #GOutputVector structs describe the buffers
3597 * that the sent data will be gathered from. Using multiple
3598 * #GOutputVector<!-- -->s is more memory-efficient than manually copying
3599 * data from multiple sources into a single buffer, and more
3600 * network-efficient than making multiple calls to g_socket_send().
3602 * @messages, if non-%NULL, is taken to point to an array of @num_messages
3603 * #GSocketControlMessage instances. These correspond to the control
3604 * messages to be sent on the socket.
3605 * If @num_messages is -1 then @messages is treated as a %NULL-terminated
3608 * @flags modify how the message is sent. The commonly available arguments
3609 * for this are available in the #GSocketMsgFlags enum, but the
3610 * values there are the same as the system values, and the flags
3611 * are passed in as-is, so you can pass in system-specific flags too.
3613 * If the socket is in blocking mode the call will block until there is
3614 * space for the data in the socket queue. If there is no space available
3615 * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
3616 * will be returned. To be notified when space is available, wait for the
3617 * %G_IO_OUT condition. Note though that you may still receive
3618 * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
3619 * notified of a %G_IO_OUT condition. (On Windows in particular, this is
3620 * very common due to the way the underlying APIs work.)
3622 * On error -1 is returned and @error is set accordingly.
3624 * Returns: Number of bytes written (which may be less than @size), or -1
3630 g_socket_send_message (GSocket *socket,
3631 GSocketAddress *address,
3632 GOutputVector *vectors,
3634 GSocketControlMessage **messages,
3637 GCancellable *cancellable,
3640 GOutputVector one_vector;
3643 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
3645 if (!check_socket (socket, error))
3648 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3651 if (num_vectors == -1)
3653 for (num_vectors = 0;
3654 vectors[num_vectors].buffer != NULL;
3659 if (num_messages == -1)
3661 for (num_messages = 0;
3662 messages != NULL && messages[num_messages] != NULL;
3667 if (num_vectors == 0)
3671 one_vector.buffer = &zero;
3672 one_vector.size = 1;
3674 vectors = &one_vector;
3687 msg.msg_namelen = g_socket_address_get_native_size (address);
3688 msg.msg_name = g_alloca (msg.msg_namelen);
3689 if (!g_socket_address_to_native (address, msg.msg_name, msg.msg_namelen, error))
3694 msg.msg_name = NULL;
3695 msg.msg_namelen = 0;
3700 /* this entire expression will be evaluated at compile time */
3701 if (sizeof *msg.msg_iov == sizeof *vectors &&
3702 sizeof msg.msg_iov->iov_base == sizeof vectors->buffer &&
3703 G_STRUCT_OFFSET (struct iovec, iov_base) ==
3704 G_STRUCT_OFFSET (GOutputVector, buffer) &&
3705 sizeof msg.msg_iov->iov_len == sizeof vectors->size &&
3706 G_STRUCT_OFFSET (struct iovec, iov_len) ==
3707 G_STRUCT_OFFSET (GOutputVector, size))
3708 /* ABI is compatible */
3710 msg.msg_iov = (struct iovec *) vectors;
3711 msg.msg_iovlen = num_vectors;
3714 /* ABI is incompatible */
3718 msg.msg_iov = g_newa (struct iovec, num_vectors);
3719 for (i = 0; i < num_vectors; i++)
3721 msg.msg_iov[i].iov_base = (void *) vectors[i].buffer;
3722 msg.msg_iov[i].iov_len = vectors[i].size;
3724 msg.msg_iovlen = num_vectors;
3730 struct cmsghdr *cmsg;
3733 msg.msg_controllen = 0;
3734 for (i = 0; i < num_messages; i++)
3735 msg.msg_controllen += CMSG_SPACE (g_socket_control_message_get_size (messages[i]));
3737 if (msg.msg_controllen == 0)
3738 msg.msg_control = NULL;
3741 msg.msg_control = g_alloca (msg.msg_controllen);
3742 memset (msg.msg_control, '\0', msg.msg_controllen);
3745 cmsg = CMSG_FIRSTHDR (&msg);
3746 for (i = 0; i < num_messages; i++)
3748 cmsg->cmsg_level = g_socket_control_message_get_level (messages[i]);
3749 cmsg->cmsg_type = g_socket_control_message_get_msg_type (messages[i]);
3750 cmsg->cmsg_len = CMSG_LEN (g_socket_control_message_get_size (messages[i]));
3751 g_socket_control_message_serialize (messages[i],
3753 cmsg = CMSG_NXTHDR (&msg, cmsg);
3755 g_assert (cmsg == NULL);
3760 if (socket->priv->blocking &&
3761 !g_socket_condition_wait (socket,
3762 G_IO_OUT, cancellable, error))
3765 result = sendmsg (socket->priv->fd, &msg, flags | G_SOCKET_DEFAULT_SEND_FLAGS);
3768 int errsv = get_socket_errno ();
3773 if (socket->priv->blocking &&
3774 (errsv == EWOULDBLOCK ||
3778 g_set_error (error, G_IO_ERROR,
3779 socket_io_error_from_errno (errsv),
3780 _("Error sending message: %s"), socket_strerror (errsv));
3791 struct sockaddr_storage addr;
3798 /* Win32 doesn't support control messages.
3799 Actually this is possible for raw and datagram sockets
3800 via WSASendMessage on Vista or later, but that doesn't
3802 if (num_messages != 0)
3804 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3805 _("GSocketControlMessage not supported on Windows"));
3810 bufs = g_newa (WSABUF, num_vectors);
3811 for (i = 0; i < num_vectors; i++)
3813 bufs[i].buf = (char *)vectors[i].buffer;
3814 bufs[i].len = (gulong)vectors[i].size;
3818 addrlen = 0; /* Avoid warning */
3821 addrlen = g_socket_address_get_native_size (address);
3822 if (!g_socket_address_to_native (address, &addr, sizeof addr, error))
3828 if (socket->priv->blocking &&
3829 !g_socket_condition_wait (socket,
3830 G_IO_OUT, cancellable, error))
3834 result = WSASendTo (socket->priv->fd,
3837 (const struct sockaddr *)&addr, addrlen,
3840 result = WSASend (socket->priv->fd,
3847 int errsv = get_socket_errno ();
3849 if (errsv == WSAEINTR)
3852 if (errsv == WSAEWOULDBLOCK)
3853 win32_unset_event_mask (socket, FD_WRITE);
3855 if (socket->priv->blocking &&
3856 errsv == WSAEWOULDBLOCK)
3859 g_set_error (error, G_IO_ERROR,
3860 socket_io_error_from_errno (errsv),
3861 _("Error sending message: %s"), socket_strerror (errsv));
3873 static GSocketAddress *
3874 cache_recv_address (GSocket *socket, struct sockaddr *native, int native_len)
3876 GSocketAddress *saddr;
3878 guint64 oldest_time = G_MAXUINT64;
3879 gint oldest_index = 0;
3881 if (native_len <= 0)
3885 for (i = 0; i < RECV_ADDR_CACHE_SIZE; i++)
3887 GSocketAddress *tmp = socket->priv->recv_addr_cache[i].addr;
3888 gpointer tmp_native = socket->priv->recv_addr_cache[i].native;
3889 gint tmp_native_len = socket->priv->recv_addr_cache[i].native_len;
3894 if (tmp_native_len != native_len)
3897 if (memcmp (tmp_native, native, native_len) == 0)
3899 saddr = g_object_ref (tmp);
3900 socket->priv->recv_addr_cache[i].last_used = g_get_monotonic_time ();
3904 if (socket->priv->recv_addr_cache[i].last_used < oldest_time)
3906 oldest_time = socket->priv->recv_addr_cache[i].last_used;
3911 saddr = g_socket_address_new_from_native (native, native_len);
3913 if (socket->priv->recv_addr_cache[oldest_index].addr)
3915 g_object_unref (socket->priv->recv_addr_cache[oldest_index].addr);
3916 g_free (socket->priv->recv_addr_cache[oldest_index].native);
3919 socket->priv->recv_addr_cache[oldest_index].native = g_memdup (native, native_len);
3920 socket->priv->recv_addr_cache[oldest_index].native_len = native_len;
3921 socket->priv->recv_addr_cache[oldest_index].addr = g_object_ref (saddr);
3922 socket->priv->recv_addr_cache[oldest_index].last_used = g_get_monotonic_time ();
3928 * g_socket_receive_message:
3929 * @socket: a #GSocket
3930 * @address: (out) (allow-none): a pointer to a #GSocketAddress
3932 * @vectors: (array length=num_vectors): an array of #GInputVector structs
3933 * @num_vectors: the number of elements in @vectors, or -1
3934 * @messages: (array length=num_messages) (allow-none): a pointer which
3935 * may be filled with an array of #GSocketControlMessages, or %NULL
3936 * @num_messages: a pointer which will be filled with the number of
3937 * elements in @messages, or %NULL
3938 * @flags: a pointer to an int containing #GSocketMsgFlags flags
3939 * @cancellable: (allow-none): a %GCancellable or %NULL
3940 * @error: a #GError pointer, or %NULL
3942 * Receive data from a socket. This is the most complicated and
3943 * fully-featured version of this call. For easier use, see
3944 * g_socket_receive() and g_socket_receive_from().
3946 * If @address is non-%NULL then @address will be set equal to the
3947 * source address of the received packet.
3948 * @address is owned by the caller.
3950 * @vector must point to an array of #GInputVector structs and
3951 * @num_vectors must be the length of this array. These structs
3952 * describe the buffers that received data will be scattered into.
3953 * If @num_vectors is -1, then @vectors is assumed to be terminated
3954 * by a #GInputVector with a %NULL buffer pointer.
3956 * As a special case, if @num_vectors is 0 (in which case, @vectors
3957 * may of course be %NULL), then a single byte is received and
3958 * discarded. This is to facilitate the common practice of sending a
3959 * single '\0' byte for the purposes of transferring ancillary data.
3961 * @messages, if non-%NULL, will be set to point to a newly-allocated
3962 * array of #GSocketControlMessage instances or %NULL if no such
3963 * messages was received. These correspond to the control messages
3964 * received from the kernel, one #GSocketControlMessage per message
3965 * from the kernel. This array is %NULL-terminated and must be freed
3966 * by the caller using g_free() after calling g_object_unref() on each
3967 * element. If @messages is %NULL, any control messages received will
3970 * @num_messages, if non-%NULL, will be set to the number of control
3971 * messages received.
3973 * If both @messages and @num_messages are non-%NULL, then
3974 * @num_messages gives the number of #GSocketControlMessage instances
3975 * in @messages (ie: not including the %NULL terminator).
3977 * @flags is an in/out parameter. The commonly available arguments
3978 * for this are available in the #GSocketMsgFlags enum, but the
3979 * values there are the same as the system values, and the flags
3980 * are passed in as-is, so you can pass in system-specific flags too
3981 * (and g_socket_receive_message() may pass system-specific flags out).
3983 * As with g_socket_receive(), data may be discarded if @socket is
3984 * %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not
3985 * provide enough buffer space to read a complete message. You can pass
3986 * %G_SOCKET_MSG_PEEK in @flags to peek at the current message without
3987 * removing it from the receive queue, but there is no portable way to find
3988 * out the length of the message other than by reading it into a
3989 * sufficiently-large buffer.
3991 * If the socket is in blocking mode the call will block until there
3992 * is some data to receive, the connection is closed, or there is an
3993 * error. If there is no data available and the socket is in
3994 * non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error will be
3995 * returned. To be notified when data is available, wait for the
3996 * %G_IO_IN condition.
3998 * On error -1 is returned and @error is set accordingly.
4000 * Returns: Number of bytes read, or 0 if the connection was closed by
4001 * the peer, or -1 on error
4006 g_socket_receive_message (GSocket *socket,
4007 GSocketAddress **address,
4008 GInputVector *vectors,
4010 GSocketControlMessage ***messages,
4013 GCancellable *cancellable,
4016 GInputVector one_vector;
4019 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
4021 if (!check_socket (socket, error))
4024 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4027 if (num_vectors == -1)
4029 for (num_vectors = 0;
4030 vectors[num_vectors].buffer != NULL;
4035 if (num_vectors == 0)
4037 one_vector.buffer = &one_byte;
4038 one_vector.size = 1;
4040 vectors = &one_vector;
4047 struct sockaddr_storage one_sockaddr;
4052 msg.msg_name = &one_sockaddr;
4053 msg.msg_namelen = sizeof (struct sockaddr_storage);
4057 msg.msg_name = NULL;
4058 msg.msg_namelen = 0;
4062 /* this entire expression will be evaluated at compile time */
4063 if (sizeof *msg.msg_iov == sizeof *vectors &&
4064 sizeof msg.msg_iov->iov_base == sizeof vectors->buffer &&
4065 G_STRUCT_OFFSET (struct iovec, iov_base) ==
4066 G_STRUCT_OFFSET (GInputVector, buffer) &&
4067 sizeof msg.msg_iov->iov_len == sizeof vectors->size &&
4068 G_STRUCT_OFFSET (struct iovec, iov_len) ==
4069 G_STRUCT_OFFSET (GInputVector, size))
4070 /* ABI is compatible */
4072 msg.msg_iov = (struct iovec *) vectors;
4073 msg.msg_iovlen = num_vectors;
4076 /* ABI is incompatible */
4080 msg.msg_iov = g_newa (struct iovec, num_vectors);
4081 for (i = 0; i < num_vectors; i++)
4083 msg.msg_iov[i].iov_base = vectors[i].buffer;
4084 msg.msg_iov[i].iov_len = vectors[i].size;
4086 msg.msg_iovlen = num_vectors;
4090 msg.msg_control = g_alloca (2048);
4091 msg.msg_controllen = 2048;
4095 msg.msg_flags = *flags;
4099 /* We always set the close-on-exec flag so we don't leak file
4100 * descriptors into child processes. Note that gunixfdmessage.c
4101 * will later call fcntl (fd, FD_CLOEXEC), but that isn't atomic.
4103 #ifdef MSG_CMSG_CLOEXEC
4104 msg.msg_flags |= MSG_CMSG_CLOEXEC;
4110 if (socket->priv->blocking &&
4111 !g_socket_condition_wait (socket,
4112 G_IO_IN, cancellable, error))
4115 result = recvmsg (socket->priv->fd, &msg, msg.msg_flags);
4116 #ifdef MSG_CMSG_CLOEXEC
4117 if (result < 0 && get_socket_errno () == EINVAL)
4119 /* We must be running on an old kernel. Call without the flag. */
4120 msg.msg_flags &= ~(MSG_CMSG_CLOEXEC);
4121 result = recvmsg (socket->priv->fd, &msg, msg.msg_flags);
4127 int errsv = get_socket_errno ();
4132 if (socket->priv->blocking &&
4133 (errsv == EWOULDBLOCK ||
4137 g_set_error (error, G_IO_ERROR,
4138 socket_io_error_from_errno (errsv),
4139 _("Error receiving message: %s"), socket_strerror (errsv));
4146 /* decode address */
4147 if (address != NULL)
4149 *address = cache_recv_address (socket, msg.msg_name, msg.msg_namelen);
4152 /* decode control messages */
4154 GPtrArray *my_messages = NULL;
4155 struct cmsghdr *cmsg;
4157 if (msg.msg_controllen >= sizeof (struct cmsghdr))
4159 for (cmsg = CMSG_FIRSTHDR (&msg); cmsg; cmsg = CMSG_NXTHDR (&msg, cmsg))
4161 GSocketControlMessage *message;
4163 message = g_socket_control_message_deserialize (cmsg->cmsg_level,
4165 cmsg->cmsg_len - ((char *)CMSG_DATA (cmsg) - (char *)cmsg),
4167 if (message == NULL)
4168 /* We've already spewed about the problem in the
4169 deserialization code, so just continue */
4172 if (messages == NULL)
4174 /* we have to do it this way if the user ignores the
4175 * messages so that we will close any received fds.
4177 g_object_unref (message);
4181 if (my_messages == NULL)
4182 my_messages = g_ptr_array_new ();
4183 g_ptr_array_add (my_messages, message);
4189 *num_messages = my_messages != NULL ? my_messages->len : 0;
4193 if (my_messages == NULL)
4199 g_ptr_array_add (my_messages, NULL);
4200 *messages = (GSocketControlMessage **) g_ptr_array_free (my_messages, FALSE);
4205 g_assert (my_messages == NULL);
4209 /* capture the flags */
4211 *flags = msg.msg_flags;
4217 struct sockaddr_storage addr;
4219 DWORD bytes_received;
4226 bufs = g_newa (WSABUF, num_vectors);
4227 for (i = 0; i < num_vectors; i++)
4229 bufs[i].buf = (char *)vectors[i].buffer;
4230 bufs[i].len = (gulong)vectors[i].size;
4242 if (socket->priv->blocking &&
4243 !g_socket_condition_wait (socket,
4244 G_IO_IN, cancellable, error))
4247 addrlen = sizeof addr;
4249 result = WSARecvFrom (socket->priv->fd,
4251 &bytes_received, &win_flags,
4252 (struct sockaddr *)&addr, &addrlen,
4255 result = WSARecv (socket->priv->fd,
4257 &bytes_received, &win_flags,
4261 int errsv = get_socket_errno ();
4263 if (errsv == WSAEINTR)
4266 win32_unset_event_mask (socket, FD_READ);
4268 if (socket->priv->blocking &&
4269 errsv == WSAEWOULDBLOCK)
4272 g_set_error (error, G_IO_ERROR,
4273 socket_io_error_from_errno (errsv),
4274 _("Error receiving message: %s"), socket_strerror (errsv));
4278 win32_unset_event_mask (socket, FD_READ);
4282 /* decode address */
4283 if (address != NULL)
4285 *address = cache_recv_address (socket, (struct sockaddr *)&addr, addrlen);
4288 /* capture the flags */
4292 if (messages != NULL)
4294 if (num_messages != NULL)
4297 return bytes_received;
4303 * g_socket_get_credentials:
4304 * @socket: a #GSocket.
4305 * @error: #GError for error reporting, or %NULL to ignore.
4307 * Returns the credentials of the foreign process connected to this
4308 * socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX
4311 * If this operation isn't supported on the OS, the method fails with
4312 * the %G_IO_ERROR_NOT_SUPPORTED error. On Linux this is implemented
4313 * by reading the %SO_PEERCRED option on the underlying socket.
4315 * Other ways to obtain credentials from a foreign peer includes the
4316 * #GUnixCredentialsMessage type and
4317 * g_unix_connection_send_credentials() /
4318 * g_unix_connection_receive_credentials() functions.
4320 * Returns: (transfer full): %NULL if @error is set, otherwise a #GCredentials object
4321 * that must be freed with g_object_unref().
4326 g_socket_get_credentials (GSocket *socket,
4331 g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
4332 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
4336 #if defined(__linux__) || defined(__OpenBSD__)
4339 #if defined(__linux__)
4340 struct ucred native_creds;
4341 optlen = sizeof (struct ucred);
4342 #elif defined(__OpenBSD__)
4343 struct sockpeercred native_creds;
4344 optlen = sizeof (struct sockpeercred);
4346 if (getsockopt (socket->priv->fd,
4349 (void *)&native_creds,
4352 int errsv = get_socket_errno ();
4355 socket_io_error_from_errno (errsv),
4356 _("Unable to get pending error: %s"),
4357 socket_strerror (errsv));
4361 ret = g_credentials_new ();
4362 g_credentials_set_native (ret,
4363 #if defined(__linux__)
4364 G_CREDENTIALS_TYPE_LINUX_UCRED,
4365 #elif defined(__OpenBSD__)
4366 G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED,
4372 g_set_error_literal (error,
4374 G_IO_ERROR_NOT_SUPPORTED,
4375 _("g_socket_get_credentials not implemented for this OS"));
4382 * g_socket_get_option:
4383 * @socket: a #GSocket
4384 * @level: the "API level" of the option (eg, <literal>SOL_SOCKET</literal>)
4385 * @optname: the "name" of the option (eg, <literal>SO_BROADCAST</literal>)
4386 * @value: (out): return location for the option value
4387 * @error: #GError for error reporting, or %NULL to ignore.
4389 * Gets the value of an integer-valued option on @socket, as with
4390 * <literal>getsockopt ()</literal>. (If you need to fetch a
4391 * non-integer-valued option, you will need to call
4392 * <literal>getsockopt ()</literal> directly.)
4394 * The <link linkend="gio-gnetworking.h"><literal><gio/gnetworking.h></literal></link>
4395 * header pulls in system headers that will define most of the
4396 * standard/portable socket options. For unusual socket protocols or
4397 * platform-dependent options, you may need to include additional
4400 * Note that even for socket options that are a single byte in size,
4401 * @value is still a pointer to a #gint variable, not a #guchar;
4402 * g_socket_get_option() will handle the conversion internally.
4404 * Returns: success or failure. On failure, @error will be set, and
4405 * the system error value (<literal>errno</literal> or
4406 * <literal>WSAGetLastError ()</literal>) will still be set to the
4407 * result of the <literal>getsockopt ()</literal> call.
4412 g_socket_get_option (GSocket *socket,
4420 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
4423 size = sizeof (gint);
4424 if (getsockopt (socket->priv->fd, level, optname, value, &size) != 0)
4426 int errsv = get_socket_errno ();
4428 g_set_error_literal (error,
4430 socket_io_error_from_errno (errsv),
4431 socket_strerror (errsv));
4433 /* Reset errno in case the caller wants to look at it */
4439 #if G_BYTE_ORDER == G_BIG_ENDIAN
4440 /* If the returned value is smaller than an int then we need to
4441 * slide it over into the low-order bytes of *value.
4443 if (size != sizeof (gint))
4444 *value = *value >> (8 * (sizeof (gint) - size));
4451 * g_socket_set_option:
4452 * @socket: a #GSocket
4453 * @level: the "API level" of the option (eg, <literal>SOL_SOCKET</literal>)
4454 * @optname: the "name" of the option (eg, <literal>SO_BROADCAST</literal>)
4455 * @value: the value to set the option to
4456 * @error: #GError for error reporting, or %NULL to ignore.
4458 * Sets the value of an integer-valued option on @socket, as with
4459 * <literal>setsockopt ()</literal>. (If you need to set a
4460 * non-integer-valued option, you will need to call
4461 * <literal>setsockopt ()</literal> directly.)
4463 * The <link linkend="gio-gnetworking.h"><literal><gio/gnetworking.h></literal></link>
4464 * header pulls in system headers that will define most of the
4465 * standard/portable socket options. For unusual socket protocols or
4466 * platform-dependent options, you may need to include additional
4469 * Returns: success or failure. On failure, @error will be set, and
4470 * the system error value (<literal>errno</literal> or
4471 * <literal>WSAGetLastError ()</literal>) will still be set to the
4472 * result of the <literal>setsockopt ()</literal> call.
4477 g_socket_set_option (GSocket *socket,
4485 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
4487 if (setsockopt (socket->priv->fd, level, optname, &value, sizeof (gint)) == 0)
4490 #if !defined (__linux__) && !defined (G_OS_WIN32)
4491 /* Linux and Windows let you set a single-byte value from an int,
4492 * but most other platforms don't.
4494 if (errno == EINVAL && value >= SCHAR_MIN && value <= CHAR_MAX)
4496 #if G_BYTE_ORDER == G_BIG_ENDIAN
4497 value = value << (8 * (sizeof (gint) - 1));
4499 if (setsockopt (socket->priv->fd, level, optname, &value, 1) == 0)
4504 errsv = get_socket_errno ();
4506 g_set_error_literal (error,
4508 socket_io_error_from_errno (errsv),
4509 socket_strerror (errsv));