gio/gsocket.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
   4  * Copyright © 2009 Codethink Limited
   5  * Copyright © 2009 Red Hat, Inc
   6  *
   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.
  11  *
  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.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Authors: Christian Kellner <gicmo@gnome.org>
  21  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
  22  *          Ryan Lortie <desrt@desrt.ca>
  23  *          Alexander Larsson <alexl@redhat.com>
  24  */
  25
  26 #include "config.h"
  27
  28 #include "gsocket.h"
  29
  30 #ifdef G_OS_UNIX
  31 #include "glib-unix.h"
  32 #endif
  33
  34 #include <errno.h>
  35 #include <signal.h>
  36 #include <string.h>
  37 #include <stdlib.h>
  38
  39 #ifndef G_OS_WIN32
  40 # include <fcntl.h>
  41 # include <unistd.h>
  42 # include <sys/ioctl.h>
  43 #endif
  44
  45 #ifdef HAVE_SYS_FILIO_H
  46 # include <sys/filio.h>
  47 #endif
  48
  49 #ifdef G_OS_UNIX
  50 #include <sys/uio.h>
  51 #endif
  52
  53 #include "gcancellable.h"
  54 #include "gioenumtypes.h"
  55 #include "ginetaddress.h"
  56 #include "ginitable.h"
  57 #include "gioerror.h"
  58 #include "gioenums.h"
  59 #include "gioerror.h"
  60 #include "gnetworkingprivate.h"
  61 #include "gsocketaddress.h"
  62 #include "gsocketcontrolmessage.h"
  63 #include "gcredentials.h"
  64 #include "gcredentialsprivate.h"
  65 #include "glibintl.h"
  66
  67 #ifdef G_OS_WIN32
  68 /* For Windows XP runtime compatibility, but use the system's if_nametoindex() if available */
  69 #include "gwin32networking.h"
  70 #endif
  71
  72 /**
  73  * SECTION:gsocket
  74  * @short_description: Low-level socket object
  75  * @include: gio/gio.h
  76  * @see_also: #GInitable, [<gnetworking.h>][gio-gnetworking.h]
  77  *
  78  * A #GSocket is a low-level networking primitive. It is a more or less
  79  * direct mapping of the BSD socket API in a portable GObject based API.
  80  * It supports both the UNIX socket implementations and winsock2 on Windows.
  81  *
  82  * #GSocket is the platform independent base upon which the higher level
  83  * network primitives are based. Applications are not typically meant to
  84  * use it directly, but rather through classes like #GSocketClient,
  85  * #GSocketService and #GSocketConnection. However there may be cases where
  86  * direct use of #GSocket is useful.
  87  *
  88  * #GSocket implements the #GInitable interface, so if it is manually constructed
  89  * by e.g. g_object_new() you must call g_initable_init() and check the
  90  * results before using the object. This is done automatically in
  91  * g_socket_new() and g_socket_new_from_fd(), so these functions can return
  92  * %NULL.
  93  *
  94  * Sockets operate in two general modes, blocking or non-blocking. When
  95  * in blocking mode all operations block until the requested operation
  96  * is finished or there is an error. In non-blocking mode all calls that
  97  * would block return immediately with a %G_IO_ERROR_WOULD_BLOCK error.
  98  * To know when a call would successfully run you can call g_socket_condition_check(),
  99  * or g_socket_condition_wait(). You can also use g_socket_create_source() and
 100  * attach it to a #GMainContext to get callbacks when I/O is possible.
 101  * Note that all sockets are always set to non blocking mode in the system, and
 102  * blocking mode is emulated in GSocket.
 103  *
 104  * When working in non-blocking mode applications should always be able to
 105  * handle getting a %G_IO_ERROR_WOULD_BLOCK error even when some other
 106  * function said that I/O was possible. This can easily happen in case
 107  * of a race condition in the application, but it can also happen for other
 108  * reasons. For instance, on Windows a socket is always seen as writable
 109  * until a write returns %G_IO_ERROR_WOULD_BLOCK.
 110  *
 111  * #GSockets can be either connection oriented or datagram based.
 112  * For connection oriented types you must first establish a connection by
 113  * either connecting to an address or accepting a connection from another
 114  * address. For connectionless socket types the target/source address is
 115  * specified or received in each I/O operation.
 116  *
 117  * All socket file descriptors are set to be close-on-exec.
 118  *
 119  * Note that creating a #GSocket causes the signal %SIGPIPE to be
 120  * ignored for the remainder of the program. If you are writing a
 121  * command-line utility that uses #GSocket, you may need to take into
 122  * account the fact that your program will not automatically be killed
 123  * if it tries to write to %stdout after it has been closed.
 124  *
 125  * Like most other APIs in GLib, #GSocket is not inherently thread safe. To use
 126  * a #GSocket concurrently from multiple threads, you must implement your own
 127  * locking.
 128  *
 129  * Since: 2.22
 130  */
 131
 132 static void     g_socket_initable_iface_init (GInitableIface  *iface);
 133 static gboolean g_socket_initable_init       (GInitable       *initable,
 134                                               GCancellable    *cancellable,
 135                                               GError         **error);
 136
 137 enum
 138 {
 139   PROP_0,
 140   PROP_FAMILY,
 141   PROP_TYPE,
 142   PROP_PROTOCOL,
 143   PROP_FD,
 144   PROP_BLOCKING,
 145   PROP_LISTEN_BACKLOG,
 146   PROP_KEEPALIVE,
 147   PROP_LOCAL_ADDRESS,
 148   PROP_REMOTE_ADDRESS,
 149   PROP_TIMEOUT,
 150   PROP_TTL,
 151   PROP_BROADCAST,
 152   PROP_MULTICAST_LOOPBACK,
 153   PROP_MULTICAST_TTL
 154 };
 155
 156 /* Size of the receiver cache for g_socket_receive_from() */
 157 #define RECV_ADDR_CACHE_SIZE 8
 158
 159 struct _GSocketPrivate
 160 {
 161   GSocketFamily   family;
 162   GSocketType     type;
 163   GSocketProtocol protocol;
 164   gint            fd;
 165   gint            listen_backlog;
 166   guint           timeout;
 167   GError         *construct_error;
 168   GSocketAddress *remote_address;
 169   guint           inited : 1;
 170   guint           blocking : 1;
 171   guint           keepalive : 1;
 172   guint           closed : 1;
 173   guint           connected : 1;
 174   guint           listening : 1;
 175   guint           timed_out : 1;
 176   guint           connect_pending : 1;
 177 #ifdef G_OS_WIN32
 178   WSAEVENT        event;
 179   int             current_events;
 180   int             current_errors;
 181   int             selected_events;
 182   GList          *requested_conditions; /* list of requested GIOCondition * */
 183   GMutex          win32_source_lock;
 184 #endif
 185
 186   struct {
 187     GSocketAddress *addr;
 188     struct sockaddr *native;
 189     gint native_len;
 190     guint64 last_used;
 191   } recv_addr_cache[RECV_ADDR_CACHE_SIZE];
 192 };
 193
 194 G_DEFINE_TYPE_WITH_CODE (GSocket, g_socket, G_TYPE_OBJECT,
 195                          G_ADD_PRIVATE (GSocket)
 196                          g_networking_init ();
 197                          G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE,
 198                                                 g_socket_initable_iface_init));
 199
 200 static int
 201 get_socket_errno (void)
 202 {
 203 #ifndef G_OS_WIN32
 204   return errno;
 205 #else
 206   return WSAGetLastError ();
 207 #endif
 208 }
 209
 210 static GIOErrorEnum
 211 socket_io_error_from_errno (int err)
 212 {
 213 #ifdef G_OS_WIN32
 214   return g_io_error_from_win32_error (err);
 215 #else
 216   return g_io_error_from_errno (err);
 217 #endif
 218 }
 219
 220 static const char *
 221 socket_strerror (int err)
 222 {
 223 #ifndef G_OS_WIN32
 224   return g_strerror (err);
 225 #else
 226   const char *msg_ret;
 227   char *msg;
 228
 229   msg = g_win32_error_message (err);
 230
 231   msg_ret = g_intern_string (msg);
 232   g_free (msg);
 233
 234   return msg_ret;
 235 #endif
 236 }
 237
 238 #ifdef G_OS_WIN32
 239 #define win32_unset_event_mask(_socket, _mask) _win32_unset_event_mask (_socket, _mask)
 240 static void
 241 _win32_unset_event_mask (GSocket *socket, int mask)
 242 {
 243   socket->priv->current_events &= ~mask;
 244   socket->priv->current_errors &= ~mask;
 245 }
 246 #else
 247 #define win32_unset_event_mask(_socket, _mask)
 248 #endif
 249
 250 /* Windows has broken prototypes... */
 251 #ifdef G_OS_WIN32
 252 #define getsockopt(sockfd, level, optname, optval, optlen) \
 253   getsockopt (sockfd, level, optname, (gpointer) optval, (int*) optlen)
 254 #define setsockopt(sockfd, level, optname, optval, optlen) \
 255   setsockopt (sockfd, level, optname, (gpointer) optval, optlen)
 256 #define getsockname(sockfd, addr, addrlen) \
 257   getsockname (sockfd, addr, (int *)addrlen)
 258 #define getpeername(sockfd, addr, addrlen) \
 259   getpeername (sockfd, addr, (int *)addrlen)
 260 #define recv(sockfd, buf, len, flags) \
 261   recv (sockfd, (gpointer)buf, len, flags)
 262 #endif
 263
 264 static gboolean
 265 check_socket (GSocket *socket,
 266               GError **error)
 267 {
 268   if (!socket->priv->inited)
 269     {
 270       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_INITIALIZED,
 271                            _("Invalid socket, not initialized"));
 272       return FALSE;
 273     }
 274
 275   if (socket->priv->construct_error)
 276     {
 277       g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_INITIALIZED,
 278                    _("Invalid socket, initialization failed due to: %s"),
 279                    socket->priv->construct_error->message);
 280       return FALSE;
 281     }
 282
 283   if (socket->priv->closed)
 284     {
 285       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
 286                            _("Socket is already closed"));
 287       return FALSE;
 288     }
 289
 290   return TRUE;
 291 }
 292
 293 static gboolean
 294 check_timeout (GSocket *socket,
 295                GError **error)
 296 {
 297   if (socket->priv->timed_out)
 298     {
 299       socket->priv->timed_out = FALSE;
 300       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
 301                            _("Socket I/O timed out"));
 302       return FALSE;
 303     }
 304
 305   return TRUE;
 306 }
 307
 308 static void
 309 g_socket_details_from_fd (GSocket *socket)
 310 {
 311   struct sockaddr_storage address;
 312   gint fd;
 313   guint addrlen;
 314   int value, family;
 315   int errsv;
 316
 317   fd = socket->priv->fd;
 318   if (!g_socket_get_option (socket, SOL_SOCKET, SO_TYPE, &value, NULL))
 319     {
 320       errsv = get_socket_errno ();
 321
 322       switch (errsv)
 323         {
 324 #ifdef ENOTSOCK
 325          case ENOTSOCK:
 326 #else
 327 #ifdef WSAENOTSOCK
 328          case WSAENOTSOCK:
 329 #endif
 330 #endif
 331          case EBADF:
 332           /* programmer error */
 333           g_error ("creating GSocket from fd %d: %s\n",
 334                    fd, socket_strerror (errsv));
 335          default:
 336            break;
 337         }
 338
 339       goto err;
 340     }
 341
 342   switch (value)
 343     {
 344      case SOCK_STREAM:
 345       socket->priv->type = G_SOCKET_TYPE_STREAM;
 346       break;
 347
 348      case SOCK_DGRAM:
 349       socket->priv->type = G_SOCKET_TYPE_DATAGRAM;
 350       break;
 351
 352      case SOCK_SEQPACKET:
 353       socket->priv->type = G_SOCKET_TYPE_SEQPACKET;
 354       break;
 355
 356      default:
 357       socket->priv->type = G_SOCKET_TYPE_INVALID;
 358       break;
 359     }
 360
 361   addrlen = sizeof address;
 362   if (getsockname (fd, (struct sockaddr *) &address, &addrlen) != 0)
 363     {
 364       errsv = get_socket_errno ();
 365       goto err;
 366     }
 367
 368   if (addrlen > 0)
 369     {
 370       g_assert (G_STRUCT_OFFSET (struct sockaddr, sa_family) +
 371                 sizeof address.ss_family <= addrlen);
 372       family = address.ss_family;
 373     }
 374   else
 375     {
 376       /* On Solaris, this happens if the socket is not yet connected.
 377        * But we can use SO_DOMAIN as a workaround there.
 378        */
 379 #ifdef SO_DOMAIN
 380       if (!g_socket_get_option (socket, SOL_SOCKET, SO_DOMAIN, &family, NULL))
 381         {
 382           errsv = get_socket_errno ();
 383           goto err;
 384         }
 385 #else
 386       /* This will translate to G_IO_ERROR_FAILED on either unix or windows */
 387       errsv = -1;
 388       goto err;
 389 #endif
 390     }
 391
 392   switch (family)
 393     {
 394      case G_SOCKET_FAMILY_IPV4:
 395      case G_SOCKET_FAMILY_IPV6:
 396        socket->priv->family = address.ss_family;
 397        switch (socket->priv->type)
 398          {
 399          case G_SOCKET_TYPE_STREAM:
 400            socket->priv->protocol = G_SOCKET_PROTOCOL_TCP;
 401            break;
 402
 403          case G_SOCKET_TYPE_DATAGRAM:
 404            socket->priv->protocol = G_SOCKET_PROTOCOL_UDP;
 405            break;
 406
 407          case G_SOCKET_TYPE_SEQPACKET:
 408            socket->priv->protocol = G_SOCKET_PROTOCOL_SCTP;
 409            break;
 410
 411          default:
 412            break;
 413          }
 414        break;
 415
 416      case G_SOCKET_FAMILY_UNIX:
 417        socket->priv->family = G_SOCKET_FAMILY_UNIX;
 418        socket->priv->protocol = G_SOCKET_PROTOCOL_DEFAULT;
 419        break;
 420
 421      default:
 422        socket->priv->family = G_SOCKET_FAMILY_INVALID;
 423        break;
 424     }
 425
 426   if (socket->priv->family != G_SOCKET_FAMILY_INVALID)
 427     {
 428       addrlen = sizeof address;
 429       if (getpeername (fd, (struct sockaddr *) &address, &addrlen) >= 0)
 430         socket->priv->connected = TRUE;
 431     }
 432
 433   if (g_socket_get_option (socket, SOL_SOCKET, SO_KEEPALIVE, &value, NULL))
 434     {
 435       socket->priv->keepalive = !!value;
 436     }
 437   else
 438     {
 439       /* Can't read, maybe not supported, assume FALSE */
 440       socket->priv->keepalive = FALSE;
 441     }
 442
 443   return;
 444
 445  err:
 446   g_set_error (&socket->priv->construct_error, G_IO_ERROR,
 447                socket_io_error_from_errno (errsv),
 448                _("creating GSocket from fd: %s"),
 449                socket_strerror (errsv));
 450 }
 451
 452 /* Wrapper around socket() that is shared with gnetworkmonitornetlink.c */
 453 gint
 454 g_socket (gint     domain,
 455           gint     type,
 456           gint     protocol,
 457           GError **error)
 458 {
 459   int fd;
 460
 461 #ifdef SOCK_CLOEXEC
 462   fd = socket (domain, type | SOCK_CLOEXEC, protocol);
 463   if (fd != -1)
 464     return fd;
 465
 466   /* It's possible that libc has SOCK_CLOEXEC but the kernel does not */
 467   if (fd < 0 && (errno == EINVAL || errno == EPROTOTYPE))
 468 #endif
 469     fd = socket (domain, type, protocol);
 470
 471   if (fd < 0)
 472     {
 473       int errsv = get_socket_errno ();
 474
 475       g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
 476                    _("Unable to create socket: %s"), socket_strerror (errsv));
 477       errno = errsv;
 478       return -1;
 479     }
 480
 481 #ifndef G_OS_WIN32
 482   {
 483     int flags;
 484
 485     /* We always want to set close-on-exec to protect users. If you
 486        need to so some weird inheritance to exec you can re-enable this
 487        using lower level hacks with g_socket_get_fd(). */
 488     flags = fcntl (fd, F_GETFD, 0);
 489     if (flags != -1 &&
 490         (flags & FD_CLOEXEC) == 0)
 491       {
 492         flags |= FD_CLOEXEC;
 493         fcntl (fd, F_SETFD, flags);
 494       }
 495   }
 496 #endif
 497
 498   return fd;
 499 }
 500
 501 static gint
 502 g_socket_create_socket (GSocketFamily   family,
 503                         GSocketType     type,
 504                         int             protocol,
 505                         GError        **error)
 506 {
 507   gint native_type;
 508
 509   switch (type)
 510     {
 511      case G_SOCKET_TYPE_STREAM:
 512       native_type = SOCK_STREAM;
 513       break;
 514
 515      case G_SOCKET_TYPE_DATAGRAM:
 516       native_type = SOCK_DGRAM;
 517       break;
 518
 519      case G_SOCKET_TYPE_SEQPACKET:
 520       native_type = SOCK_SEQPACKET;
 521       break;
 522
 523      default:
 524       g_assert_not_reached ();
 525     }
 526
 527   if (family <= 0)
 528     {
 529       g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
 530                    _("Unable to create socket: %s"), _("Unknown family was specified"));
 531       return -1;
 532     }
 533
 534   if (protocol == -1)
 535     {
 536       g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
 537                    _("Unable to create socket: %s"), _("Unknown protocol was specified"));
 538       return -1;
 539     }
 540
 541   return g_socket (family, native_type, protocol, error);
 542 }
 543
 544 static void
 545 g_socket_constructed (GObject *object)
 546 {
 547   GSocket *socket = G_SOCKET (object);
 548
 549   if (socket->priv->fd >= 0)
 550     /* create socket->priv info from the fd */
 551     g_socket_details_from_fd (socket);
 552
 553   else
 554     /* create the fd from socket->priv info */
 555     socket->priv->fd = g_socket_create_socket (socket->priv->family,
 556                                                socket->priv->type,
 557                                                socket->priv->protocol,
 558                                                &socket->priv->construct_error);
 559
 560   if (socket->priv->fd != -1)
 561     {
 562 #ifndef G_OS_WIN32
 563       GError *error = NULL;
 564 #else
 565       gulong arg;
 566 #endif
 567
 568       /* Always use native nonblocking sockets, as Windows sets sockets to
 569        * nonblocking automatically in certain operations. This way we make
 570        * things work the same on all platforms.
 571        */
 572 #ifndef G_OS_WIN32
 573       if (!g_unix_set_fd_nonblocking (socket->priv->fd, TRUE, &error))
 574         {
 575           g_warning ("Error setting socket nonblocking: %s", error->message);
 576           g_clear_error (&error);
 577         }
 578 #else
 579       arg = TRUE;
 580
 581       if (ioctlsocket (socket->priv->fd, FIONBIO, &arg) == SOCKET_ERROR)
 582         {
 583           int errsv = get_socket_errno ();
 584           g_warning ("Error setting socket status flags: %s", socket_strerror (errsv));
 585         }
 586 #endif
 587
 588 #ifdef SO_NOSIGPIPE
 589       /* See note about SIGPIPE below. */
 590       g_socket_set_option (socket, SOL_SOCKET, SO_NOSIGPIPE, TRUE, NULL);
 591 #endif
 592     }
 593 }
 594
 595 static void
 596 g_socket_get_property (GObject    *object,
 597                        guint       prop_id,
 598                        GValue     *value,
 599                        GParamSpec *pspec)
 600 {
 601   GSocket *socket = G_SOCKET (object);
 602   GSocketAddress *address;
 603
 604   switch (prop_id)
 605     {
 606       case PROP_FAMILY:
 607         g_value_set_enum (value, socket->priv->family);
 608         break;
 609
 610       case PROP_TYPE:
 611         g_value_set_enum (value, socket->priv->type);
 612         break;
 613
 614       case PROP_PROTOCOL:
 615         g_value_set_enum (value, socket->priv->protocol);
 616         break;
 617
 618       case PROP_FD:
 619         g_value_set_int (value, socket->priv->fd);
 620         break;
 621
 622       case PROP_BLOCKING:
 623         g_value_set_boolean (value, socket->priv->blocking);
 624         break;
 625
 626       case PROP_LISTEN_BACKLOG:
 627         g_value_set_int (value, socket->priv->listen_backlog);
 628         break;
 629
 630       case PROP_KEEPALIVE:
 631         g_value_set_boolean (value, socket->priv->keepalive);
 632         break;
 633
 634       case PROP_LOCAL_ADDRESS:
 635         address = g_socket_get_local_address (socket, NULL);
 636         g_value_take_object (value, address);
 637         break;
 638
 639       case PROP_REMOTE_ADDRESS:
 640         address = g_socket_get_remote_address (socket, NULL);
 641         g_value_take_object (value, address);
 642         break;
 643
 644       case PROP_TIMEOUT:
 645         g_value_set_uint (value, socket->priv->timeout);
 646         break;
 647
 648       case PROP_TTL:
 649         g_value_set_uint (value, g_socket_get_ttl (socket));
 650         break;
 651
 652       case PROP_BROADCAST:
 653         g_value_set_boolean (value, g_socket_get_broadcast (socket));
 654         break;
 655
 656       case PROP_MULTICAST_LOOPBACK:
 657         g_value_set_boolean (value, g_socket_get_multicast_loopback (socket));
 658         break;
 659
 660       case PROP_MULTICAST_TTL:
 661         g_value_set_uint (value, g_socket_get_multicast_ttl (socket));
 662         break;
 663
 664       default:
 665         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 666     }
 667 }
 668
 669 static void
 670 g_socket_set_property (GObject      *object,
 671                        guint         prop_id,
 672                        const GValue *value,
 673                        GParamSpec   *pspec)
 674 {
 675   GSocket *socket = G_SOCKET (object);
 676
 677   switch (prop_id)
 678     {
 679       case PROP_FAMILY:
 680         socket->priv->family = g_value_get_enum (value);
 681         break;
 682
 683       case PROP_TYPE:
 684         socket->priv->type = g_value_get_enum (value);
 685         break;
 686
 687       case PROP_PROTOCOL:
 688         socket->priv->protocol = g_value_get_enum (value);
 689         break;
 690
 691       case PROP_FD:
 692         socket->priv->fd = g_value_get_int (value);
 693         break;
 694
 695       case PROP_BLOCKING:
 696         g_socket_set_blocking (socket, g_value_get_boolean (value));
 697         break;
 698
 699       case PROP_LISTEN_BACKLOG:
 700         g_socket_set_listen_backlog (socket, g_value_get_int (value));
 701         break;
 702
 703       case PROP_KEEPALIVE:
 704         g_socket_set_keepalive (socket, g_value_get_boolean (value));
 705         break;
 706
 707       case PROP_TIMEOUT:
 708         g_socket_set_timeout (socket, g_value_get_uint (value));
 709         break;
 710
 711       case PROP_TTL:
 712         g_socket_set_ttl (socket, g_value_get_uint (value));
 713         break;
 714
 715       case PROP_BROADCAST:
 716         g_socket_set_broadcast (socket, g_value_get_boolean (value));
 717         break;
 718
 719       case PROP_MULTICAST_LOOPBACK:
 720         g_socket_set_multicast_loopback (socket, g_value_get_boolean (value));
 721         break;
 722
 723       case PROP_MULTICAST_TTL:
 724         g_socket_set_multicast_ttl (socket, g_value_get_uint (value));
 725         break;
 726
 727       default:
 728         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 729     }
 730 }
 731
 732 static void
 733 g_socket_finalize (GObject *object)
 734 {
 735   GSocket *socket = G_SOCKET (object);
 736   gint i;
 737
 738   g_clear_error (&socket->priv->construct_error);
 739
 740   if (socket->priv->fd != -1 &&
 741       !socket->priv->closed)
 742     g_socket_close (socket, NULL);
 743
 744   if (socket->priv->remote_address)
 745     g_object_unref (socket->priv->remote_address);
 746
 747 #ifdef G_OS_WIN32
 748   if (socket->priv->event != WSA_INVALID_EVENT)
 749     {
 750       WSACloseEvent (socket->priv->event);
 751       socket->priv->event = WSA_INVALID_EVENT;
 752     }
 753
 754   g_assert (socket->priv->requested_conditions == NULL);
 755   g_mutex_clear (&socket->priv->win32_source_lock);
 756 #endif
 757
 758   for (i = 0; i < RECV_ADDR_CACHE_SIZE; i++)
 759     {
 760       if (socket->priv->recv_addr_cache[i].addr)
 761         {
 762           g_object_unref (socket->priv->recv_addr_cache[i].addr);
 763           g_free (socket->priv->recv_addr_cache[i].native);
 764         }
 765     }
 766
 767   if (G_OBJECT_CLASS (g_socket_parent_class)->finalize)
 768     (*G_OBJECT_CLASS (g_socket_parent_class)->finalize) (object);
 769 }
 770
 771 static void
 772 g_socket_class_init (GSocketClass *klass)
 773 {
 774   GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
 775
 776 #ifdef SIGPIPE
 777   /* There is no portable, thread-safe way to avoid having the process
 778    * be killed by SIGPIPE when calling send() or sendmsg(), so we are
 779    * forced to simply ignore the signal process-wide.
 780    *
 781    * Even if we ignore it though, gdb will still stop if the app
 782    * receives a SIGPIPE, which can be confusing and annoying. So when
 783    * possible, we also use MSG_NOSIGNAL / SO_NOSIGPIPE elsewhere to
 784    * prevent the signal from occurring at all.
 785    */
 786   signal (SIGPIPE, SIG_IGN);
 787 #endif
 788
 789   gobject_class->finalize = g_socket_finalize;
 790   gobject_class->constructed = g_socket_constructed;
 791   gobject_class->set_property = g_socket_set_property;
 792   gobject_class->get_property = g_socket_get_property;
 793
 794   g_object_class_install_property (gobject_class, PROP_FAMILY,
 795                                    g_param_spec_enum ("family",
 796                                                       P_("Socket family"),
 797                                                       P_("The sockets address family"),
 798                                                       G_TYPE_SOCKET_FAMILY,
 799                                                       G_SOCKET_FAMILY_INVALID,
 800                                                       G_PARAM_CONSTRUCT_ONLY |
 801                                                       G_PARAM_READWRITE |
 802                                                       G_PARAM_STATIC_STRINGS));
 803
 804   g_object_class_install_property (gobject_class, PROP_TYPE,
 805                                    g_param_spec_enum ("type",
 806                                                       P_("Socket type"),
 807                                                       P_("The sockets type"),
 808                                                       G_TYPE_SOCKET_TYPE,
 809                                                       G_SOCKET_TYPE_STREAM,
 810                                                       G_PARAM_CONSTRUCT_ONLY |
 811                                                       G_PARAM_READWRITE |
 812                                                       G_PARAM_STATIC_STRINGS));
 813
 814   g_object_class_install_property (gobject_class, PROP_PROTOCOL,
 815                                    g_param_spec_enum ("protocol",
 816                                                       P_("Socket protocol"),
 817                                                       P_("The id of the protocol to use, or -1 for unknown"),
 818                                                       G_TYPE_SOCKET_PROTOCOL,
 819                                                       G_SOCKET_PROTOCOL_UNKNOWN,
 820                                                       G_PARAM_CONSTRUCT_ONLY |
 821                                                       G_PARAM_READWRITE |
 822                                                       G_PARAM_STATIC_STRINGS));
 823
 824   g_object_class_install_property (gobject_class, PROP_FD,
 825                                    g_param_spec_int ("fd",
 826                                                      P_("File descriptor"),
 827                                                      P_("The sockets file descriptor"),
 828                                                      G_MININT,
 829                                                      G_MAXINT,
 830                                                      -1,
 831                                                      G_PARAM_CONSTRUCT_ONLY |
 832                                                      G_PARAM_READWRITE |
 833                                                      G_PARAM_STATIC_STRINGS));
 834
 835   g_object_class_install_property (gobject_class, PROP_BLOCKING,
 836                                    g_param_spec_boolean ("blocking",
 837                                                          P_("blocking"),
 838                                                          P_("Whether or not I/O on this socket is blocking"),
 839                                                          TRUE,
 840                                                          G_PARAM_READWRITE |
 841                                                          G_PARAM_STATIC_STRINGS));
 842
 843   g_object_class_install_property (gobject_class, PROP_LISTEN_BACKLOG,
 844                                    g_param_spec_int ("listen-backlog",
 845                                                      P_("Listen backlog"),
 846                                                      P_("Outstanding connections in the listen queue"),
 847                                                      0,
 848                                                      SOMAXCONN,
 849                                                      10,
 850                                                      G_PARAM_READWRITE |
 851                                                      G_PARAM_STATIC_STRINGS));
 852
 853   g_object_class_install_property (gobject_class, PROP_KEEPALIVE,
 854                                    g_param_spec_boolean ("keepalive",
 855                                                          P_("Keep connection alive"),
 856                                                          P_("Keep connection alive by sending periodic pings"),
 857                                                          FALSE,
 858                                                          G_PARAM_READWRITE |
 859                                                          G_PARAM_STATIC_STRINGS));
 860
 861   g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
 862                                    g_param_spec_object ("local-address",
 863                                                         P_("Local address"),
 864                                                         P_("The local address the socket is bound to"),
 865                                                         G_TYPE_SOCKET_ADDRESS,
 866                                                         G_PARAM_READABLE |
 867                                                         G_PARAM_STATIC_STRINGS));
 868
 869   g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
 870                                    g_param_spec_object ("remote-address",
 871                                                         P_("Remote address"),
 872                                                         P_("The remote address the socket is connected to"),
 873                                                         G_TYPE_SOCKET_ADDRESS,
 874                                                         G_PARAM_READABLE |
 875                                                         G_PARAM_STATIC_STRINGS));
 876
 877   /**
 878    * GSocket:timeout:
 879    *
 880    * The timeout in seconds on socket I/O
 881    *
 882    * Since: 2.26
 883    */
 884   g_object_class_install_property (gobject_class, PROP_TIMEOUT,
 885                                    g_param_spec_uint ("timeout",
 886                                                       P_("Timeout"),
 887                                                       P_("The timeout in seconds on socket I/O"),
 888                                                       0,
 889                                                       G_MAXUINT,
 890                                                       0,
 891                                                       G_PARAM_READWRITE |
 892                                                       G_PARAM_STATIC_STRINGS));
 893
 894   /**
 895    * GSocket:broadcast:
 896    *
 897    * Whether the socket should allow sending to broadcast addresses.
 898    *
 899    * Since: 2.32
 900    */
 901   g_object_class_install_property (gobject_class, PROP_BROADCAST,
 902                                    g_param_spec_boolean ("broadcast",
 903                                                          P_("Broadcast"),
 904                                                          P_("Whether to allow sending to broadcast addresses"),
 905                                                          FALSE,
 906                                                          G_PARAM_READWRITE |
 907                                                          G_PARAM_STATIC_STRINGS));
 908
 909   /**
 910    * GSocket:ttl:
 911    *
 912    * Time-to-live for outgoing unicast packets
 913    *
 914    * Since: 2.32
 915    */
 916   g_object_class_install_property (gobject_class, PROP_TTL,
 917                                    g_param_spec_uint ("ttl",
 918                                                       P_("TTL"),
 919                                                       P_("Time-to-live of outgoing unicast packets"),
 920                                                       0, G_MAXUINT, 0,
 921                                                       G_PARAM_READWRITE |
 922                                                       G_PARAM_STATIC_STRINGS));
 923
 924   /**
 925    * GSocket:multicast-loopback:
 926    *
 927    * Whether outgoing multicast packets loop back to the local host.
 928    *
 929    * Since: 2.32
 930    */
 931   g_object_class_install_property (gobject_class, PROP_MULTICAST_LOOPBACK,
 932                                    g_param_spec_boolean ("multicast-loopback",
 933                                                          P_("Multicast loopback"),
 934                                                          P_("Whether outgoing multicast packets loop back to the local host"),
 935                                                          TRUE,
 936                                                          G_PARAM_READWRITE |
 937                                                          G_PARAM_STATIC_STRINGS));
 938
 939   /**
 940    * GSocket:multicast-ttl:
 941    *
 942    * Time-to-live out outgoing multicast packets
 943    *
 944    * Since: 2.32
 945    */
 946   g_object_class_install_property (gobject_class, PROP_MULTICAST_TTL,
 947                                    g_param_spec_uint ("multicast-ttl",
 948                                                       P_("Multicast TTL"),
 949                                                       P_("Time-to-live of outgoing multicast packets"),
 950                                                       0, G_MAXUINT, 1,
 951                                                       G_PARAM_READWRITE |
 952                                                       G_PARAM_STATIC_STRINGS));
 953 }
 954
 955 static void
 956 g_socket_initable_iface_init (GInitableIface *iface)
 957 {
 958   iface->init = g_socket_initable_init;
 959 }
 960
 961 static void
 962 g_socket_init (GSocket *socket)
 963 {
 964   socket->priv = g_socket_get_instance_private (socket);
 965
 966   socket->priv->fd = -1;
 967   socket->priv->blocking = TRUE;
 968   socket->priv->listen_backlog = 10;
 969   socket->priv->construct_error = NULL;
 970 #ifdef G_OS_WIN32
 971   socket->priv->event = WSA_INVALID_EVENT;
 972   g_mutex_init (&socket->priv->win32_source_lock);
 973 #endif
 974 }
 975
 976 static gboolean
 977 g_socket_initable_init (GInitable *initable,
 978                         GCancellable *cancellable,
 979                         GError  **error)
 980 {
 981   GSocket  *socket;
 982
 983   g_return_val_if_fail (G_IS_SOCKET (initable), FALSE);
 984
 985   socket = G_SOCKET (initable);
 986
 987   if (cancellable != NULL)
 988     {
 989       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
 990                            _("Cancellable initialization not supported"));
 991       return FALSE;
 992     }
 993
 994   socket->priv->inited = TRUE;
 995
 996   if (socket->priv->construct_error)
 997     {
 998       if (error)
 999         *error = g_error_copy (socket->priv->construct_error);
1000       return FALSE;
1001     }
1002
1003
1004   return TRUE;
1005 }
1006
1007 /**
1008  * g_socket_new:
1009  * @family: the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.
1010  * @type: the socket type to use.
1011  * @protocol: the id of the protocol to use, or 0 for default.
1012  * @error: #GError for error reporting, or %NULL to ignore.
1013  *
1014  * Creates a new #GSocket with the defined family, type and protocol.
1015  * If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type
1016  * for the family and type is used.
1017  *
1018  * The @protocol is a family and type specific int that specifies what
1019  * kind of protocol to use. #GSocketProtocol lists several common ones.
1020  * Many families only support one protocol, and use 0 for this, others
1021  * support several and using 0 means to use the default protocol for
1022  * the family and type.
1023  *
1024  * The protocol id is passed directly to the operating
1025  * system, so you can use protocols not listed in #GSocketProtocol if you
1026  * know the protocol number used for it.
1027  *
1028  * Returns: a #GSocket or %NULL on error.
1029  *     Free the returned object with g_object_unref().
1030  *
1031  * Since: 2.22
1032  */
1033 GSocket *
1034 g_socket_new (GSocketFamily     family,
1035               GSocketType       type,
1036               GSocketProtocol   protocol,
1037               GError          **error)
1038 {
1039   return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
1040                                    NULL, error,
1041                                    "family", family,
1042                                    "type", type,
1043                                    "protocol", protocol,
1044                                    NULL));
1045 }
1046
1047 /**
1048  * g_socket_new_from_fd:
1049  * @fd: a native socket file descriptor.
1050  * @error: #GError for error reporting, or %NULL to ignore.
1051  *
1052  * Creates a new #GSocket from a native file descriptor
1053  * or winsock SOCKET handle.
1054  *
1055  * This reads all the settings from the file descriptor so that
1056  * all properties should work. Note that the file descriptor
1057  * will be set to non-blocking mode, independent on the blocking
1058  * mode of the #GSocket.
1059  *
1060  * Returns: a #GSocket or %NULL on error.
1061  *     Free the returned object with g_object_unref().
1062  *
1063  * Since: 2.22
1064  */
1065 GSocket *
1066 g_socket_new_from_fd (gint     fd,
1067                       GError **error)
1068 {
1069   return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
1070                                    NULL, error,
1071                                    "fd", fd,
1072                                    NULL));
1073 }
1074
1075 /**
1076  * g_socket_set_blocking:
1077  * @socket: a #GSocket.
1078  * @blocking: Whether to use blocking I/O or not.
1079  *
1080  * Sets the blocking mode of the socket. In blocking mode
1081  * all operations block until they succeed or there is an error. In
1082  * non-blocking mode all functions return results immediately or
1083  * with a %G_IO_ERROR_WOULD_BLOCK error.
1084  *
1085  * All sockets are created in blocking mode. However, note that the
1086  * platform level socket is always non-blocking, and blocking mode
1087  * is a GSocket level feature.
1088  *
1089  * Since: 2.22
1090  */
1091 void
1092 g_socket_set_blocking (GSocket  *socket,
1093                        gboolean  blocking)
1094 {
1095   g_return_if_fail (G_IS_SOCKET (socket));
1096
1097   blocking = !!blocking;
1098
1099   if (socket->priv->blocking == blocking)
1100     return;
1101
1102   socket->priv->blocking = blocking;
1103   g_object_notify (G_OBJECT (socket), "blocking");
1104 }
1105
1106 /**
1107  * g_socket_get_blocking:
1108  * @socket: a #GSocket.
1109  *
1110  * Gets the blocking mode of the socket. For details on blocking I/O,
1111  * see g_socket_set_blocking().
1112  *
1113  * Returns: %TRUE if blocking I/O is used, %FALSE otherwise.
1114  *
1115  * Since: 2.22
1116  */
1117 gboolean
1118 g_socket_get_blocking (GSocket *socket)
1119 {
1120   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1121
1122   return socket->priv->blocking;
1123 }
1124
1125 /**
1126  * g_socket_set_keepalive:
1127  * @socket: a #GSocket.
1128  * @keepalive: Value for the keepalive flag
1129  *
1130  * Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When
1131  * this flag is set on a socket, the system will attempt to verify that the
1132  * remote socket endpoint is still present if a sufficiently long period of
1133  * time passes with no data being exchanged. If the system is unable to
1134  * verify the presence of the remote endpoint, it will automatically close
1135  * the connection.
1136  *
1137  * This option is only functional on certain kinds of sockets. (Notably,
1138  * %G_SOCKET_PROTOCOL_TCP sockets.)
1139  *
1140  * The exact time between pings is system- and protocol-dependent, but will
1141  * normally be at least two hours. Most commonly, you would set this flag
1142  * on a server socket if you want to allow clients to remain idle for long
1143  * periods of time, but also want to ensure that connections are eventually
1144  * garbage-collected if clients crash or become unreachable.
1145  *
1146  * Since: 2.22
1147  */
1148 void
1149 g_socket_set_keepalive (GSocket  *socket,
1150                         gboolean  keepalive)
1151 {
1152   GError *error = NULL;
1153
1154   g_return_if_fail (G_IS_SOCKET (socket));
1155
1156   keepalive = !!keepalive;
1157   if (socket->priv->keepalive == keepalive)
1158     return;
1159
1160   if (!g_socket_set_option (socket, SOL_SOCKET, SO_KEEPALIVE,
1161                             keepalive, &error))
1162     {
1163       g_warning ("error setting keepalive: %s", error->message);
1164       g_error_free (error);
1165       return;
1166     }
1167
1168   socket->priv->keepalive = keepalive;
1169   g_object_notify (G_OBJECT (socket), "keepalive");
1170 }
1171
1172 /**
1173  * g_socket_get_keepalive:
1174  * @socket: a #GSocket.
1175  *
1176  * Gets the keepalive mode of the socket. For details on this,
1177  * see g_socket_set_keepalive().
1178  *
1179  * Returns: %TRUE if keepalive is active, %FALSE otherwise.
1180  *
1181  * Since: 2.22
1182  */
1183 gboolean
1184 g_socket_get_keepalive (GSocket *socket)
1185 {
1186   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1187
1188   return socket->priv->keepalive;
1189 }
1190
1191 /**
1192  * g_socket_get_listen_backlog:
1193  * @socket: a #GSocket.
1194  *
1195  * Gets the listen backlog setting of the socket. For details on this,
1196  * see g_socket_set_listen_backlog().
1197  *
1198  * Returns: the maximum number of pending connections.
1199  *
1200  * Since: 2.22
1201  */
1202 gint
1203 g_socket_get_listen_backlog  (GSocket *socket)
1204 {
1205   g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1206
1207   return socket->priv->listen_backlog;
1208 }
1209
1210 /**
1211  * g_socket_set_listen_backlog:
1212  * @socket: a #GSocket.
1213  * @backlog: the maximum number of pending connections.
1214  *
1215  * Sets the maximum number of outstanding connections allowed
1216  * when listening on this socket. If more clients than this are
1217  * connecting to the socket and the application is not handling them
1218  * on time then the new connections will be refused.
1219  *
1220  * Note that this must be called before g_socket_listen() and has no
1221  * effect if called after that.
1222  *
1223  * Since: 2.22
1224  */
1225 void
1226 g_socket_set_listen_backlog (GSocket *socket,
1227                              gint     backlog)
1228 {
1229   g_return_if_fail (G_IS_SOCKET (socket));
1230   g_return_if_fail (!socket->priv->listening);
1231
1232   if (backlog != socket->priv->listen_backlog)
1233     {
1234       socket->priv->listen_backlog = backlog;
1235       g_object_notify (G_OBJECT (socket), "listen-backlog");
1236     }
1237 }
1238
1239 /**
1240  * g_socket_get_timeout:
1241  * @socket: a #GSocket.
1242  *
1243  * Gets the timeout setting of the socket. For details on this, see
1244  * g_socket_set_timeout().
1245  *
1246  * Returns: the timeout in seconds
1247  *
1248  * Since: 2.26
1249  */
1250 guint
1251 g_socket_get_timeout (GSocket *socket)
1252 {
1253   g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1254
1255   return socket->priv->timeout;
1256 }
1257
1258 /**
1259  * g_socket_set_timeout:
1260  * @socket: a #GSocket.
1261  * @timeout: the timeout for @socket, in seconds, or 0 for none
1262  *
1263  * Sets the time in seconds after which I/O operations on @socket will
1264  * time out if they have not yet completed.
1265  *
1266  * On a blocking socket, this means that any blocking #GSocket
1267  * operation will time out after @timeout seconds of inactivity,
1268  * returning %G_IO_ERROR_TIMED_OUT.
1269  *
1270  * On a non-blocking socket, calls to g_socket_condition_wait() will
1271  * also fail with %G_IO_ERROR_TIMED_OUT after the given time. Sources
1272  * created with g_socket_create_source() will trigger after
1273  * @timeout seconds of inactivity, with the requested condition
1274  * set, at which point calling g_socket_receive(), g_socket_send(),
1275  * g_socket_check_connect_result(), etc, will fail with
1276  * %G_IO_ERROR_TIMED_OUT.
1277  *
1278  * If @timeout is 0 (the default), operations will never time out
1279  * on their own.
1280  *
1281  * Note that if an I/O operation is interrupted by a signal, this may
1282  * cause the timeout to be reset.
1283  *
1284  * Since: 2.26
1285  */
1286 void
1287 g_socket_set_timeout (GSocket *socket,
1288                       guint    timeout)
1289 {
1290   g_return_if_fail (G_IS_SOCKET (socket));
1291
1292   if (timeout != socket->priv->timeout)
1293     {
1294       socket->priv->timeout = timeout;
1295       g_object_notify (G_OBJECT (socket), "timeout");
1296     }
1297 }
1298
1299 /**
1300  * g_socket_get_ttl:
1301  * @socket: a #GSocket.
1302  *
1303  * Gets the unicast time-to-live setting on @socket; see
1304  * g_socket_set_ttl() for more details.
1305  *
1306  * Returns: the time-to-live setting on @socket
1307  *
1308  * Since: 2.32
1309  */
1310 guint
1311 g_socket_get_ttl (GSocket *socket)
1312 {
1313   GError *error = NULL;
1314   gint value;
1315
1316   g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1317
1318   if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1319     {
1320       g_socket_get_option (socket, IPPROTO_IP, IP_TTL,
1321                            &value, &error);
1322     }
1323   else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1324     {
1325       g_socket_get_option (socket, IPPROTO_IPV6, IPV6_UNICAST_HOPS,
1326                            &value, &error);
1327     }
1328   else
1329     g_return_val_if_reached (0);
1330
1331   if (error)
1332     {
1333       g_warning ("error getting unicast ttl: %s", error->message);
1334       g_error_free (error);
1335       return 0;
1336     }
1337
1338   return value;
1339 }
1340
1341 /**
1342  * g_socket_set_ttl:
1343  * @socket: a #GSocket.
1344  * @ttl: the time-to-live value for all unicast packets on @socket
1345  *
1346  * Sets the time-to-live for outgoing unicast packets on @socket.
1347  * By default the platform-specific default value is used.
1348  *
1349  * Since: 2.32
1350  */
1351 void
1352 g_socket_set_ttl (GSocket  *socket,
1353                   guint     ttl)
1354 {
1355   GError *error = NULL;
1356
1357   g_return_if_fail (G_IS_SOCKET (socket));
1358
1359   if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1360     {
1361       g_socket_set_option (socket, IPPROTO_IP, IP_TTL,
1362                            ttl, &error);
1363     }
1364   else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1365     {
1366       g_socket_set_option (socket, IPPROTO_IP, IP_TTL,
1367                            ttl, NULL);
1368       g_socket_set_option (socket, IPPROTO_IPV6, IPV6_UNICAST_HOPS,
1369                            ttl, &error);
1370     }
1371   else
1372     g_return_if_reached ();
1373
1374   if (error)
1375     {
1376       g_warning ("error setting unicast ttl: %s", error->message);
1377       g_error_free (error);
1378       return;
1379     }
1380
1381   g_object_notify (G_OBJECT (socket), "ttl");
1382 }
1383
1384 /**
1385  * g_socket_get_broadcast:
1386  * @socket: a #GSocket.
1387  *
1388  * Gets the broadcast setting on @socket; if %TRUE,
1389  * it is possible to send packets to broadcast
1390  * addresses.
1391  *
1392  * Returns: the broadcast setting on @socket
1393  *
1394  * Since: 2.32
1395  */
1396 gboolean
1397 g_socket_get_broadcast (GSocket *socket)
1398 {
1399   GError *error = NULL;
1400   gint value;
1401
1402   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1403
1404   if (!g_socket_get_option (socket, SOL_SOCKET, SO_BROADCAST,
1405                             &value, &error))
1406     {
1407       g_warning ("error getting broadcast: %s", error->message);
1408       g_error_free (error);
1409       return FALSE;
1410     }
1411
1412   return !!value;
1413 }
1414
1415 /**
1416  * g_socket_set_broadcast:
1417  * @socket: a #GSocket.
1418  * @broadcast: whether @socket should allow sending to broadcast
1419  *     addresses
1420  *
1421  * Sets whether @socket should allow sending to broadcast addresses.
1422  * This is %FALSE by default.
1423  *
1424  * Since: 2.32
1425  */
1426 void
1427 g_socket_set_broadcast (GSocket    *socket,
1428                         gboolean    broadcast)
1429 {
1430   GError *error = NULL;
1431
1432   g_return_if_fail (G_IS_SOCKET (socket));
1433
1434   broadcast = !!broadcast;
1435
1436   if (!g_socket_set_option (socket, SOL_SOCKET, SO_BROADCAST,
1437                             broadcast, &error))
1438     {
1439       g_warning ("error setting broadcast: %s", error->message);
1440       g_error_free (error);
1441       return;
1442     }
1443
1444   g_object_notify (G_OBJECT (socket), "broadcast");
1445 }
1446
1447 /**
1448  * g_socket_get_multicast_loopback:
1449  * @socket: a #GSocket.
1450  *
1451  * Gets the multicast loopback setting on @socket; if %TRUE (the
1452  * default), outgoing multicast packets will be looped back to
1453  * multicast listeners on the same host.
1454  *
1455  * Returns: the multicast loopback setting on @socket
1456  *
1457  * Since: 2.32
1458  */
1459 gboolean
1460 g_socket_get_multicast_loopback (GSocket *socket)
1461 {
1462   GError *error = NULL;
1463   gint value;
1464
1465   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1466
1467   if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1468     {
1469       g_socket_get_option (socket, IPPROTO_IP, IP_MULTICAST_LOOP,
1470                            &value, &error);
1471     }
1472   else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1473     {
1474       g_socket_get_option (socket, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
1475                            &value, &error);
1476     }
1477   else
1478     g_return_val_if_reached (FALSE);
1479
1480   if (error)
1481     {
1482       g_warning ("error getting multicast loopback: %s", error->message);
1483       g_error_free (error);
1484       return FALSE;
1485     }
1486
1487   return !!value;
1488 }
1489
1490 /**
1491  * g_socket_set_multicast_loopback:
1492  * @socket: a #GSocket.
1493  * @loopback: whether @socket should receive messages sent to its
1494  *   multicast groups from the local host
1495  *
1496  * Sets whether outgoing multicast packets will be received by sockets
1497  * listening on that multicast address on the same host. This is %TRUE
1498  * by default.
1499  *
1500  * Since: 2.32
1501  */
1502 void
1503 g_socket_set_multicast_loopback (GSocket    *socket,
1504                                  gboolean    loopback)
1505 {
1506   GError *error = NULL;
1507
1508   g_return_if_fail (G_IS_SOCKET (socket));
1509
1510   loopback = !!loopback;
1511
1512   if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1513     {
1514       g_socket_set_option (socket, IPPROTO_IP, IP_MULTICAST_LOOP,
1515                            loopback, &error);
1516     }
1517   else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1518     {
1519       g_socket_set_option (socket, IPPROTO_IP, IP_MULTICAST_LOOP,
1520                            loopback, NULL);
1521       g_socket_set_option (socket, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
1522                            loopback, &error);
1523     }
1524   else
1525     g_return_if_reached ();
1526
1527   if (error)
1528     {
1529       g_warning ("error setting multicast loopback: %s", error->message);
1530       g_error_free (error);
1531       return;
1532     }
1533
1534   g_object_notify (G_OBJECT (socket), "multicast-loopback");
1535 }
1536
1537 /**
1538  * g_socket_get_multicast_ttl:
1539  * @socket: a #GSocket.
1540  *
1541  * Gets the multicast time-to-live setting on @socket; see
1542  * g_socket_set_multicast_ttl() for more details.
1543  *
1544  * Returns: the multicast time-to-live setting on @socket
1545  *
1546  * Since: 2.32
1547  */
1548 guint
1549 g_socket_get_multicast_ttl (GSocket *socket)
1550 {
1551   GError *error = NULL;
1552   gint value;
1553
1554   g_return_val_if_fail (G_IS_SOCKET (socket), 0);
1555
1556   if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1557     {
1558       g_socket_get_option (socket, IPPROTO_IP, IP_MULTICAST_TTL,
1559                            &value, &error);
1560     }
1561   else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1562     {
1563       g_socket_get_option (socket, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
1564                            &value, &error);
1565     }
1566   else
1567     g_return_val_if_reached (FALSE);
1568
1569   if (error)
1570     {
1571       g_warning ("error getting multicast ttl: %s", error->message);
1572       g_error_free (error);
1573       return FALSE;
1574     }
1575
1576   return value;
1577 }
1578
1579 /**
1580  * g_socket_set_multicast_ttl:
1581  * @socket: a #GSocket.
1582  * @ttl: the time-to-live value for all multicast datagrams on @socket
1583  *
1584  * Sets the time-to-live for outgoing multicast datagrams on @socket.
1585  * By default, this is 1, meaning that multicast packets will not leave
1586  * the local network.
1587  *
1588  * Since: 2.32
1589  */
1590 void
1591 g_socket_set_multicast_ttl (GSocket  *socket,
1592                             guint     ttl)
1593 {
1594   GError *error = NULL;
1595
1596   g_return_if_fail (G_IS_SOCKET (socket));
1597
1598   if (socket->priv->family == G_SOCKET_FAMILY_IPV4)
1599     {
1600       g_socket_set_option (socket, IPPROTO_IP, IP_MULTICAST_TTL,
1601                            ttl, &error);
1602     }
1603   else if (socket->priv->family == G_SOCKET_FAMILY_IPV6)
1604     {
1605       g_socket_set_option (socket, IPPROTO_IP, IP_MULTICAST_TTL,
1606                            ttl, NULL);
1607       g_socket_set_option (socket, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
1608                            ttl, &error);
1609     }
1610   else
1611     g_return_if_reached ();
1612
1613   if (error)
1614     {
1615       g_warning ("error setting multicast ttl: %s", error->message);
1616       g_error_free (error);
1617       return;
1618     }
1619
1620   g_object_notify (G_OBJECT (socket), "multicast-ttl");
1621 }
1622
1623 /**
1624  * g_socket_get_family:
1625  * @socket: a #GSocket.
1626  *
1627  * Gets the socket family of the socket.
1628  *
1629  * Returns: a #GSocketFamily
1630  *
1631  * Since: 2.22
1632  */
1633 GSocketFamily
1634 g_socket_get_family (GSocket *socket)
1635 {
1636   g_return_val_if_fail (G_IS_SOCKET (socket), G_SOCKET_FAMILY_INVALID);
1637
1638   return socket->priv->family;
1639 }
1640
1641 /**
1642  * g_socket_get_socket_type:
1643  * @socket: a #GSocket.
1644  *
1645  * Gets the socket type of the socket.
1646  *
1647  * Returns: a #GSocketType
1648  *
1649  * Since: 2.22
1650  */
1651 GSocketType
1652 g_socket_get_socket_type (GSocket *socket)
1653 {
1654   g_return_val_if_fail (G_IS_SOCKET (socket), G_SOCKET_TYPE_INVALID);
1655
1656   return socket->priv->type;
1657 }
1658
1659 /**
1660  * g_socket_get_protocol:
1661  * @socket: a #GSocket.
1662  *
1663  * Gets the socket protocol id the socket was created with.
1664  * In case the protocol is unknown, -1 is returned.
1665  *
1666  * Returns: a protocol id, or -1 if unknown
1667  *
1668  * Since: 2.22
1669  */
1670 GSocketProtocol
1671 g_socket_get_protocol (GSocket *socket)
1672 {
1673   g_return_val_if_fail (G_IS_SOCKET (socket), -1);
1674
1675   return socket->priv->protocol;
1676 }
1677
1678 /**
1679  * g_socket_get_fd:
1680  * @socket: a #GSocket.
1681  *
1682  * Returns the underlying OS socket object. On unix this
1683  * is a socket file descriptor, and on Windows this is
1684  * a Winsock2 SOCKET handle. This may be useful for
1685  * doing platform specific or otherwise unusual operations
1686  * on the socket.
1687  *
1688  * Returns: the file descriptor of the socket.
1689  *
1690  * Since: 2.22
1691  */
1692 int
1693 g_socket_get_fd (GSocket *socket)
1694 {
1695   g_return_val_if_fail (G_IS_SOCKET (socket), -1);
1696
1697   return socket->priv->fd;
1698 }
1699
1700 /**
1701  * g_socket_get_local_address:
1702  * @socket: a #GSocket.
1703  * @error: #GError for error reporting, or %NULL to ignore.
1704  *
1705  * Try to get the local address of a bound socket. This is only
1706  * useful if the socket has been bound to a local address,
1707  * either explicitly or implicitly when connecting.
1708  *
1709  * Returns: (transfer full): a #GSocketAddress or %NULL on error.
1710  *     Free the returned object with g_object_unref().
1711  *
1712  * Since: 2.22
1713  */
1714 GSocketAddress *
1715 g_socket_get_local_address (GSocket  *socket,
1716                             GError  **error)
1717 {
1718   struct sockaddr_storage buffer;
1719   guint len = sizeof (buffer);
1720
1721   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1722
1723   if (getsockname (socket->priv->fd, (struct sockaddr *) &buffer, &len) < 0)
1724     {
1725       int errsv = get_socket_errno ();
1726       g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1727                    _("could not get local address: %s"), socket_strerror (errsv));
1728       return NULL;
1729     }
1730
1731   return g_socket_address_new_from_native (&buffer, len);
1732 }
1733
1734 /**
1735  * g_socket_get_remote_address:
1736  * @socket: a #GSocket.
1737  * @error: #GError for error reporting, or %NULL to ignore.
1738  *
1739  * Try to get the remove address of a connected socket. This is only
1740  * useful for connection oriented sockets that have been connected.
1741  *
1742  * Returns: (transfer full): a #GSocketAddress or %NULL on error.
1743  *     Free the returned object with g_object_unref().
1744  *
1745  * Since: 2.22
1746  */
1747 GSocketAddress *
1748 g_socket_get_remote_address (GSocket  *socket,
1749                              GError  **error)
1750 {
1751   struct sockaddr_storage buffer;
1752   guint len = sizeof (buffer);
1753
1754   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
1755
1756   if (socket->priv->connect_pending)
1757     {
1758       if (!g_socket_check_connect_result (socket, error))
1759         return NULL;
1760       else
1761         socket->priv->connect_pending = FALSE;
1762     }
1763
1764   if (!socket->priv->remote_address)
1765     {
1766       if (getpeername (socket->priv->fd, (struct sockaddr *) &buffer, &len) < 0)
1767         {
1768           int errsv = get_socket_errno ();
1769           g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1770                        _("could not get remote address: %s"), socket_strerror (errsv));
1771           return NULL;
1772         }
1773
1774       socket->priv->remote_address = g_socket_address_new_from_native (&buffer, len);
1775     }
1776
1777   return g_object_ref (socket->priv->remote_address);
1778 }
1779
1780 /**
1781  * g_socket_is_connected:
1782  * @socket: a #GSocket.
1783  *
1784  * Check whether the socket is connected. This is only useful for
1785  * connection-oriented sockets.
1786  *
1787  * Returns: %TRUE if socket is connected, %FALSE otherwise.
1788  *
1789  * Since: 2.22
1790  */
1791 gboolean
1792 g_socket_is_connected (GSocket *socket)
1793 {
1794   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1795
1796   return socket->priv->connected;
1797 }
1798
1799 /**
1800  * g_socket_listen:
1801  * @socket: a #GSocket.
1802  * @error: #GError for error reporting, or %NULL to ignore.
1803  *
1804  * Marks the socket as a server socket, i.e. a socket that is used
1805  * to accept incoming requests using g_socket_accept().
1806  *
1807  * Before calling this the socket must be bound to a local address using
1808  * g_socket_bind().
1809  *
1810  * To set the maximum amount of outstanding clients, use
1811  * g_socket_set_listen_backlog().
1812  *
1813  * Returns: %TRUE on success, %FALSE on error.
1814  *
1815  * Since: 2.22
1816  */
1817 gboolean
1818 g_socket_listen (GSocket  *socket,
1819                  GError  **error)
1820 {
1821   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
1822
1823   if (!check_socket (socket, error))
1824     return FALSE;
1825
1826   if (listen (socket->priv->fd, socket->priv->listen_backlog) < 0)
1827     {
1828       int errsv = get_socket_errno ();
1829
1830       g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
1831                    _("could not listen: %s"), socket_strerror (errsv));
1832       return FALSE;
1833     }
1834
1835   socket->priv->listening = TRUE;
1836
1837   return TRUE;
1838 }
1839
1840 /**
1841  * g_socket_bind:
1842  * @socket: a #GSocket.
1843  * @address: a #GSocketAddress specifying the local address.
1844  * @allow_reuse: whether to allow reusing this address
1845  * @error: #GError for error reporting, or %NULL to ignore.
1846  *
1847  * When a socket is created it is attached to an address family, but it
1848  * doesn't have an address in this family. g_socket_bind() assigns the
1849  * address (sometimes called name) of the socket.
1850  *
1851  * It is generally required to bind to a local address before you can
1852  * receive connections. (See g_socket_listen() and g_socket_accept() ).
1853  * In certain situations, you may also want to bind a socket that will be
1854  * used to initiate connections, though this is not normally required.
1855  *
1856  * If @socket is a TCP socket, then @allow_reuse controls the setting
1857  * of the `SO_REUSEADDR` socket option; normally it should be %TRUE for
1858  * server sockets (sockets that you will eventually call
1859  * g_socket_accept() on), and %FALSE for client sockets. (Failing to
1860  * set this flag on a server socket may cause g_socket_bind() to return
1861  * %G_IO_ERROR_ADDRESS_IN_USE if the server program is stopped and then
1862  * immediately restarted.)
1863  *
1864  * If @socket is a UDP socket, then @allow_reuse determines whether or
1865  * not other UDP sockets can be bound to the same address at the same
1866  * time. In particular, you can have several UDP sockets bound to the
1867  * same address, and they will all receive all of the multicast and
1868  * broadcast packets sent to that address. (The behavior of unicast
1869  * UDP packets to an address with multiple listeners is not defined.)
1870  *
1871  * Returns: %TRUE on success, %FALSE on error.
1872  *
1873  * Since: 2.22
1874  */
1875 gboolean
1876 g_socket_bind (GSocket         *socket,
1877                GSocketAddress  *address,
1878                gboolean         reuse_address,
1879                GError         **error)
1880 {
1881   struct sockaddr_storage addr;
1882   gboolean so_reuseaddr;
1883 #ifdef SO_REUSEPORT
1884   gboolean so_reuseport;
1885 #endif
1886
1887   g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
1888
1889   if (!check_socket (socket, error))
1890     return FALSE;
1891
1892   if (!g_socket_address_to_native (address, &addr, sizeof addr, error))
1893     return FALSE;
1894
1895   /* On Windows, SO_REUSEADDR has the semantics we want for UDP
1896    * sockets, but has nasty side effects we don't want for TCP
1897    * sockets.
1898    *
1899    * On other platforms, we set SO_REUSEPORT, if it exists, for
1900    * UDP sockets, and SO_REUSEADDR for all sockets, hoping that
1901    * if SO_REUSEPORT doesn't exist, then SO_REUSEADDR will have
1902    * the desired semantics on UDP (as it does on Linux, although
1903    * Linux has SO_REUSEPORT too as of 3.9).
1904    */
1905
1906 #ifdef G_OS_WIN32
1907   so_reuseaddr = reuse_address && (socket->priv->type == G_SOCKET_TYPE_DATAGRAM);
1908 #else
1909   so_reuseaddr = !!reuse_address;
1910 #endif
1911
1912 #ifdef SO_REUSEPORT
1913   so_reuseport = reuse_address && (socket->priv->type == G_SOCKET_TYPE_DATAGRAM);
1914 #endif
1915
1916   /* Ignore errors here, the only likely error is "not supported", and
1917    * this is a "best effort" thing mainly.
1918    */
1919   g_socket_set_option (socket, SOL_SOCKET, SO_REUSEADDR, so_reuseaddr, NULL);
1920 #ifdef SO_REUSEPORT
1921   g_socket_set_option (socket, SOL_SOCKET, SO_REUSEPORT, so_reuseport, NULL);
1922 #endif
1923
1924   if (bind (socket->priv->fd, (struct sockaddr *) &addr,
1925             g_socket_address_get_native_size (address)) < 0)
1926     {
1927       int errsv = get_socket_errno ();
1928       g_set_error (error,
1929                    G_IO_ERROR, socket_io_error_from_errno (errsv),
1930                    _("Error binding to address: %s"), socket_strerror (errsv));
1931       return FALSE;
1932     }
1933
1934   return TRUE;
1935 }
1936
1937 #if !defined(HAVE_IF_NAMETOINDEX) && defined(G_OS_WIN32)
1938 static guint
1939 if_nametoindex (const gchar *iface)
1940 {
1941   PIP_ADAPTER_ADDRESSES addresses = NULL, p;
1942   gulong addresses_len = 0;
1943   guint idx = 0;
1944   DWORD res;
1945
1946   if (ws2funcs.pIfNameToIndex != NULL)
1947     return ws2funcs.pIfNameToIndex (iface);
1948
1949   res = GetAdaptersAddresses (AF_UNSPEC, 0, NULL, NULL, &addresses_len);
1950   if (res != NO_ERROR && res != ERROR_BUFFER_OVERFLOW)
1951     {
1952       if (res == ERROR_NO_DATA)
1953         errno = ENXIO;
1954       else
1955         errno = EINVAL;
1956       return 0;
1957     }
1958
1959   addresses = g_malloc (addresses_len);
1960   res = GetAdaptersAddresses (AF_UNSPEC, 0, NULL, addresses, &addresses_len);
1961
1962   if (res != NO_ERROR)
1963     {
1964       g_free (addresses);
1965       if (res == ERROR_NO_DATA)
1966         errno = ENXIO;
1967       else
1968         errno = EINVAL;
1969       return 0;
1970     }
1971
1972   p = addresses;
1973   while (p)
1974     {
1975       if (strcmp (p->AdapterName, iface) == 0)
1976         {
1977           idx = p->IfIndex;
1978           break;
1979         }
1980       p = p->Next;
1981     }
1982
1983   if (p == NULL)
1984     errno = ENXIO;
1985
1986   g_free (addresses);
1987
1988   return idx;
1989 }
1990
1991 #define HAVE_IF_NAMETOINDEX 1
1992 #endif
1993
1994 static gboolean
1995 g_socket_multicast_group_operation (GSocket       *socket,
1996                                     GInetAddress  *group,
1997                                     gboolean       source_specific,
1998                                     const gchar   *iface,
1999                                     gboolean       join_group,
2000                                     GError       **error)
2001 {
2002   const guint8 *native_addr;
2003   gint optname, result;
2004
2005   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
2006   g_return_val_if_fail (socket->priv->type == G_SOCKET_TYPE_DATAGRAM, FALSE);
2007   g_return_val_if_fail (G_IS_INET_ADDRESS (group), FALSE);
2008
2009   if (!check_socket (socket, error))
2010     return FALSE;
2011
2012   native_addr = g_inet_address_to_bytes (group);
2013   if (g_inet_address_get_family (group) == G_SOCKET_FAMILY_IPV4)
2014     {
2015 #ifdef HAVE_IP_MREQN
2016       struct ip_mreqn mc_req;
2017 #else
2018       struct ip_mreq mc_req;
2019 #endif
2020
2021       memset (&mc_req, 0, sizeof (mc_req));
2022       memcpy (&mc_req.imr_multiaddr, native_addr, sizeof (struct in_addr));
2023
2024 #ifdef HAVE_IP_MREQN
2025       if (iface)
2026         mc_req.imr_ifindex = if_nametoindex (iface);
2027       else
2028         mc_req.imr_ifindex = 0;  /* Pick any.  */
2029 #elif defined(G_OS_WIN32)
2030       if (iface)
2031         mc_req.imr_interface.s_addr = g_htonl (if_nametoindex (iface));
2032       else
2033         mc_req.imr_interface.s_addr = g_htonl (INADDR_ANY);
2034 #else
2035       mc_req.imr_interface.s_addr = g_htonl (INADDR_ANY);
2036 #endif
2037
2038       if (source_specific)
2039         {
2040 #ifdef IP_ADD_SOURCE_MEMBERSHIP
2041           optname = join_group ? IP_ADD_SOURCE_MEMBERSHIP : IP_DROP_SOURCE_MEMBERSHIP;
2042 #else
2043           g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2044                        join_group ?
2045                        _("Error joining multicast group: %s") :
2046                        _("Error leaving multicast group: %s"),
2047                        _("No support for source-specific multicast"));
2048           return FALSE;
2049 #endif
2050         }
2051       else
2052         optname = join_group ? IP_ADD_MEMBERSHIP : IP_DROP_MEMBERSHIP;
2053       result = setsockopt (socket->priv->fd, IPPROTO_IP, optname,
2054                            &mc_req, sizeof (mc_req));
2055     }
2056   else if (g_inet_address_get_family (group) == G_SOCKET_FAMILY_IPV6)
2057     {
2058       struct ipv6_mreq mc_req_ipv6;
2059
2060       memset (&mc_req_ipv6, 0, sizeof (mc_req_ipv6));
2061       memcpy (&mc_req_ipv6.ipv6mr_multiaddr, native_addr, sizeof (struct in6_addr));
2062 #ifdef HAVE_IF_NAMETOINDEX
2063       if (iface)
2064         mc_req_ipv6.ipv6mr_interface = if_nametoindex (iface);
2065       else
2066 #endif
2067         mc_req_ipv6.ipv6mr_interface = 0;
2068
2069       optname = join_group ? IPV6_JOIN_GROUP : IPV6_LEAVE_GROUP;
2070       result = setsockopt (socket->priv->fd, IPPROTO_IPV6, optname,
2071                            &mc_req_ipv6, sizeof (mc_req_ipv6));
2072     }
2073   else
2074     g_return_val_if_reached (FALSE);
2075
2076   if (result < 0)
2077     {
2078       int errsv = get_socket_errno ();
2079
2080       g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
2081                    join_group ?
2082                    _("Error joining multicast group: %s") :
2083                    _("Error leaving multicast group: %s"),
2084                    socket_strerror (errsv));
2085       return FALSE;
2086     }
2087
2088   return TRUE;
2089 }
2090
2091 /**
2092  * g_socket_join_multicast_group:
2093  * @socket: a #GSocket.
2094  * @group: a #GInetAddress specifying the group address to join.
2095  * @iface: (allow-none): Name of the interface to use, or %NULL
2096  * @source_specific: %TRUE if source-specific multicast should be used
2097  * @error: #GError for error reporting, or %NULL to ignore.
2098  *
2099  * Registers @socket to receive multicast messages sent to @group.
2100  * @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have
2101  * been bound to an appropriate interface and port with
2102  * g_socket_bind().
2103  *
2104  * If @iface is %NULL, the system will automatically pick an interface
2105  * to bind to based on @group.
2106  *
2107  * If @source_specific is %TRUE, source-specific multicast as defined
2108  * in RFC 4604 is used. Note that on older platforms this may fail
2109  * with a %G_IO_ERROR_NOT_SUPPORTED error.
2110  *
2111  * Returns: %TRUE on success, %FALSE on error.
2112  *
2113  * Since: 2.32
2114  */
2115 gboolean
2116 g_socket_join_multicast_group (GSocket       *socket,
2117                                GInetAddress  *group,
2118                                gboolean       source_specific,
2119                                const gchar   *iface,
2120                                GError       **error)
2121 {
2122   return g_socket_multicast_group_operation (socket, group, source_specific, iface, TRUE, error);
2123 }
2124
2125 /**
2126  * g_socket_leave_multicast_group:
2127  * @socket: a #GSocket.
2128  * @group: a #GInetAddress specifying the group address to leave.
2129  * @iface: (allow-none): Interface used
2130  * @source_specific: %TRUE if source-specific multicast was used
2131  * @error: #GError for error reporting, or %NULL to ignore.
2132  *
2133  * Removes @socket from the multicast group defined by @group, @iface,
2134  * and @source_specific (which must all have the same values they had
2135  * when you joined the group).
2136  *
2137  * @socket remains bound to its address and port, and can still receive
2138  * unicast messages after calling this.
2139  *
2140  * Returns: %TRUE on success, %FALSE on error.
2141  *
2142  * Since: 2.32
2143  */
2144 gboolean
2145 g_socket_leave_multicast_group (GSocket       *socket,
2146                                 GInetAddress  *group,
2147                                 gboolean       source_specific,
2148                                 const gchar   *iface,
2149                                 GError       **error)
2150 {
2151   return g_socket_multicast_group_operation (socket, group, source_specific, iface, FALSE, error);
2152 }
2153
2154 /**
2155  * g_socket_speaks_ipv4:
2156  * @socket: a #GSocket
2157  *
2158  * Checks if a socket is capable of speaking IPv4.
2159  *
2160  * IPv4 sockets are capable of speaking IPv4.  On some operating systems
2161  * and under some combinations of circumstances IPv6 sockets are also
2162  * capable of speaking IPv4.  See RFC 3493 section 3.7 for more
2163  * information.
2164  *
2165  * No other types of sockets are currently considered as being capable
2166  * of speaking IPv4.
2167  *
2168  * Returns: %TRUE if this socket can be used with IPv4.
2169  *
2170  * Since: 2.22
2171  **/
2172 gboolean
2173 g_socket_speaks_ipv4 (GSocket *socket)
2174 {
2175   switch (socket->priv->family)
2176     {
2177     case G_SOCKET_FAMILY_IPV4:
2178       return TRUE;
2179
2180     case G_SOCKET_FAMILY_IPV6:
2181 #if defined (IPPROTO_IPV6) && defined (IPV6_V6ONLY)
2182       {
2183         gint v6_only;
2184
2185         if (!g_socket_get_option (socket,
2186                                   IPPROTO_IPV6, IPV6_V6ONLY,
2187                                   &v6_only, NULL))
2188           return FALSE;
2189
2190         return !v6_only;
2191       }
2192 #else
2193       return FALSE;
2194 #endif
2195
2196     default:
2197       return FALSE;
2198     }
2199 }
2200
2201 /**
2202  * g_socket_accept:
2203  * @socket: a #GSocket.
2204  * @cancellable: (allow-none): a %GCancellable or %NULL
2205  * @error: #GError for error reporting, or %NULL to ignore.
2206  *
2207  * Accept incoming connections on a connection-based socket. This removes
2208  * the first outstanding connection request from the listening socket and
2209  * creates a #GSocket object for it.
2210  *
2211  * The @socket must be bound to a local address with g_socket_bind() and
2212  * must be listening for incoming connections (g_socket_listen()).
2213  *
2214  * If there are no outstanding connections then the operation will block
2215  * or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled.
2216  * To be notified of an incoming connection, wait for the %G_IO_IN condition.
2217  *
2218  * Returns: (transfer full): a new #GSocket, or %NULL on error.
2219  *     Free the returned object with g_object_unref().
2220  *
2221  * Since: 2.22
2222  */
2223 GSocket *
2224 g_socket_accept (GSocket       *socket,
2225                  GCancellable  *cancellable,
2226                  GError       **error)
2227 {
2228   GSocket *new_socket;
2229   gint ret;
2230
2231   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
2232
2233   if (!check_socket (socket, error))
2234     return NULL;
2235
2236   if (!check_timeout (socket, error))
2237     return NULL;
2238
2239   while (TRUE)
2240     {
2241       if ((ret = accept (socket->priv->fd, NULL, 0)) < 0)
2242         {
2243           int errsv = get_socket_errno ();
2244
2245           if (errsv == EINTR)
2246             continue;
2247
2248 #ifdef WSAEWOULDBLOCK
2249           if (errsv == WSAEWOULDBLOCK)
2250 #else
2251           if (errsv == EWOULDBLOCK ||
2252               errsv == EAGAIN)
2253 #endif
2254             {
2255               win32_unset_event_mask (socket, FD_ACCEPT);
2256
2257               if (socket->priv->blocking)
2258                 {
2259                   if (!g_socket_condition_wait (socket,
2260                                                 G_IO_IN, cancellable, error))
2261                     return NULL;
2262
2263                   continue;
2264                 }
2265             }
2266
2267           g_set_error (error, G_IO_ERROR,
2268                        socket_io_error_from_errno (errsv),
2269                        _("Error accepting connection: %s"), socket_strerror (errsv));
2270           return NULL;
2271         }
2272       break;
2273     }
2274
2275   win32_unset_event_mask (socket, FD_ACCEPT);
2276
2277 #ifdef G_OS_WIN32
2278   {
2279     /* The socket inherits the accepting sockets event mask and even object,
2280        we need to remove that */
2281     WSAEventSelect (ret, NULL, 0);
2282   }
2283 #else
2284   {
2285     int flags;
2286
2287     /* We always want to set close-on-exec to protect users. If you
2288        need to so some weird inheritance to exec you can re-enable this
2289        using lower level hacks with g_socket_get_fd(). */
2290     flags = fcntl (ret, F_GETFD, 0);
2291     if (flags != -1 &&
2292         (flags & FD_CLOEXEC) == 0)
2293       {
2294         flags |= FD_CLOEXEC;
2295         fcntl (ret, F_SETFD, flags);
2296       }
2297   }
2298 #endif
2299
2300   new_socket = g_socket_new_from_fd (ret, error);
2301   if (new_socket == NULL)
2302     {
2303 #ifdef G_OS_WIN32
2304       closesocket (ret);
2305 #else
2306       close (ret);
2307 #endif
2308     }
2309   else
2310     new_socket->priv->protocol = socket->priv->protocol;
2311
2312   return new_socket;
2313 }
2314
2315 /**
2316  * g_socket_connect:
2317  * @socket: a #GSocket.
2318  * @address: a #GSocketAddress specifying the remote address.
2319  * @cancellable: (allow-none): a %GCancellable or %NULL
2320  * @error: #GError for error reporting, or %NULL to ignore.
2321  *
2322  * Connect the socket to the specified remote address.
2323  *
2324  * For connection oriented socket this generally means we attempt to make
2325  * a connection to the @address. For a connection-less socket it sets
2326  * the default address for g_socket_send() and discards all incoming datagrams
2327  * from other sources.
2328  *
2329  * Generally connection oriented sockets can only connect once, but
2330  * connection-less sockets can connect multiple times to change the
2331  * default address.
2332  *
2333  * If the connect call needs to do network I/O it will block, unless
2334  * non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned
2335  * and the user can be notified of the connection finishing by waiting
2336  * for the G_IO_OUT condition. The result of the connection must then be
2337  * checked with g_socket_check_connect_result().
2338  *
2339  * Returns: %TRUE if connected, %FALSE on error.
2340  *
2341  * Since: 2.22
2342  */
2343 gboolean
2344 g_socket_connect (GSocket         *socket,
2345                   GSocketAddress  *address,
2346                   GCancellable    *cancellable,
2347                   GError         **error)
2348 {
2349   struct sockaddr_storage buffer;
2350
2351   g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
2352
2353   if (!check_socket (socket, error))
2354     return FALSE;
2355
2356   if (!g_socket_address_to_native (address, &buffer, sizeof buffer, error))
2357     return FALSE;
2358
2359   if (socket->priv->remote_address)
2360     g_object_unref (socket->priv->remote_address);
2361   socket->priv->remote_address = g_object_ref (address);
2362
2363   while (1)
2364     {
2365       if (connect (socket->priv->fd, (struct sockaddr *) &buffer,
2366                    g_socket_address_get_native_size (address)) < 0)
2367         {
2368           int errsv = get_socket_errno ();
2369
2370           if (errsv == EINTR)
2371             continue;
2372
2373 #ifndef G_OS_WIN32
2374           if (errsv == EINPROGRESS)
2375 #else
2376           if (errsv == WSAEWOULDBLOCK)
2377 #endif
2378             {
2379               win32_unset_event_mask (socket, FD_CONNECT);
2380
2381               if (socket->priv->blocking)
2382                 {
2383                   if (g_socket_condition_wait (socket, G_IO_OUT, cancellable, error))
2384                     {
2385                       if (g_socket_check_connect_result (socket, error))
2386                         break;
2387                     }
2388                 }
2389               else
2390                 {
2391                   g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
2392                                        _("Connection in progress"));
2393                   socket->priv->connect_pending = TRUE;
2394                 }
2395             }
2396           else
2397             g_set_error_literal (error, G_IO_ERROR,
2398                                  socket_io_error_from_errno (errsv),
2399                                  socket_strerror (errsv));
2400
2401           return FALSE;
2402         }
2403       break;
2404     }
2405
2406   win32_unset_event_mask (socket, FD_CONNECT);
2407
2408   socket->priv->connected = TRUE;
2409
2410   return TRUE;
2411 }
2412
2413 /**
2414  * g_socket_check_connect_result:
2415  * @socket: a #GSocket
2416  * @error: #GError for error reporting, or %NULL to ignore.
2417  *
2418  * Checks and resets the pending connect error for the socket.
2419  * This is used to check for errors when g_socket_connect() is
2420  * used in non-blocking mode.
2421  *
2422  * Returns: %TRUE if no error, %FALSE otherwise, setting @error to the error
2423  *
2424  * Since: 2.22
2425  */
2426 gboolean
2427 g_socket_check_connect_result (GSocket  *socket,
2428                                GError  **error)
2429 {
2430   int value;
2431
2432   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
2433
2434   if (!check_socket (socket, error))
2435     return FALSE;
2436
2437   if (!check_timeout (socket, error))
2438     return FALSE;
2439
2440   if (!g_socket_get_option (socket, SOL_SOCKET, SO_ERROR, &value, error))
2441     {
2442       g_prefix_error (error, _("Unable to get pending error: "));
2443       return FALSE;
2444     }
2445
2446   if (value != 0)
2447     {
2448       g_set_error_literal (error, G_IO_ERROR, socket_io_error_from_errno (value),
2449                            socket_strerror (value));
2450       if (socket->priv->remote_address)
2451         {
2452           g_object_unref (socket->priv->remote_address);
2453           socket->priv->remote_address = NULL;
2454         }
2455       return FALSE;
2456     }
2457
2458   socket->priv->connected = TRUE;
2459   return TRUE;
2460 }
2461
2462 /**
2463  * g_socket_get_available_bytes:
2464  * @socket: a #GSocket
2465  *
2466  * Get the amount of data pending in the OS input buffer.
2467  *
2468  * If @socket is a UDP or SCTP socket, this will return the size of
2469  * just the next packet, even if additional packets are buffered after
2470  * that one.
2471  *
2472  * Note that on Windows, this function is rather inefficient in the
2473  * UDP case, and so if you know any plausible upper bound on the size
2474  * of the incoming packet, it is better to just do a
2475  * g_socket_receive() with a buffer of that size, rather than calling
2476  * g_socket_get_available_bytes() first and then doing a receive of
2477  * exactly the right size.
2478  *
2479  * Returns: the number of bytes that can be read from the socket
2480  * without blocking or truncating, or -1 on error.
2481  *
2482  * Since: 2.32
2483  */
2484 gssize
2485 g_socket_get_available_bytes (GSocket *socket)
2486 {
2487 #ifdef G_OS_WIN32
2488   const gint bufsize = 64 * 1024;
2489   static guchar *buf = NULL;
2490   u_long avail;
2491 #else
2492   gint avail;
2493 #endif
2494
2495   g_return_val_if_fail (G_IS_SOCKET (socket), -1);
2496
2497 #if defined (SO_NREAD)
2498   if (!g_socket_get_option (socket, SOL_SOCKET, SO_NREAD, &avail, NULL))
2499       return -1;
2500 #elif !defined (G_OS_WIN32)
2501   if (ioctl (socket->priv->fd, FIONREAD, &avail) < 0)
2502     avail = -1;
2503 #else
2504   if (socket->priv->type == G_SOCKET_TYPE_DATAGRAM)
2505     {
2506       if (G_UNLIKELY (g_once_init_enter (&buf)))
2507         g_once_init_leave (&buf, g_malloc (bufsize));
2508
2509       avail = recv (socket->priv->fd, buf, bufsize, MSG_PEEK);
2510       if (avail == -1 && get_socket_errno () == WSAEWOULDBLOCK)
2511         avail = 0;
2512     }
2513   else
2514     {
2515       if (ioctlsocket (socket->priv->fd, FIONREAD, &avail) < 0)
2516         avail = -1;
2517     }
2518 #endif
2519
2520   return avail;
2521 }
2522
2523 /**
2524  * g_socket_receive:
2525  * @socket: a #GSocket
2526  * @buffer: (array length=size) (element-type guint8): a buffer to
2527  *     read data into (which should be at least @size bytes long).
2528  * @size: the number of bytes you want to read from the socket
2529  * @cancellable: (allow-none): a %GCancellable or %NULL
2530  * @error: #GError for error reporting, or %NULL to ignore.
2531  *
2532  * Receive data (up to @size bytes) from a socket. This is mainly used by
2533  * connection-oriented sockets; it is identical to g_socket_receive_from()
2534  * with @address set to %NULL.
2535  *
2536  * For %G_SOCKET_TYPE_DATAGRAM and %G_SOCKET_TYPE_SEQPACKET sockets,
2537  * g_socket_receive() will always read either 0 or 1 complete messages from
2538  * the socket. If the received message is too large to fit in @buffer, then
2539  * the data beyond @size bytes will be discarded, without any explicit
2540  * indication that this has occurred.
2541  *
2542  * For %G_SOCKET_TYPE_STREAM sockets, g_socket_receive() can return any
2543  * number of bytes, up to @size. If more than @size bytes have been
2544  * received, the additional data will be returned in future calls to
2545  * g_socket_receive().
2546  *
2547  * If the socket is in blocking mode the call will block until there
2548  * is some data to receive, the connection is closed, or there is an
2549  * error. If there is no data available and the socket is in
2550  * non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error will be
2551  * returned. To be notified when data is available, wait for the
2552  * %G_IO_IN condition.
2553  *
2554  * On error -1 is returned and @error is set accordingly.
2555  *
2556  * Returns: Number of bytes read, or 0 if the connection was closed by
2557  * the peer, or -1 on error
2558  *
2559  * Since: 2.22
2560  */
2561 gssize
2562 g_socket_receive (GSocket       *socket,
2563                   gchar         *buffer,
2564                   gsize          size,
2565                   GCancellable  *cancellable,
2566                   GError       **error)
2567 {
2568   return g_socket_receive_with_blocking (socket, buffer, size,
2569                                          socket->priv->blocking,
2570                                          cancellable, error);
2571 }
2572
2573 /**
2574  * g_socket_receive_with_blocking:
2575  * @socket: a #GSocket
2576  * @buffer: (array length=size) (element-type guint8): a buffer to
2577  *     read data into (which should be at least @size bytes long).
2578  * @size: the number of bytes you want to read from the socket
2579  * @blocking: whether to do blocking or non-blocking I/O
2580  * @cancellable: (allow-none): a %GCancellable or %NULL
2581  * @error: #GError for error reporting, or %NULL to ignore.
2582  *
2583  * This behaves exactly the same as g_socket_receive(), except that
2584  * the choice of blocking or non-blocking behavior is determined by
2585  * the @blocking argument rather than by @socket's properties.
2586  *
2587  * Returns: Number of bytes read, or 0 if the connection was closed by
2588  * the peer, or -1 on error
2589  *
2590  * Since: 2.26
2591  */
2592 gssize
2593 g_socket_receive_with_blocking (GSocket       *socket,
2594                                 gchar         *buffer,
2595                                 gsize          size,
2596                                 gboolean       blocking,
2597                                 GCancellable  *cancellable,
2598                                 GError       **error)
2599 {
2600   gssize ret;
2601
2602   g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, -1);
2603
2604   if (!check_socket (socket, error))
2605     return -1;
2606
2607   if (!check_timeout (socket, error))
2608     return -1;
2609
2610   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2611     return -1;
2612
2613   while (1)
2614     {
2615       if ((ret = recv (socket->priv->fd, buffer, size, 0)) < 0)
2616         {
2617           int errsv = get_socket_errno ();
2618
2619           if (errsv == EINTR)
2620             continue;
2621
2622 #ifdef WSAEWOULDBLOCK
2623           if (errsv == WSAEWOULDBLOCK)
2624 #else
2625           if (errsv == EWOULDBLOCK ||
2626               errsv == EAGAIN)
2627 #endif
2628             {
2629               win32_unset_event_mask (socket, FD_READ);
2630
2631               if (blocking)
2632                 {
2633                   if (!g_socket_condition_wait (socket,
2634                                                 G_IO_IN, cancellable, error))
2635                     return -1;
2636
2637                   continue;
2638                 }
2639             }
2640
2641           win32_unset_event_mask (socket, FD_READ);
2642
2643           g_set_error (error, G_IO_ERROR,
2644                        socket_io_error_from_errno (errsv),
2645                        _("Error receiving data: %s"), socket_strerror (errsv));
2646           return -1;
2647         }
2648
2649       win32_unset_event_mask (socket, FD_READ);
2650
2651       break;
2652     }
2653
2654   return ret;
2655 }
2656
2657 /**
2658  * g_socket_receive_from:
2659  * @socket: a #GSocket
2660  * @address: (out) (allow-none): a pointer to a #GSocketAddress
2661  *     pointer, or %NULL
2662  * @buffer: (array length=size) (element-type guint8): a buffer to
2663  *     read data into (which should be at least @size bytes long).
2664  * @size: the number of bytes you want to read from the socket
2665  * @cancellable: (allow-none): a %GCancellable or %NULL
2666  * @error: #GError for error reporting, or %NULL to ignore.
2667  *
2668  * Receive data (up to @size bytes) from a socket.
2669  *
2670  * If @address is non-%NULL then @address will be set equal to the
2671  * source address of the received packet.
2672  * @address is owned by the caller.
2673  *
2674  * See g_socket_receive() for additional information.
2675  *
2676  * Returns: Number of bytes read, or 0 if the connection was closed by
2677  * the peer, or -1 on error
2678  *
2679  * Since: 2.22
2680  */
2681 gssize
2682 g_socket_receive_from (GSocket         *socket,
2683                        GSocketAddress **address,
2684                        gchar           *buffer,
2685                        gsize            size,
2686                        GCancellable    *cancellable,
2687                        GError         **error)
2688 {
2689   GInputVector v;
2690
2691   v.buffer = buffer;
2692   v.size = size;
2693
2694   return g_socket_receive_message (socket,
2695                                    address,
2696                                    &v, 1,
2697                                    NULL, 0, NULL,
2698                                    cancellable,
2699                                    error);
2700 }
2701
2702 /* See the comment about SIGPIPE above. */
2703 #ifdef MSG_NOSIGNAL
2704 #define G_SOCKET_DEFAULT_SEND_FLAGS MSG_NOSIGNAL
2705 #else
2706 #define G_SOCKET_DEFAULT_SEND_FLAGS 0
2707 #endif
2708
2709 /**
2710  * g_socket_send:
2711  * @socket: a #GSocket
2712  * @buffer: (array length=size) (element-type guint8): the buffer
2713  *     containing the data to send.
2714  * @size: the number of bytes to send
2715  * @cancellable: (allow-none): a %GCancellable or %NULL
2716  * @error: #GError for error reporting, or %NULL to ignore.
2717  *
2718  * Tries to send @size bytes from @buffer on the socket. This is
2719  * mainly used by connection-oriented sockets; it is identical to
2720  * g_socket_send_to() with @address set to %NULL.
2721  *
2722  * If the socket is in blocking mode the call will block until there is
2723  * space for the data in the socket queue. If there is no space available
2724  * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
2725  * will be returned. To be notified when space is available, wait for the
2726  * %G_IO_OUT condition. Note though that you may still receive
2727  * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
2728  * notified of a %G_IO_OUT condition. (On Windows in particular, this is
2729  * very common due to the way the underlying APIs work.)
2730  *
2731  * On error -1 is returned and @error is set accordingly.
2732  *
2733  * Returns: Number of bytes written (which may be less than @size), or -1
2734  * on error
2735  *
2736  * Since: 2.22
2737  */
2738 gssize
2739 g_socket_send (GSocket       *socket,
2740                const gchar   *buffer,
2741                gsize          size,
2742                GCancellable  *cancellable,
2743                GError       **error)
2744 {
2745   return g_socket_send_with_blocking (socket, buffer, size,
2746                                       socket->priv->blocking,
2747                                       cancellable, error);
2748 }
2749
2750 /**
2751  * g_socket_send_with_blocking:
2752  * @socket: a #GSocket
2753  * @buffer: (array length=size) (element-type guint8): the buffer
2754  *     containing the data to send.
2755  * @size: the number of bytes to send
2756  * @blocking: whether to do blocking or non-blocking I/O
2757  * @cancellable: (allow-none): a %GCancellable or %NULL
2758  * @error: #GError for error reporting, or %NULL to ignore.
2759  *
2760  * This behaves exactly the same as g_socket_send(), except that
2761  * the choice of blocking or non-blocking behavior is determined by
2762  * the @blocking argument rather than by @socket's properties.
2763  *
2764  * Returns: Number of bytes written (which may be less than @size), or -1
2765  * on error
2766  *
2767  * Since: 2.26
2768  */
2769 gssize
2770 g_socket_send_with_blocking (GSocket       *socket,
2771                              const gchar   *buffer,
2772                              gsize          size,
2773                              gboolean       blocking,
2774                              GCancellable  *cancellable,
2775                              GError       **error)
2776 {
2777   gssize ret;
2778
2779   g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, -1);
2780
2781   if (!check_socket (socket, error))
2782     return -1;
2783
2784   if (!check_timeout (socket, error))
2785     return -1;
2786
2787   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2788     return -1;
2789
2790   while (1)
2791     {
2792       if ((ret = send (socket->priv->fd, buffer, size, G_SOCKET_DEFAULT_SEND_FLAGS)) < 0)
2793         {
2794           int errsv = get_socket_errno ();
2795
2796           if (errsv == EINTR)
2797             continue;
2798
2799 #ifdef WSAEWOULDBLOCK
2800           if (errsv == WSAEWOULDBLOCK)
2801 #else
2802           if (errsv == EWOULDBLOCK ||
2803               errsv == EAGAIN)
2804 #endif
2805             {
2806               win32_unset_event_mask (socket, FD_WRITE);
2807
2808               if (blocking)
2809                 {
2810                   if (!g_socket_condition_wait (socket,
2811                                                 G_IO_OUT, cancellable, error))
2812                     return -1;
2813
2814                   continue;
2815                 }
2816             }
2817
2818           g_set_error (error, G_IO_ERROR,
2819                        socket_io_error_from_errno (errsv),
2820                        _("Error sending data: %s"), socket_strerror (errsv));
2821           return -1;
2822         }
2823       break;
2824     }
2825
2826   return ret;
2827 }
2828
2829 /**
2830  * g_socket_send_to:
2831  * @socket: a #GSocket
2832  * @address: (allow-none): a #GSocketAddress, or %NULL
2833  * @buffer: (array length=size) (element-type guint8): the buffer
2834  *     containing the data to send.
2835  * @size: the number of bytes to send
2836  * @cancellable: (allow-none): a %GCancellable or %NULL
2837  * @error: #GError for error reporting, or %NULL to ignore.
2838  *
2839  * Tries to send @size bytes from @buffer to @address. If @address is
2840  * %NULL then the message is sent to the default receiver (set by
2841  * g_socket_connect()).
2842  *
2843  * See g_socket_send() for additional information.
2844  *
2845  * Returns: Number of bytes written (which may be less than @size), or -1
2846  * on error
2847  *
2848  * Since: 2.22
2849  */
2850 gssize
2851 g_socket_send_to (GSocket         *socket,
2852                   GSocketAddress  *address,
2853                   const gchar     *buffer,
2854                   gsize            size,
2855                   GCancellable    *cancellable,
2856                   GError         **error)
2857 {
2858   GOutputVector v;
2859
2860   v.buffer = buffer;
2861   v.size = size;
2862
2863   return g_socket_send_message (socket,
2864                                 address,
2865                                 &v, 1,
2866                                 NULL, 0,
2867                                 0,
2868                                 cancellable,
2869                                 error);
2870 }
2871
2872 /**
2873  * g_socket_shutdown:
2874  * @socket: a #GSocket
2875  * @shutdown_read: whether to shut down the read side
2876  * @shutdown_write: whether to shut down the write side
2877  * @error: #GError for error reporting, or %NULL to ignore.
2878  *
2879  * Shut down part of a full-duplex connection.
2880  *
2881  * If @shutdown_read is %TRUE then the receiving side of the connection
2882  * is shut down, and further reading is disallowed.
2883  *
2884  * If @shutdown_write is %TRUE then the sending side of the connection
2885  * is shut down, and further writing is disallowed.
2886  *
2887  * It is allowed for both @shutdown_read and @shutdown_write to be %TRUE.
2888  *
2889  * One example where this is used is graceful disconnect for TCP connections
2890  * where you close the sending side, then wait for the other side to close
2891  * the connection, thus ensuring that the other side saw all sent data.
2892  *
2893  * Returns: %TRUE on success, %FALSE on error
2894  *
2895  * Since: 2.22
2896  */
2897 gboolean
2898 g_socket_shutdown (GSocket   *socket,
2899                    gboolean   shutdown_read,
2900                    gboolean   shutdown_write,
2901                    GError   **error)
2902 {
2903   int how;
2904
2905   g_return_val_if_fail (G_IS_SOCKET (socket), TRUE);
2906
2907   if (!check_socket (socket, error))
2908     return FALSE;
2909
2910   /* Do nothing? */
2911   if (!shutdown_read && !shutdown_write)
2912     return TRUE;
2913
2914 #ifndef G_OS_WIN32
2915   if (shutdown_read && shutdown_write)
2916     how = SHUT_RDWR;
2917   else if (shutdown_read)
2918     how = SHUT_RD;
2919   else
2920     how = SHUT_WR;
2921 #else
2922   if (shutdown_read && shutdown_write)
2923     how = SD_BOTH;
2924   else if (shutdown_read)
2925     how = SD_RECEIVE;
2926   else
2927     how = SD_SEND;
2928 #endif
2929
2930   if (shutdown (socket->priv->fd, how) != 0)
2931     {
2932       int errsv = get_socket_errno ();
2933       g_set_error (error, G_IO_ERROR, socket_io_error_from_errno (errsv),
2934                    _("Unable to shutdown socket: %s"), socket_strerror (errsv));
2935       return FALSE;
2936     }
2937
2938   if (shutdown_read && shutdown_write)
2939     socket->priv->connected = FALSE;
2940
2941   return TRUE;
2942 }
2943
2944 /**
2945  * g_socket_close:
2946  * @socket: a #GSocket
2947  * @error: #GError for error reporting, or %NULL to ignore.
2948  *
2949  * Closes the socket, shutting down any active connection.
2950  *
2951  * Closing a socket does not wait for all outstanding I/O operations
2952  * to finish, so the caller should not rely on them to be guaranteed
2953  * to complete even if the close returns with no error.
2954  *
2955  * Once the socket is closed, all other operations will return
2956  * %G_IO_ERROR_CLOSED. Closing a socket multiple times will not
2957  * return an error.
2958  *
2959  * Sockets will be automatically closed when the last reference
2960  * is dropped, but you might want to call this function to make sure
2961  * resources are released as early as possible.
2962  *
2963  * Beware that due to the way that TCP works, it is possible for
2964  * recently-sent data to be lost if either you close a socket while the
2965  * %G_IO_IN condition is set, or else if the remote connection tries to
2966  * send something to you after you close the socket but before it has
2967  * finished reading all of the data you sent. There is no easy generic
2968  * way to avoid this problem; the easiest fix is to design the network
2969  * protocol such that the client will never send data "out of turn".
2970  * Another solution is for the server to half-close the connection by
2971  * calling g_socket_shutdown() with only the @shutdown_write flag set,
2972  * and then wait for the client to notice this and close its side of the
2973  * connection, after which the server can safely call g_socket_close().
2974  * (This is what #GTcpConnection does if you call
2975  * g_tcp_connection_set_graceful_disconnect(). But of course, this
2976  * only works if the client will close its connection after the server
2977  * does.)
2978  *
2979  * Returns: %TRUE on success, %FALSE on error
2980  *
2981  * Since: 2.22
2982  */
2983 gboolean
2984 g_socket_close (GSocket  *socket,
2985                 GError  **error)
2986 {
2987   int res;
2988
2989   g_return_val_if_fail (G_IS_SOCKET (socket), TRUE);
2990
2991   if (socket->priv->closed)
2992     return TRUE; /* Multiple close not an error */
2993
2994   if (!check_socket (socket, error))
2995     return FALSE;
2996
2997   while (1)
2998     {
2999 #ifdef G_OS_WIN32
3000       res = closesocket (socket->priv->fd);
3001 #else
3002       res = close (socket->priv->fd);
3003 #endif
3004       if (res == -1)
3005         {
3006           int errsv = get_socket_errno ();
3007
3008           if (errsv == EINTR)
3009             continue;
3010
3011           g_set_error (error, G_IO_ERROR,
3012                        socket_io_error_from_errno (errsv),
3013                        _("Error closing socket: %s"),
3014                        socket_strerror (errsv));
3015           return FALSE;
3016         }
3017       break;
3018     }
3019
3020   socket->priv->connected = FALSE;
3021   socket->priv->closed = TRUE;
3022   if (socket->priv->remote_address)
3023     {
3024       g_object_unref (socket->priv->remote_address);
3025       socket->priv->remote_address = NULL;
3026     }
3027
3028   return TRUE;
3029 }
3030
3031 /**
3032  * g_socket_is_closed:
3033  * @socket: a #GSocket
3034  *
3035  * Checks whether a socket is closed.
3036  *
3037  * Returns: %TRUE if socket is closed, %FALSE otherwise
3038  *
3039  * Since: 2.22
3040  */
3041 gboolean
3042 g_socket_is_closed (GSocket *socket)
3043 {
3044   return socket->priv->closed;
3045 }
3046
3047 #ifdef G_OS_WIN32
3048 /* Broken source, used on errors */
3049 static gboolean
3050 broken_dispatch (GSource     *source,
3051                  GSourceFunc  callback,
3052                  gpointer     user_data)
3053 {
3054   return TRUE;
3055 }
3056
3057 static GSourceFuncs broken_funcs =
3058 {
3059   NULL,
3060   NULL,
3061   broken_dispatch,
3062   NULL
3063 };
3064
3065 static gint
3066 network_events_for_condition (GIOCondition condition)
3067 {
3068   int event_mask = 0;
3069
3070   if (condition & G_IO_IN)
3071     event_mask |= (FD_READ | FD_ACCEPT);
3072   if (condition & G_IO_OUT)
3073     event_mask |= (FD_WRITE | FD_CONNECT);
3074   event_mask |= FD_CLOSE;
3075
3076   return event_mask;
3077 }
3078
3079 static void
3080 ensure_event (GSocket *socket)
3081 {
3082   if (socket->priv->event == WSA_INVALID_EVENT)
3083     socket->priv->event = WSACreateEvent();
3084 }
3085
3086 static void
3087 update_select_events (GSocket *socket)
3088 {
3089   int event_mask;
3090   GIOCondition *ptr;
3091   GList *l;
3092   WSAEVENT event;
3093
3094   ensure_event (socket);
3095
3096   event_mask = 0;
3097   for (l = socket->priv->requested_conditions; l != NULL; l = l->next)
3098     {
3099       ptr = l->data;
3100       event_mask |= network_events_for_condition (*ptr);
3101     }
3102
3103   if (event_mask != socket->priv->selected_events)
3104     {
3105       /* If no events selected, disable event so we can unset
3106          nonblocking mode */
3107
3108       if (event_mask == 0)
3109         event = NULL;
3110       else
3111         event = socket->priv->event;
3112
3113       if (WSAEventSelect (socket->priv->fd, event, event_mask) == 0)
3114         socket->priv->selected_events = event_mask;
3115     }
3116 }
3117
3118 static void
3119 add_condition_watch (GSocket      *socket,
3120                      GIOCondition *condition)
3121 {
3122   g_mutex_lock (&socket->priv->win32_source_lock);
3123   g_assert (g_list_find (socket->priv->requested_conditions, condition) == NULL);
3124
3125   socket->priv->requested_conditions =
3126     g_list_prepend (socket->priv->requested_conditions, condition);
3127
3128   update_select_events (socket);
3129   g_mutex_unlock (&socket->priv->win32_source_lock);
3130 }
3131
3132 static void
3133 remove_condition_watch (GSocket      *socket,
3134                         GIOCondition *condition)
3135 {
3136   g_mutex_lock (&socket->priv->win32_source_lock);
3137   g_assert (g_list_find (socket->priv->requested_conditions, condition) != NULL);
3138
3139   socket->priv->requested_conditions =
3140     g_list_remove (socket->priv->requested_conditions, condition);
3141
3142   update_select_events (socket);
3143   g_mutex_unlock (&socket->priv->win32_source_lock);
3144 }
3145
3146 static GIOCondition
3147 update_condition (GSocket *socket)
3148 {
3149   WSANETWORKEVENTS events;
3150   GIOCondition condition;
3151
3152   if (WSAEnumNetworkEvents (socket->priv->fd,
3153                             socket->priv->event,
3154                             &events) == 0)
3155     {
3156       socket->priv->current_events |= events.lNetworkEvents;
3157       if (events.lNetworkEvents & FD_WRITE &&
3158           events.iErrorCode[FD_WRITE_BIT] != 0)
3159         socket->priv->current_errors |= FD_WRITE;
3160       if (events.lNetworkEvents & FD_CONNECT &&
3161           events.iErrorCode[FD_CONNECT_BIT] != 0)
3162         socket->priv->current_errors |= FD_CONNECT;
3163     }
3164
3165   condition = 0;
3166   if (socket->priv->current_events & (FD_READ | FD_ACCEPT))
3167     condition |= G_IO_IN;
3168
3169   if (socket->priv->current_events & FD_CLOSE)
3170     {
3171       int r, errsv, buffer;
3172
3173       r = recv (socket->priv->fd, &buffer, sizeof (buffer), MSG_PEEK);
3174       if (r < 0)
3175           errsv = get_socket_errno ();
3176
3177       if (r > 0 ||
3178           (r < 0 && errsv == WSAENOTCONN))
3179         condition |= G_IO_IN;
3180       else if (r == 0 ||
3181                (r < 0 && (errsv == WSAESHUTDOWN || errsv == WSAECONNRESET ||
3182                           errsv == WSAECONNABORTED || errsv == WSAENETRESET)))
3183         condition |= G_IO_HUP;
3184       else
3185         condition |= G_IO_ERR;
3186     }
3187
3188   if (socket->priv->closed)
3189     condition |= G_IO_HUP;
3190
3191   /* Never report both G_IO_OUT and HUP, these are
3192      mutually exclusive (can't write to a closed socket) */
3193   if ((condition & G_IO_HUP) == 0 &&
3194       socket->priv->current_events & FD_WRITE)
3195     {
3196       if (socket->priv->current_errors & FD_WRITE)
3197         condition |= G_IO_ERR;
3198       else
3199         condition |= G_IO_OUT;
3200     }
3201   else
3202     {
3203       if (socket->priv->current_events & FD_CONNECT)
3204         {
3205           if (socket->priv->current_errors & FD_CONNECT)
3206             condition |= (G_IO_HUP | G_IO_ERR);
3207           else
3208             condition |= G_IO_OUT;
3209         }
3210     }
3211
3212   return condition;
3213 }
3214 #endif
3215
3216 typedef struct {
3217   GSource       source;
3218 #ifdef G_OS_WIN32
3219   GPollFD       pollfd;
3220 #else
3221   gpointer      fd_tag;
3222 #endif
3223   GSocket      *socket;
3224   GIOCondition  condition;
3225 } GSocketSource;
3226
3227 #ifdef G_OS_WIN32
3228 static gboolean
3229 socket_source_prepare_win32 (GSource *source,
3230                              gint    *timeout)
3231 {
3232   GSocketSource *socket_source = (GSocketSource *)source;
3233
3234   *timeout = -1;
3235
3236   return (update_condition (socket_source->socket) & socket_source->condition) != 0;
3237 }
3238
3239 static gboolean
3240 socket_source_check_win32 (GSource *source)
3241 {
3242   int timeout;
3243
3244   return socket_source_prepare_win32 (source, &timeout);
3245 }
3246 #endif
3247
3248 static gboolean
3249 socket_source_dispatch (GSource     *source,
3250                         GSourceFunc  callback,
3251                         gpointer     user_data)
3252 {
3253   GSocketSourceFunc func = (GSocketSourceFunc)callback;
3254   GSocketSource *socket_source = (GSocketSource *)source;
3255   GSocket *socket = socket_source->socket;
3256   gint64 timeout;
3257   guint events;
3258   gboolean ret;
3259
3260 #ifdef G_OS_WIN32
3261   events = update_condition (socket_source->socket);
3262 #else
3263   events = g_source_query_unix_fd (source, socket_source->fd_tag);
3264 #endif
3265
3266   timeout = g_source_get_ready_time (source);
3267   if (timeout >= 0 && timeout < g_source_get_time (source))
3268     {
3269       socket->priv->timed_out = TRUE;
3270       events |= (G_IO_IN | G_IO_OUT);
3271     }
3272
3273   ret = (*func) (socket, events & socket_source->condition, user_data);
3274
3275   if (socket->priv->timeout)
3276     g_source_set_ready_time (source, g_get_monotonic_time () + socket->priv->timeout * 1000000);
3277   else
3278     g_source_set_ready_time (source, -1);
3279
3280   return ret;
3281 }
3282
3283 static void
3284 socket_source_finalize (GSource *source)
3285 {
3286   GSocketSource *socket_source = (GSocketSource *)source;
3287   GSocket *socket;
3288
3289   socket = socket_source->socket;
3290
3291 #ifdef G_OS_WIN32
3292   remove_condition_watch (socket, &socket_source->condition);
3293 #endif
3294
3295   g_object_unref (socket);
3296 }
3297
3298 static gboolean
3299 socket_source_closure_callback (GSocket      *socket,
3300                                 GIOCondition  condition,
3301                                 gpointer      data)
3302 {
3303   GClosure *closure = data;
3304
3305   GValue params[2] = { G_VALUE_INIT, G_VALUE_INIT };
3306   GValue result_value = G_VALUE_INIT;
3307   gboolean result;
3308
3309   g_value_init (&result_value, G_TYPE_BOOLEAN);
3310
3311   g_value_init (&params[0], G_TYPE_SOCKET);
3312   g_value_set_object (&params[0], socket);
3313   g_value_init (&params[1], G_TYPE_IO_CONDITION);
3314   g_value_set_flags (&params[1], condition);
3315
3316   g_closure_invoke (closure, &result_value, 2, params, NULL);
3317
3318   result = g_value_get_boolean (&result_value);
3319   g_value_unset (&result_value);
3320   g_value_unset (&params[0]);
3321   g_value_unset (&params[1]);
3322
3323   return result;
3324 }
3325
3326 static GSourceFuncs socket_source_funcs =
3327 {
3328 #ifdef G_OS_WIN32
3329   socket_source_prepare_win32,
3330   socket_source_check_win32,
3331 #else
3332   NULL, NULL, /* check, prepare */
3333 #endif
3334   socket_source_dispatch,
3335   socket_source_finalize,
3336   (GSourceFunc)socket_source_closure_callback,
3337 };
3338
3339 static GSource *
3340 socket_source_new (GSocket      *socket,
3341                    GIOCondition  condition,
3342                    GCancellable *cancellable)
3343 {
3344   GSource *source;
3345   GSocketSource *socket_source;
3346
3347 #ifdef G_OS_WIN32
3348   ensure_event (socket);
3349
3350   if (socket->priv->event == WSA_INVALID_EVENT)
3351     {
3352       g_warning ("Failed to create WSAEvent");
3353       return g_source_new (&broken_funcs, sizeof (GSource));
3354     }
3355 #endif
3356
3357   condition |= G_IO_HUP | G_IO_ERR | G_IO_NVAL;
3358
3359   source = g_source_new (&socket_source_funcs, sizeof (GSocketSource));
3360   g_source_set_name (source, "GSocket");
3361   socket_source = (GSocketSource *)source;
3362
3363   socket_source->socket = g_object_ref (socket);
3364   socket_source->condition = condition;
3365
3366   if (cancellable)
3367     {
3368       GSource *cancellable_source;
3369
3370       cancellable_source = g_cancellable_source_new (cancellable);
3371       g_source_add_child_source (source, cancellable_source);
3372       g_source_set_dummy_callback (cancellable_source);
3373       g_source_unref (cancellable_source);
3374     }
3375
3376 #ifdef G_OS_WIN32
3377   add_condition_watch (socket, &socket_source->condition);
3378   socket_source->pollfd.fd = (gintptr) socket->priv->event;
3379   socket_source->pollfd.events = condition;
3380   socket_source->pollfd.revents = 0;
3381   g_source_add_poll (source, &socket_source->pollfd);
3382 #else
3383   socket_source->fd_tag = g_source_add_unix_fd (source, socket->priv->fd, condition);
3384 #endif
3385
3386   if (socket->priv->timeout)
3387     g_source_set_ready_time (source, g_get_monotonic_time () + socket->priv->timeout * 1000000);
3388   else
3389     g_source_set_ready_time (source, -1);
3390
3391   return source;
3392 }
3393
3394 /**
3395  * g_socket_create_source: (skip)
3396  * @socket: a #GSocket
3397  * @condition: a #GIOCondition mask to monitor
3398  * @cancellable: (allow-none): a %GCancellable or %NULL
3399  *
3400  * Creates a #GSource that can be attached to a %GMainContext to monitor
3401  * for the availability of the specified @condition on the socket. The #GSource
3402  * keeps a reference to the @socket.
3403  *
3404  * The callback on the source is of the #GSocketSourceFunc type.
3405  *
3406  * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in @condition;
3407  * these conditions will always be reported output if they are true.
3408  *
3409  * @cancellable if not %NULL can be used to cancel the source, which will
3410  * cause the source to trigger, reporting the current condition (which
3411  * is likely 0 unless cancellation happened at the same time as a
3412  * condition change). You can check for this in the callback using
3413  * g_cancellable_is_cancelled().
3414  *
3415  * If @socket has a timeout set, and it is reached before @condition
3416  * occurs, the source will then trigger anyway, reporting %G_IO_IN or
3417  * %G_IO_OUT depending on @condition. However, @socket will have been
3418  * marked as having had a timeout, and so the next #GSocket I/O method
3419  * you call will then fail with a %G_IO_ERROR_TIMED_OUT.
3420  *
3421  * Returns: (transfer full): a newly allocated %GSource, free with g_source_unref().
3422  *
3423  * Since: 2.22
3424  */
3425 GSource *
3426 g_socket_create_source (GSocket      *socket,
3427                         GIOCondition  condition,
3428                         GCancellable *cancellable)
3429 {
3430   g_return_val_if_fail (G_IS_SOCKET (socket) && (cancellable == NULL || G_IS_CANCELLABLE (cancellable)), NULL);
3431
3432   return socket_source_new (socket, condition, cancellable);
3433 }
3434
3435 /**
3436  * g_socket_condition_check:
3437  * @socket: a #GSocket
3438  * @condition: a #GIOCondition mask to check
3439  *
3440  * Checks on the readiness of @socket to perform operations.
3441  * The operations specified in @condition are checked for and masked
3442  * against the currently-satisfied conditions on @socket. The result
3443  * is returned.
3444  *
3445  * Note that on Windows, it is possible for an operation to return
3446  * %G_IO_ERROR_WOULD_BLOCK even immediately after
3447  * g_socket_condition_check() has claimed that the socket is ready for
3448  * writing. Rather than calling g_socket_condition_check() and then
3449  * writing to the socket if it succeeds, it is generally better to
3450  * simply try writing to the socket right away, and try again later if
3451  * the initial attempt returns %G_IO_ERROR_WOULD_BLOCK.
3452  *
3453  * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition;
3454  * these conditions will always be set in the output if they are true.
3455  *
3456  * This call never blocks.
3457  *
3458  * Returns: the @GIOCondition mask of the current state
3459  *
3460  * Since: 2.22
3461  */
3462 GIOCondition
3463 g_socket_condition_check (GSocket      *socket,
3464                           GIOCondition  condition)
3465 {
3466   g_return_val_if_fail (G_IS_SOCKET (socket), 0);
3467
3468   if (!check_socket (socket, NULL))
3469     return 0;
3470
3471 #ifdef G_OS_WIN32
3472   {
3473     GIOCondition current_condition;
3474
3475     condition |= G_IO_ERR | G_IO_HUP;
3476
3477     add_condition_watch (socket, &condition);
3478     current_condition = update_condition (socket);
3479     remove_condition_watch (socket, &condition);
3480     return condition & current_condition;
3481   }
3482 #else
3483   {
3484     GPollFD poll_fd;
3485     gint result;
3486     poll_fd.fd = socket->priv->fd;
3487     poll_fd.events = condition;
3488     poll_fd.revents = 0;
3489
3490     do
3491       result = g_poll (&poll_fd, 1, 0);
3492     while (result == -1 && get_socket_errno () == EINTR);
3493
3494     return poll_fd.revents;
3495   }
3496 #endif
3497 }
3498
3499 /**
3500  * g_socket_condition_wait:
3501  * @socket: a #GSocket
3502  * @condition: a #GIOCondition mask to wait for
3503  * @cancellable: (allow-none): a #GCancellable, or %NULL
3504  * @error: a #GError pointer, or %NULL
3505  *
3506  * Waits for @condition to become true on @socket. When the condition
3507  * is met, %TRUE is returned.
3508  *
3509  * If @cancellable is cancelled before the condition is met, or if the
3510  * socket has a timeout set and it is reached before the condition is
3511  * met, then %FALSE is returned and @error, if non-%NULL, is set to
3512  * the appropriate value (%G_IO_ERROR_CANCELLED or
3513  * %G_IO_ERROR_TIMED_OUT).
3514  *
3515  * See also g_socket_condition_timed_wait().
3516  *
3517  * Returns: %TRUE if the condition was met, %FALSE otherwise
3518  *
3519  * Since: 2.22
3520  */
3521 gboolean
3522 g_socket_condition_wait (GSocket       *socket,
3523                          GIOCondition   condition,
3524                          GCancellable  *cancellable,
3525                          GError       **error)
3526 {
3527   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
3528
3529   return g_socket_condition_timed_wait (socket, condition, -1,
3530                                         cancellable, error);
3531 }
3532
3533 /**
3534  * g_socket_condition_timed_wait:
3535  * @socket: a #GSocket
3536  * @condition: a #GIOCondition mask to wait for
3537  * @timeout: the maximum time (in microseconds) to wait, or -1
3538  * @cancellable: (allow-none): a #GCancellable, or %NULL
3539  * @error: a #GError pointer, or %NULL
3540  *
3541  * Waits for up to @timeout microseconds for @condition to become true
3542  * on @socket. If the condition is met, %TRUE is returned.
3543  *
3544  * If @cancellable is cancelled before the condition is met, or if
3545  * @timeout (or the socket's #GSocket:timeout) is reached before the
3546  * condition is met, then %FALSE is returned and @error, if non-%NULL,
3547  * is set to the appropriate value (%G_IO_ERROR_CANCELLED or
3548  * %G_IO_ERROR_TIMED_OUT).
3549  *
3550  * If you don't want a timeout, use g_socket_condition_wait().
3551  * (Alternatively, you can pass -1 for @timeout.)
3552  *
3553  * Note that although @timeout is in microseconds for consistency with
3554  * other GLib APIs, this function actually only has millisecond
3555  * resolution, and the behavior is undefined if @timeout is not an
3556  * exact number of milliseconds.
3557  *
3558  * Returns: %TRUE if the condition was met, %FALSE otherwise
3559  *
3560  * Since: 2.32
3561  */
3562 gboolean
3563 g_socket_condition_timed_wait (GSocket       *socket,
3564                                GIOCondition   condition,
3565                                gint64         timeout,
3566                                GCancellable  *cancellable,
3567                                GError       **error)
3568 {
3569   gint64 start_time;
3570
3571   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
3572
3573   if (!check_socket (socket, error))
3574     return FALSE;
3575
3576   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3577     return FALSE;
3578
3579   if (socket->priv->timeout &&
3580       (timeout < 0 || socket->priv->timeout < timeout / G_USEC_PER_SEC))
3581     timeout = socket->priv->timeout * 1000;
3582   else if (timeout != -1)
3583     timeout = timeout / 1000;
3584
3585   start_time = g_get_monotonic_time ();
3586
3587 #ifdef G_OS_WIN32
3588   {
3589     GIOCondition current_condition;
3590     WSAEVENT events[2];
3591     DWORD res;
3592     GPollFD cancel_fd;
3593     int num_events;
3594
3595     /* Always check these */
3596     condition |=  G_IO_ERR | G_IO_HUP;
3597
3598     add_condition_watch (socket, &condition);
3599
3600     num_events = 0;
3601     events[num_events++] = socket->priv->event;
3602
3603     if (g_cancellable_make_pollfd (cancellable, &cancel_fd))
3604       events[num_events++] = (WSAEVENT)cancel_fd.fd;
3605
3606     if (timeout == -1)
3607       timeout = WSA_INFINITE;
3608
3609     current_condition = update_condition (socket);
3610     while ((condition & current_condition) == 0)
3611       {
3612         res = WSAWaitForMultipleEvents (num_events, events,
3613                                         FALSE, timeout, FALSE);
3614         if (res == WSA_WAIT_FAILED)
3615           {
3616             int errsv = get_socket_errno ();
3617
3618             g_set_error (error, G_IO_ERROR,
3619                          socket_io_error_from_errno (errsv),
3620                          _("Waiting for socket condition: %s"),
3621                          socket_strerror (errsv));
3622             break;
3623           }
3624         else if (res == WSA_WAIT_TIMEOUT)
3625           {
3626             g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
3627                                  _("Socket I/O timed out"));
3628             break;
3629           }
3630
3631         if (g_cancellable_set_error_if_cancelled (cancellable, error))
3632           break;
3633
3634         current_condition = update_condition (socket);
3635
3636         if (timeout != WSA_INFINITE)
3637           {
3638             timeout -= (g_get_monotonic_time () - start_time) * 1000;
3639             if (timeout < 0)
3640               timeout = 0;
3641           }
3642       }
3643     remove_condition_watch (socket, &condition);
3644     if (num_events > 1)
3645       g_cancellable_release_fd (cancellable);
3646
3647     return (condition & current_condition) != 0;
3648   }
3649 #else
3650   {
3651     GPollFD poll_fd[2];
3652     gint result;
3653     gint num;
3654
3655     poll_fd[0].fd = socket->priv->fd;
3656     poll_fd[0].events = condition;
3657     num = 1;
3658
3659     if (g_cancellable_make_pollfd (cancellable, &poll_fd[1]))
3660       num++;
3661
3662     while (TRUE)
3663       {
3664         result = g_poll (poll_fd, num, timeout);
3665         if (result != -1 || errno != EINTR)
3666           break;
3667
3668         if (timeout != -1)
3669           {
3670             timeout -= (g_get_monotonic_time () - start_time) / 1000;
3671             if (timeout < 0)
3672               timeout = 0;
3673           }
3674       }
3675
3676     if (num > 1)
3677       g_cancellable_release_fd (cancellable);
3678
3679     if (result == 0)
3680       {
3681         g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
3682                              _("Socket I/O timed out"));
3683         return FALSE;
3684       }
3685
3686     return !g_cancellable_set_error_if_cancelled (cancellable, error);
3687   }
3688   #endif
3689 }
3690
3691 /**
3692  * g_socket_send_message:
3693  * @socket: a #GSocket
3694  * @address: (allow-none): a #GSocketAddress, or %NULL
3695  * @vectors: (array length=num_vectors): an array of #GOutputVector structs
3696  * @num_vectors: the number of elements in @vectors, or -1
3697  * @messages: (array length=num_messages) (allow-none): a pointer to an
3698  *   array of #GSocketControlMessages, or %NULL.
3699  * @num_messages: number of elements in @messages, or -1.
3700  * @flags: an int containing #GSocketMsgFlags flags
3701  * @cancellable: (allow-none): a %GCancellable or %NULL
3702  * @error: #GError for error reporting, or %NULL to ignore.
3703  *
3704  * Send data to @address on @socket.  This is the most complicated and
3705  * fully-featured version of this call. For easier use, see
3706  * g_socket_send() and g_socket_send_to().
3707  *
3708  * If @address is %NULL then the message is sent to the default receiver
3709  * (set by g_socket_connect()).
3710  *
3711  * @vectors must point to an array of #GOutputVector structs and
3712  * @num_vectors must be the length of this array. (If @num_vectors is -1,
3713  * then @vectors is assumed to be terminated by a #GOutputVector with a
3714  * %NULL buffer pointer.) The #GOutputVector structs describe the buffers
3715  * that the sent data will be gathered from. Using multiple
3716  * #GOutputVectors is more memory-efficient than manually copying
3717  * data from multiple sources into a single buffer, and more
3718  * network-efficient than making multiple calls to g_socket_send().
3719  *
3720  * @messages, if non-%NULL, is taken to point to an array of @num_messages
3721  * #GSocketControlMessage instances. These correspond to the control
3722  * messages to be sent on the socket.
3723  * If @num_messages is -1 then @messages is treated as a %NULL-terminated
3724  * array.
3725  *
3726  * @flags modify how the message is sent. The commonly available arguments
3727  * for this are available in the #GSocketMsgFlags enum, but the
3728  * values there are the same as the system values, and the flags
3729  * are passed in as-is, so you can pass in system-specific flags too.
3730  *
3731  * If the socket is in blocking mode the call will block until there is
3732  * space for the data in the socket queue. If there is no space available
3733  * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
3734  * will be returned. To be notified when space is available, wait for the
3735  * %G_IO_OUT condition. Note though that you may still receive
3736  * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
3737  * notified of a %G_IO_OUT condition. (On Windows in particular, this is
3738  * very common due to the way the underlying APIs work.)
3739  *
3740  * On error -1 is returned and @error is set accordingly.
3741  *
3742  * Returns: Number of bytes written (which may be less than @size), or -1
3743  * on error
3744  *
3745  * Since: 2.22
3746  */
3747 gssize
3748 g_socket_send_message (GSocket                *socket,
3749                        GSocketAddress         *address,
3750                        GOutputVector          *vectors,
3751                        gint                    num_vectors,
3752                        GSocketControlMessage **messages,
3753                        gint                    num_messages,
3754                        gint                    flags,
3755                        GCancellable           *cancellable,
3756                        GError                **error)
3757 {
3758   GOutputVector one_vector;
3759   char zero;
3760
3761   g_return_val_if_fail (G_IS_SOCKET (socket), -1);
3762   g_return_val_if_fail (address == NULL || G_IS_SOCKET_ADDRESS (address), -1);
3763   g_return_val_if_fail (num_vectors == 0 || vectors != NULL, -1);
3764   g_return_val_if_fail (num_messages == 0 || messages != NULL, -1);
3765   g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), -1);
3766   g_return_val_if_fail (error == NULL || *error == NULL, -1);
3767
3768   if (!check_socket (socket, error))
3769     return -1;
3770
3771   if (!check_timeout (socket, error))
3772     return -1;
3773
3774   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3775     return -1;
3776
3777   if (num_vectors == -1)
3778     {
3779       for (num_vectors = 0;
3780            vectors[num_vectors].buffer != NULL;
3781            num_vectors++)
3782         ;
3783     }
3784
3785   if (num_messages == -1)
3786     {
3787       for (num_messages = 0;
3788            messages != NULL && messages[num_messages] != NULL;
3789            num_messages++)
3790         ;
3791     }
3792
3793   if (num_vectors == 0)
3794     {
3795       zero = '\0';
3796
3797       one_vector.buffer = &zero;
3798       one_vector.size = 1;
3799       num_vectors = 1;
3800       vectors = &one_vector;
3801     }
3802
3803 #ifndef G_OS_WIN32
3804   {
3805     struct msghdr msg;
3806     gssize result;
3807
3808    msg.msg_flags = 0;
3809
3810     /* name */
3811     if (address)
3812       {
3813         msg.msg_namelen = g_socket_address_get_native_size (address);
3814         msg.msg_name = g_alloca (msg.msg_namelen);
3815         if (!g_socket_address_to_native (address, msg.msg_name, msg.msg_namelen, error))
3816           return -1;
3817       }
3818     else
3819       {
3820         msg.msg_name = NULL;
3821         msg.msg_namelen = 0;
3822       }
3823
3824     /* iov */
3825     {
3826       /* this entire expression will be evaluated at compile time */
3827       if (sizeof *msg.msg_iov == sizeof *vectors &&
3828           sizeof msg.msg_iov->iov_base == sizeof vectors->buffer &&
3829           G_STRUCT_OFFSET (struct iovec, iov_base) ==
3830           G_STRUCT_OFFSET (GOutputVector, buffer) &&
3831           sizeof msg.msg_iov->iov_len == sizeof vectors->size &&
3832           G_STRUCT_OFFSET (struct iovec, iov_len) ==
3833           G_STRUCT_OFFSET (GOutputVector, size))
3834         /* ABI is compatible */
3835         {
3836           msg.msg_iov = (struct iovec *) vectors;
3837           msg.msg_iovlen = num_vectors;
3838         }
3839       else
3840         /* ABI is incompatible */
3841         {
3842           gint i;
3843
3844           msg.msg_iov = g_newa (struct iovec, num_vectors);
3845           for (i = 0; i < num_vectors; i++)
3846             {
3847               msg.msg_iov[i].iov_base = (void *) vectors[i].buffer;
3848               msg.msg_iov[i].iov_len = vectors[i].size;
3849             }
3850           msg.msg_iovlen = num_vectors;
3851         }
3852     }
3853
3854     /* control */
3855     {
3856       struct cmsghdr *cmsg;
3857       gint i;
3858
3859       msg.msg_controllen = 0;
3860       for (i = 0; i < num_messages; i++)
3861         msg.msg_controllen += CMSG_SPACE (g_socket_control_message_get_size (messages[i]));
3862
3863       if (msg.msg_controllen == 0)
3864         msg.msg_control = NULL;
3865       else
3866         {
3867           msg.msg_control = g_alloca (msg.msg_controllen);
3868           memset (msg.msg_control, '\0', msg.msg_controllen);
3869         }
3870
3871       cmsg = CMSG_FIRSTHDR (&msg);
3872       for (i = 0; i < num_messages; i++)
3873         {
3874           cmsg->cmsg_level = g_socket_control_message_get_level (messages[i]);
3875           cmsg->cmsg_type = g_socket_control_message_get_msg_type (messages[i]);
3876           cmsg->cmsg_len = CMSG_LEN (g_socket_control_message_get_size (messages[i]));
3877           g_socket_control_message_serialize (messages[i],
3878                                               CMSG_DATA (cmsg));
3879           cmsg = CMSG_NXTHDR (&msg, cmsg);
3880         }
3881       g_assert (cmsg == NULL);
3882     }
3883
3884     while (1)
3885       {
3886         result = sendmsg (socket->priv->fd, &msg, flags | G_SOCKET_DEFAULT_SEND_FLAGS);
3887         if (result < 0)
3888           {
3889             int errsv = get_socket_errno ();
3890
3891             if (errsv == EINTR)
3892               continue;
3893
3894             if (socket->priv->blocking &&
3895                 (errsv == EWOULDBLOCK ||
3896                  errsv == EAGAIN))
3897               {
3898                 if (!g_socket_condition_wait (socket,
3899                                               G_IO_OUT, cancellable, error))
3900                   return -1;
3901
3902                 continue;
3903               }
3904
3905             g_set_error (error, G_IO_ERROR,
3906                          socket_io_error_from_errno (errsv),
3907                          _("Error sending message: %s"), socket_strerror (errsv));
3908
3909             return -1;
3910           }
3911         break;
3912       }
3913
3914     return result;
3915   }
3916 #else
3917   {
3918     struct sockaddr_storage addr;
3919     guint addrlen;
3920     DWORD bytes_sent;
3921     int result;
3922     WSABUF *bufs;
3923     gint i;
3924
3925     /* Win32 doesn't support control messages.
3926        Actually this is possible for raw and datagram sockets
3927        via WSASendMessage on Vista or later, but that doesn't
3928        seem very useful */
3929     if (num_messages != 0)
3930       {
3931         g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3932                              _("GSocketControlMessage not supported on Windows"));
3933         return -1;
3934       }
3935
3936     /* iov */
3937     bufs = g_newa (WSABUF, num_vectors);
3938     for (i = 0; i < num_vectors; i++)
3939       {
3940         bufs[i].buf = (char *)vectors[i].buffer;
3941         bufs[i].len = (gulong)vectors[i].size;
3942       }
3943
3944     /* name */
3945     addrlen = 0; /* Avoid warning */
3946     if (address)
3947       {
3948         addrlen = g_socket_address_get_native_size (address);
3949         if (!g_socket_address_to_native (address, &addr, sizeof addr, error))
3950           return -1;
3951       }
3952
3953     while (1)
3954       {
3955         if (address)
3956           result = WSASendTo (socket->priv->fd,
3957                               bufs, num_vectors,
3958                               &bytes_sent, flags,
3959                               (const struct sockaddr *)&addr, addrlen,
3960                               NULL, NULL);
3961         else
3962           result = WSASend (socket->priv->fd,
3963                             bufs, num_vectors,
3964                             &bytes_sent, flags,
3965                             NULL, NULL);
3966
3967         if (result != 0)
3968           {
3969             int errsv = get_socket_errno ();
3970
3971             if (errsv == WSAEINTR)
3972               continue;
3973
3974             if (errsv == WSAEWOULDBLOCK)
3975               {
3976                 win32_unset_event_mask (socket, FD_WRITE);
3977
3978                 if (socket->priv->blocking)
3979                   {
3980                     if (!g_socket_condition_wait (socket,
3981                                                   G_IO_OUT, cancellable, error))
3982                       return -1;
3983
3984                     continue;
3985                   }
3986               }
3987
3988             g_set_error (error, G_IO_ERROR,
3989                          socket_io_error_from_errno (errsv),
3990                          _("Error sending message: %s"), socket_strerror (errsv));
3991
3992             return -1;
3993           }
3994         break;
3995       }
3996
3997     return bytes_sent;
3998   }
3999 #endif
4000 }
4001
4002 /**
4003  * g_socket_send_messages:
4004  * @socket: a #GSocket
4005  * @messages: (array length=num_messages): an array of #GOutputMessage structs
4006  * @num_messages: the number of elements in @messages
4007  * @flags: an int containing #GSocketMsgFlags flags
4008  * @cancellable: (allow-none): a %GCancellable or %NULL
4009  * @error: #GError for error reporting, or %NULL to ignore.
4010  *
4011  * Send multiple data messages from @socket in one go.  This is the most
4012  * complicated and fully-featured version of this call. For easier use, see
4013  * g_socket_send(), g_socket_send_to(), and g_socket_send_message().
4014  *
4015  * @messages must point to an array of #GOutputMessage structs and
4016  * @num_messages must be the length of this array. Each #GOutputMessage
4017  * contains an address to send the data to, and a pointer to an array of
4018  * #GOutputVector structs to describe the buffers that the data to be sent
4019  * for each message will be gathered from. Using multiple #GOutputVectors is
4020  * more memory-efficient than manually copying data from multiple sources
4021  * into a single buffer, and more network-efficient than making multiple
4022  * calls to g_socket_send(). Sending multiple messages in one go avoids the
4023  * overhead of making a lot of syscalls in scenarios where a lot of data
4024  * packets need to be sent (e.g. high-bandwidth video streaming over RTP/UDP),
4025  * or where the same data needs to be sent to multiple recipients.
4026  *
4027  * @flags modify how the message is sent. The commonly available arguments
4028  * for this are available in the #GSocketMsgFlags enum, but the
4029  * values there are the same as the system values, and the flags
4030  * are passed in as-is, so you can pass in system-specific flags too.
4031  *
4032  * If the socket is in blocking mode the call will block until there is
4033  * space for all the data in the socket queue. If there is no space available
4034  * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
4035  * will be returned if no data was written at all, otherwise the number of
4036  * messages sent will be returned. To be notified when space is available,
4037  * wait for the %G_IO_OUT condition. Note though that you may still receive
4038  * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
4039  * notified of a %G_IO_OUT condition. (On Windows in particular, this is
4040  * very common due to the way the underlying APIs work.)
4041  *
4042  * On error -1 is returned and @error is set accordingly.
4043  *
4044  * Returns: number of messages sent, or -1 on error. Note that the number of
4045  *     messages sent may be smaller than @num_messages if the socket is
4046  *     non-blocking or if @num_messages was larger than UIO_MAXIOV (1024),
4047  *     in which case the caller may re-try to send the remaining messages.
4048  *
4049  * Since: 2.44
4050  */
4051 gint
4052 g_socket_send_messages (GSocket        *socket,
4053                         GOutputMessage *messages,
4054                         guint           num_messages,
4055                         gint            flags,
4056                         GCancellable   *cancellable,
4057                         GError        **error)
4058 {
4059   g_return_val_if_fail (G_IS_SOCKET (socket), -1);
4060   g_return_val_if_fail (num_messages == 0 || messages != NULL, -1);
4061   g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), -1);
4062   g_return_val_if_fail (error == NULL || *error == NULL, -1);
4063
4064   if (!check_socket (socket, error))
4065     return -1;
4066
4067   if (!check_timeout (socket, error))
4068     return -1;
4069
4070   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4071     return -1;
4072
4073   if (num_messages == 0)
4074     return 0;
4075
4076 #if !defined (G_OS_WIN32) && defined (HAVE_SENDMMSG)
4077   {
4078     struct mmsghdr *msgvec;
4079     gint i, num_sent, result, max_sent;
4080
4081 #ifdef UIO_MAXIOV
4082 #define MAX_NUM_MESSAGES UIO_MAXIOV
4083 #else
4084 #define MAX_NUM_MESSAGES 1024
4085 #endif
4086
4087     if (num_messages > MAX_NUM_MESSAGES)
4088       num_messages = MAX_NUM_MESSAGES;
4089
4090     msgvec = g_newa (struct mmsghdr, num_messages);
4091
4092     for (i = 0; i < num_messages; ++i)
4093       {
4094         GOutputMessage *msg = &messages[i];
4095         struct msghdr *msg_hdr = &msgvec[i].msg_hdr;
4096
4097         msgvec[i].msg_len = 0;
4098
4099         msg_hdr->msg_flags = 0;
4100
4101         /* name */
4102         if (i > 0 && msg->address == messages[i-1].address)
4103           {
4104             msg_hdr->msg_name = msgvec[i-1].msg_hdr.msg_name;
4105             msg_hdr->msg_namelen = msgvec[i-1].msg_hdr.msg_namelen;
4106           }
4107         else if (msg->address)
4108           {
4109             msg_hdr->msg_namelen = g_socket_address_get_native_size (msg->address);
4110             msg_hdr->msg_name = g_alloca (msg_hdr->msg_namelen);
4111             if (!g_socket_address_to_native (msg->address, msg_hdr->msg_name, msg_hdr->msg_namelen, error))
4112               return -1;
4113           }
4114         else
4115           {
4116             msg_hdr->msg_name = NULL;
4117             msg_hdr->msg_namelen = 0;
4118           }
4119
4120         /* iov */
4121         {
4122           /* this entire expression will be evaluated at compile time */
4123           if (sizeof (struct iovec) == sizeof (GOutputVector) &&
4124               sizeof msg_hdr->msg_iov->iov_base == sizeof msg->vectors->buffer &&
4125               G_STRUCT_OFFSET (struct iovec, iov_base) ==
4126               G_STRUCT_OFFSET (GOutputVector, buffer) &&
4127               sizeof msg_hdr->msg_iov->iov_len == sizeof msg->vectors->size &&
4128               G_STRUCT_OFFSET (struct iovec, iov_len) ==
4129               G_STRUCT_OFFSET (GOutputVector, size))
4130             /* ABI is compatible */
4131             {
4132               msg_hdr->msg_iov = (struct iovec *) msg->vectors;
4133               msg_hdr->msg_iovlen = msg->num_vectors;
4134             }
4135           else
4136             /* ABI is incompatible */
4137             {
4138               gint j;
4139
4140               msg_hdr->msg_iov = g_newa (struct iovec, msg->num_vectors);
4141               for (j = 0; j < msg->num_vectors; j++)
4142                 {
4143                   msg_hdr->msg_iov[j].iov_base = (void *) msg->vectors[j].buffer;
4144                   msg_hdr->msg_iov[j].iov_len = msg->vectors[j].size;
4145                 }
4146               msg_hdr->msg_iovlen = msg->num_vectors;
4147             }
4148         }
4149
4150         /* control */
4151         {
4152           struct cmsghdr *cmsg;
4153           gint j;
4154
4155           msg_hdr->msg_controllen = 0;
4156           for (j = 0; j < msg->num_control_messages; j++)
4157             msg_hdr->msg_controllen += CMSG_SPACE (g_socket_control_message_get_size (msg->control_messages[j]));
4158
4159           if (msg_hdr->msg_controllen == 0)
4160             msg_hdr->msg_control = NULL;
4161           else
4162             {
4163               msg_hdr->msg_control = g_alloca (msg_hdr->msg_controllen);
4164               memset (msg_hdr->msg_control, '\0', msg_hdr->msg_controllen);
4165             }
4166
4167           cmsg = CMSG_FIRSTHDR (msg_hdr);
4168           for (j = 0; j < msg->num_control_messages; j++)
4169             {
4170               GSocketControlMessage *cm = msg->control_messages[j];
4171
4172               cmsg->cmsg_level = g_socket_control_message_get_level (cm);
4173               cmsg->cmsg_type = g_socket_control_message_get_msg_type (cm);
4174               cmsg->cmsg_len = CMSG_LEN (g_socket_control_message_get_size (cm));
4175               g_socket_control_message_serialize (cm, CMSG_DATA (cmsg));
4176               cmsg = CMSG_NXTHDR (msg_hdr, cmsg);
4177             }
4178           g_assert (cmsg == NULL);
4179         }
4180       }
4181
4182     num_sent = result = 0;
4183     max_sent = num_messages;
4184     while (num_sent < num_messages)
4185       {
4186         gint ret;
4187
4188         if (socket->priv->blocking &&
4189             !g_socket_condition_wait (socket,
4190                                       G_IO_OUT, cancellable, error))
4191           return -1;
4192
4193         ret = sendmmsg (socket->priv->fd, msgvec + num_sent, num_messages - num_sent,
4194                         flags | G_SOCKET_DEFAULT_SEND_FLAGS);
4195
4196         if (ret < 0)
4197           {
4198             int errsv = get_socket_errno ();
4199
4200             if (errsv == EINTR)
4201               continue;
4202
4203             if (socket->priv->blocking &&
4204                 (errsv == EWOULDBLOCK ||
4205                  errsv == EAGAIN))
4206               continue;
4207
4208             if (num_sent > 0 &&
4209                 (errsv == EWOULDBLOCK ||
4210                  errsv == EAGAIN))
4211               {
4212                 max_sent = num_sent;
4213                 break;
4214               }
4215
4216             g_set_error (error, G_IO_ERROR,
4217                          socket_io_error_from_errno (errsv),
4218                          _("Error sending message: %s"), socket_strerror (errsv));
4219
4220             /* we have to iterate over all messages below now, because we don't
4221              * know where between num_sent and num_messages the error occured */
4222             max_sent = num_messages;
4223
4224             result = -1;
4225             break;
4226           }
4227
4228         num_sent += ret;
4229         result = num_sent;
4230       }
4231
4232     for (i = 0; i < max_sent; ++i)
4233       messages[i].bytes_sent = msgvec[i].msg_len;
4234
4235     return result;
4236   }
4237 #else
4238   {
4239     gssize result;
4240     gint i;
4241
4242     for (i = 0; i < num_messages; ++i)
4243       {
4244         GOutputMessage *msg = &messages[i];
4245         GError *msg_error = NULL;
4246
4247         result = g_socket_send_message (socket, msg->address,
4248                                         msg->vectors, msg->num_vectors,
4249                                         msg->control_messages,
4250                                         msg->num_control_messages,
4251                                         flags, cancellable, &msg_error);
4252
4253         if (result < 0)
4254           {
4255             /* if we couldn't send all messages, just return how many we did
4256              * manage to send, provided we managed to send at least one */
4257             if (msg_error->code == G_IO_ERROR_WOULD_BLOCK && i > 0)
4258               {
4259                 g_error_free (msg_error);
4260                 return i;
4261               }
4262             else
4263               {
4264                 g_propagate_error (error, msg_error);
4265                 return -1;
4266               }
4267           }
4268
4269         msg->bytes_sent = result;
4270       }
4271
4272     return i;
4273   }
4274 #endif
4275 }
4276
4277 static GSocketAddress *
4278 cache_recv_address (GSocket *socket, struct sockaddr *native, int native_len)
4279 {
4280   GSocketAddress *saddr;
4281   gint i;
4282   guint64 oldest_time = G_MAXUINT64;
4283   gint oldest_index = 0;
4284
4285   if (native_len <= 0)
4286     return NULL;
4287
4288   saddr = NULL;
4289   for (i = 0; i < RECV_ADDR_CACHE_SIZE; i++)
4290     {
4291       GSocketAddress *tmp = socket->priv->recv_addr_cache[i].addr;
4292       gpointer tmp_native = socket->priv->recv_addr_cache[i].native;
4293       gint tmp_native_len = socket->priv->recv_addr_cache[i].native_len;
4294
4295       if (!tmp)
4296         continue;
4297
4298       if (tmp_native_len != native_len)
4299         continue;
4300
4301       if (memcmp (tmp_native, native, native_len) == 0)
4302         {
4303           saddr = g_object_ref (tmp);
4304           socket->priv->recv_addr_cache[i].last_used = g_get_monotonic_time ();
4305           return saddr;
4306         }
4307
4308       if (socket->priv->recv_addr_cache[i].last_used < oldest_time)
4309         {
4310           oldest_time = socket->priv->recv_addr_cache[i].last_used;
4311           oldest_index = i;
4312         }
4313     }
4314
4315   saddr = g_socket_address_new_from_native (native, native_len);
4316
4317   if (socket->priv->recv_addr_cache[oldest_index].addr)
4318     {
4319       g_object_unref (socket->priv->recv_addr_cache[oldest_index].addr);
4320       g_free (socket->priv->recv_addr_cache[oldest_index].native);
4321     }
4322
4323   socket->priv->recv_addr_cache[oldest_index].native = g_memdup (native, native_len);
4324   socket->priv->recv_addr_cache[oldest_index].native_len = native_len;
4325   socket->priv->recv_addr_cache[oldest_index].addr = g_object_ref (saddr);
4326   socket->priv->recv_addr_cache[oldest_index].last_used = g_get_monotonic_time ();
4327
4328   return saddr;
4329 }
4330
4331 /**
4332  * g_socket_receive_message:
4333  * @socket: a #GSocket
4334  * @address: (out) (allow-none): a pointer to a #GSocketAddress
4335  *     pointer, or %NULL
4336  * @vectors: (array length=num_vectors): an array of #GInputVector structs
4337  * @num_vectors: the number of elements in @vectors, or -1
4338  * @messages: (array length=num_messages) (allow-none): a pointer which
4339  *    may be filled with an array of #GSocketControlMessages, or %NULL
4340  * @num_messages: a pointer which will be filled with the number of
4341  *    elements in @messages, or %NULL
4342  * @flags: a pointer to an int containing #GSocketMsgFlags flags
4343  * @cancellable: (allow-none): a %GCancellable or %NULL
4344  * @error: a #GError pointer, or %NULL
4345  *
4346  * Receive data from a socket.  This is the most complicated and
4347  * fully-featured version of this call. For easier use, see
4348  * g_socket_receive() and g_socket_receive_from().
4349  *
4350  * If @address is non-%NULL then @address will be set equal to the
4351  * source address of the received packet.
4352  * @address is owned by the caller.
4353  *
4354  * @vector must point to an array of #GInputVector structs and
4355  * @num_vectors must be the length of this array.  These structs
4356  * describe the buffers that received data will be scattered into.
4357  * If @num_vectors is -1, then @vectors is assumed to be terminated
4358  * by a #GInputVector with a %NULL buffer pointer.
4359  *
4360  * As a special case, if @num_vectors is 0 (in which case, @vectors
4361  * may of course be %NULL), then a single byte is received and
4362  * discarded. This is to facilitate the common practice of sending a
4363  * single '\0' byte for the purposes of transferring ancillary data.
4364  *
4365  * @messages, if non-%NULL, will be set to point to a newly-allocated
4366  * array of #GSocketControlMessage instances or %NULL if no such
4367  * messages was received. These correspond to the control messages
4368  * received from the kernel, one #GSocketControlMessage per message
4369  * from the kernel. This array is %NULL-terminated and must be freed
4370  * by the caller using g_free() after calling g_object_unref() on each
4371  * element. If @messages is %NULL, any control messages received will
4372  * be discarded.
4373  *
4374  * @num_messages, if non-%NULL, will be set to the number of control
4375  * messages received.
4376  *
4377  * If both @messages and @num_messages are non-%NULL, then
4378  * @num_messages gives the number of #GSocketControlMessage instances
4379  * in @messages (ie: not including the %NULL terminator).
4380  *
4381  * @flags is an in/out parameter. The commonly available arguments
4382  * for this are available in the #GSocketMsgFlags enum, but the
4383  * values there are the same as the system values, and the flags
4384  * are passed in as-is, so you can pass in system-specific flags too
4385  * (and g_socket_receive_message() may pass system-specific flags out).
4386  *
4387  * As with g_socket_receive(), data may be discarded if @socket is
4388  * %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not
4389  * provide enough buffer space to read a complete message. You can pass
4390  * %G_SOCKET_MSG_PEEK in @flags to peek at the current message without
4391  * removing it from the receive queue, but there is no portable way to find
4392  * out the length of the message other than by reading it into a
4393  * sufficiently-large buffer.
4394  *
4395  * If the socket is in blocking mode the call will block until there
4396  * is some data to receive, the connection is closed, or there is an
4397  * error. If there is no data available and the socket is in
4398  * non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error will be
4399  * returned. To be notified when data is available, wait for the
4400  * %G_IO_IN condition.
4401  *
4402  * On error -1 is returned and @error is set accordingly.
4403  *
4404  * Returns: Number of bytes read, or 0 if the connection was closed by
4405  * the peer, or -1 on error
4406  *
4407  * Since: 2.22
4408  */
4409 gssize
4410 g_socket_receive_message (GSocket                 *socket,
4411                           GSocketAddress         **address,
4412                           GInputVector            *vectors,
4413                           gint                     num_vectors,
4414                           GSocketControlMessage ***messages,
4415                           gint                    *num_messages,
4416                           gint                    *flags,
4417                           GCancellable            *cancellable,
4418                           GError                 **error)
4419 {
4420   GInputVector one_vector;
4421   char one_byte;
4422
4423   g_return_val_if_fail (G_IS_SOCKET (socket), -1);
4424
4425   if (!check_socket (socket, error))
4426     return -1;
4427
4428   if (!check_timeout (socket, error))
4429     return -1;
4430
4431   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4432     return -1;
4433
4434   if (num_vectors == -1)
4435     {
4436       for (num_vectors = 0;
4437            vectors[num_vectors].buffer != NULL;
4438            num_vectors++)
4439         ;
4440     }
4441
4442   if (num_vectors == 0)
4443     {
4444       one_vector.buffer = &one_byte;
4445       one_vector.size = 1;
4446       num_vectors = 1;
4447       vectors = &one_vector;
4448     }
4449
4450 #ifndef G_OS_WIN32
4451   {
4452     struct msghdr msg;
4453     gssize result;
4454     struct sockaddr_storage one_sockaddr;
4455
4456     /* name */
4457     if (address)
4458       {
4459         msg.msg_name = &one_sockaddr;
4460         msg.msg_namelen = sizeof (struct sockaddr_storage);
4461       }
4462     else
4463       {
4464         msg.msg_name = NULL;
4465         msg.msg_namelen = 0;
4466       }
4467
4468     /* iov */
4469     /* this entire expression will be evaluated at compile time */
4470     if (sizeof *msg.msg_iov == sizeof *vectors &&
4471         sizeof msg.msg_iov->iov_base == sizeof vectors->buffer &&
4472         G_STRUCT_OFFSET (struct iovec, iov_base) ==
4473         G_STRUCT_OFFSET (GInputVector, buffer) &&
4474         sizeof msg.msg_iov->iov_len == sizeof vectors->size &&
4475         G_STRUCT_OFFSET (struct iovec, iov_len) ==
4476         G_STRUCT_OFFSET (GInputVector, size))
4477       /* ABI is compatible */
4478       {
4479         msg.msg_iov = (struct iovec *) vectors;
4480         msg.msg_iovlen = num_vectors;
4481       }
4482     else
4483       /* ABI is incompatible */
4484       {
4485         gint i;
4486
4487         msg.msg_iov = g_newa (struct iovec, num_vectors);
4488         for (i = 0; i < num_vectors; i++)
4489           {
4490             msg.msg_iov[i].iov_base = vectors[i].buffer;
4491             msg.msg_iov[i].iov_len = vectors[i].size;
4492           }
4493         msg.msg_iovlen = num_vectors;
4494       }
4495
4496     /* control */
4497     msg.msg_control = g_alloca (2048);
4498     msg.msg_controllen = 2048;
4499
4500     /* flags */
4501     if (flags != NULL)
4502       msg.msg_flags = *flags;
4503     else
4504       msg.msg_flags = 0;
4505
4506     /* We always set the close-on-exec flag so we don't leak file
4507      * descriptors into child processes.  Note that gunixfdmessage.c
4508      * will later call fcntl (fd, FD_CLOEXEC), but that isn't atomic.
4509      */
4510 #ifdef MSG_CMSG_CLOEXEC
4511     msg.msg_flags |= MSG_CMSG_CLOEXEC;
4512 #endif
4513
4514     /* do it */
4515     while (1)
4516       {
4517         if (socket->priv->blocking &&
4518             !g_socket_condition_wait (socket,
4519                                       G_IO_IN, cancellable, error))
4520           return -1;
4521
4522         result = recvmsg (socket->priv->fd, &msg, msg.msg_flags);
4523 #ifdef MSG_CMSG_CLOEXEC
4524         if (result < 0 && get_socket_errno () == EINVAL)
4525           {
4526             /* We must be running on an old kernel.  Call without the flag. */
4527             msg.msg_flags &= ~(MSG_CMSG_CLOEXEC);
4528             result = recvmsg (socket->priv->fd, &msg, msg.msg_flags);
4529           }
4530 #endif
4531
4532         if (result < 0)
4533           {
4534             int errsv = get_socket_errno ();
4535
4536             if (errsv == EINTR)
4537               continue;
4538
4539             if (socket->priv->blocking &&
4540                 (errsv == EWOULDBLOCK ||
4541                  errsv == EAGAIN))
4542               continue;
4543
4544             g_set_error (error, G_IO_ERROR,
4545                          socket_io_error_from_errno (errsv),
4546                          _("Error receiving message: %s"), socket_strerror (errsv));
4547
4548             return -1;
4549           }
4550         break;
4551       }
4552
4553     /* decode address */
4554     if (address != NULL)
4555       {
4556         *address = cache_recv_address (socket, msg.msg_name, msg.msg_namelen);
4557       }
4558
4559     /* decode control messages */
4560     {
4561       GPtrArray *my_messages = NULL;
4562       struct cmsghdr *cmsg;
4563
4564       if (msg.msg_controllen >= sizeof (struct cmsghdr))
4565         {
4566           for (cmsg = CMSG_FIRSTHDR (&msg); cmsg; cmsg = CMSG_NXTHDR (&msg, cmsg))
4567             {
4568               GSocketControlMessage *message;
4569
4570               message = g_socket_control_message_deserialize (cmsg->cmsg_level,
4571                                                               cmsg->cmsg_type,
4572                                                               cmsg->cmsg_len - ((char *)CMSG_DATA (cmsg) - (char *)cmsg),
4573                                                               CMSG_DATA (cmsg));
4574               if (message == NULL)
4575                 /* We've already spewed about the problem in the
4576                    deserialization code, so just continue */
4577                 continue;
4578
4579               if (messages == NULL)
4580                 {
4581                   /* we have to do it this way if the user ignores the
4582                    * messages so that we will close any received fds.
4583                    */
4584                   g_object_unref (message);
4585                 }
4586               else
4587                 {
4588                   if (my_messages == NULL)
4589                     my_messages = g_ptr_array_new ();
4590                   g_ptr_array_add (my_messages, message);
4591                 }
4592             }
4593         }
4594
4595       if (num_messages)
4596         *num_messages = my_messages != NULL ? my_messages->len : 0;
4597
4598       if (messages)
4599         {
4600           if (my_messages == NULL)
4601             {
4602               *messages = NULL;
4603             }
4604           else
4605             {
4606               g_ptr_array_add (my_messages, NULL);
4607               *messages = (GSocketControlMessage **) g_ptr_array_free (my_messages, FALSE);
4608             }
4609         }
4610       else
4611         {
4612           g_assert (my_messages == NULL);
4613         }
4614     }
4615
4616     /* capture the flags */
4617     if (flags != NULL)
4618       *flags = msg.msg_flags;
4619
4620     return result;
4621   }
4622 #else
4623   {
4624     struct sockaddr_storage addr;
4625     int addrlen;
4626     DWORD bytes_received;
4627     DWORD win_flags;
4628     int result;
4629     WSABUF *bufs;
4630     gint i;
4631
4632     /* iov */
4633     bufs = g_newa (WSABUF, num_vectors);
4634     for (i = 0; i < num_vectors; i++)
4635       {
4636         bufs[i].buf = (char *)vectors[i].buffer;
4637         bufs[i].len = (gulong)vectors[i].size;
4638       }
4639
4640     /* flags */
4641     if (flags != NULL)
4642       win_flags = *flags;
4643     else
4644       win_flags = 0;
4645
4646     /* do it */
4647     while (1)
4648       {
4649         addrlen = sizeof addr;
4650         if (address)
4651           result = WSARecvFrom (socket->priv->fd,
4652                                 bufs, num_vectors,
4653                                 &bytes_received, &win_flags,
4654                                 (struct sockaddr *)&addr, &addrlen,
4655                                 NULL, NULL);
4656         else
4657           result = WSARecv (socket->priv->fd,
4658                             bufs, num_vectors,
4659                             &bytes_received, &win_flags,
4660                             NULL, NULL);
4661         if (result != 0)
4662           {
4663             int errsv = get_socket_errno ();
4664
4665             if (errsv == WSAEINTR)
4666               continue;
4667
4668             if (errsv == WSAEWOULDBLOCK)
4669               {
4670                 win32_unset_event_mask (socket, FD_READ);
4671
4672                 if (socket->priv->blocking)
4673                   {
4674                     if (!g_socket_condition_wait (socket,
4675                                                   G_IO_IN, cancellable, error))
4676                       return -1;
4677
4678                     continue;
4679                   }
4680               }
4681
4682             g_set_error (error, G_IO_ERROR,
4683                          socket_io_error_from_errno (errsv),
4684                          _("Error receiving message: %s"), socket_strerror (errsv));
4685
4686             return -1;
4687           }
4688         win32_unset_event_mask (socket, FD_READ);
4689         break;
4690       }
4691
4692     /* decode address */
4693     if (address != NULL)
4694       {
4695         *address = cache_recv_address (socket, (struct sockaddr *)&addr, addrlen);
4696       }
4697
4698     /* capture the flags */
4699     if (flags != NULL)
4700       *flags = win_flags;
4701
4702     if (messages != NULL)
4703       *messages = NULL;
4704     if (num_messages != NULL)
4705       *num_messages = 0;
4706
4707     return bytes_received;
4708   }
4709 #endif
4710 }
4711
4712 /**
4713  * g_socket_get_credentials:
4714  * @socket: a #GSocket.
4715  * @error: #GError for error reporting, or %NULL to ignore.
4716  *
4717  * Returns the credentials of the foreign process connected to this
4718  * socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX
4719  * sockets).
4720  *
4721  * If this operation isn't supported on the OS, the method fails with
4722  * the %G_IO_ERROR_NOT_SUPPORTED error. On Linux this is implemented
4723  * by reading the %SO_PEERCRED option on the underlying socket.
4724  *
4725  * Other ways to obtain credentials from a foreign peer includes the
4726  * #GUnixCredentialsMessage type and
4727  * g_unix_connection_send_credentials() /
4728  * g_unix_connection_receive_credentials() functions.
4729  *
4730  * Returns: (transfer full): %NULL if @error is set, otherwise a #GCredentials object
4731  * that must be freed with g_object_unref().
4732  *
4733  * Since: 2.26
4734  */
4735 GCredentials *
4736 g_socket_get_credentials (GSocket   *socket,
4737                           GError   **error)
4738 {
4739   GCredentials *ret;
4740
4741   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
4742   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
4743
4744   ret = NULL;
4745
4746 #if G_CREDENTIALS_SOCKET_GET_CREDENTIALS_SUPPORTED
4747
4748 #ifdef SO_PEERCRED
4749   {
4750     guint8 native_creds_buf[G_CREDENTIALS_NATIVE_SIZE];
4751     socklen_t optlen = sizeof (native_creds_buf);
4752
4753     if (getsockopt (socket->priv->fd,
4754                     SOL_SOCKET,
4755                     SO_PEERCRED,
4756                     native_creds_buf,
4757                     &optlen) == 0)
4758       {
4759         ret = g_credentials_new ();
4760         g_credentials_set_native (ret,
4761                                   G_CREDENTIALS_NATIVE_TYPE,
4762                                   native_creds_buf);
4763       }
4764   }
4765 #elif G_CREDENTIALS_USE_NETBSD_UNPCBID
4766   {
4767     struct unpcbid cred;
4768     socklen_t optlen = sizeof (cred);
4769
4770     if (getsockopt (socket->priv->fd,
4771                     0,
4772                     LOCAL_PEEREID,
4773                     &cred,
4774                     &optlen) == 0)
4775       {
4776         ret = g_credentials_new ();
4777         g_credentials_set_native (ret,
4778                                   G_CREDENTIALS_NATIVE_TYPE,
4779                                   &cred);
4780       }
4781   }
4782 #elif G_CREDENTIALS_USE_SOLARIS_UCRED
4783   {
4784     ucred_t *ucred = NULL;
4785
4786     if (getpeerucred (socket->priv->fd, &ucred) == 0)
4787       {
4788         ret = g_credentials_new ();
4789         g_credentials_set_native (ret,
4790                                   G_CREDENTIALS_TYPE_SOLARIS_UCRED,
4791                                   ucred);
4792         ucred_free (ucred);
4793       }
4794   }
4795 #else
4796   #error "G_CREDENTIALS_SOCKET_GET_CREDENTIALS_SUPPORTED is set but this is no code for this platform"
4797 #endif
4798
4799   if (!ret)
4800     {
4801       int errsv = get_socket_errno ();
4802
4803       g_set_error (error,
4804                    G_IO_ERROR,
4805                    socket_io_error_from_errno (errsv),
4806                    _("Unable to read socket credentials: %s"),
4807                    socket_strerror (errsv));
4808     }
4809
4810 #else
4811
4812   g_set_error_literal (error,
4813                        G_IO_ERROR,
4814                        G_IO_ERROR_NOT_SUPPORTED,
4815                        _("g_socket_get_credentials not implemented for this OS"));
4816 #endif
4817
4818   return ret;
4819 }
4820
4821 /**
4822  * g_socket_get_option:
4823  * @socket: a #GSocket
4824  * @level: the "API level" of the option (eg, `SOL_SOCKET`)
4825  * @optname: the "name" of the option (eg, `SO_BROADCAST`)
4826  * @value: (out): return location for the option value
4827  * @error: #GError for error reporting, or %NULL to ignore.
4828  *
4829  * Gets the value of an integer-valued option on @socket, as with
4830  * getsockopt(). (If you need to fetch a  non-integer-valued option,
4831  * you will need to call getsockopt() directly.)
4832  *
4833  * The [<gio/gnetworking.h>][gio-gnetworking.h]
4834  * header pulls in system headers that will define most of the
4835  * standard/portable socket options. For unusual socket protocols or
4836  * platform-dependent options, you may need to include additional
4837  * headers.
4838  *
4839  * Note that even for socket options that are a single byte in size,
4840  * @value is still a pointer to a #gint variable, not a #guchar;
4841  * g_socket_get_option() will handle the conversion internally.
4842  *
4843  * Returns: success or failure. On failure, @error will be set, and
4844  *   the system error value (`errno` or WSAGetLastError()) will still
4845  *   be set to the result of the getsockopt() call.
4846  *
4847  * Since: 2.36
4848  */
4849 gboolean
4850 g_socket_get_option (GSocket  *socket,
4851                      gint      level,
4852                      gint      optname,
4853                      gint     *value,
4854                      GError  **error)
4855 {
4856   guint size;
4857
4858   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
4859
4860   *value = 0;
4861   size = sizeof (gint);
4862   if (getsockopt (socket->priv->fd, level, optname, value, &size) != 0)
4863     {
4864       int errsv = get_socket_errno ();
4865
4866       g_set_error_literal (error,
4867                            G_IO_ERROR,
4868                            socket_io_error_from_errno (errsv),
4869                            socket_strerror (errsv));
4870 #ifndef G_OS_WIN32
4871       /* Reset errno in case the caller wants to look at it */
4872       errno = errsv;
4873 #endif
4874       return FALSE;
4875     }
4876
4877 #if G_BYTE_ORDER == G_BIG_ENDIAN
4878   /* If the returned value is smaller than an int then we need to
4879    * slide it over into the low-order bytes of *value.
4880    */
4881   if (size != sizeof (gint))
4882     *value = *value >> (8 * (sizeof (gint) - size));
4883 #endif
4884
4885   return TRUE;
4886 }
4887
4888 /**
4889  * g_socket_set_option:
4890  * @socket: a #GSocket
4891  * @level: the "API level" of the option (eg, `SOL_SOCKET`)
4892  * @optname: the "name" of the option (eg, `SO_BROADCAST`)
4893  * @value: the value to set the option to
4894  * @error: #GError for error reporting, or %NULL to ignore.
4895  *
4896  * Sets the value of an integer-valued option on @socket, as with
4897  * setsockopt(). (If you need to set a non-integer-valued option,
4898  * you will need to call setsockopt() directly.)
4899  *
4900  * The [<gio/gnetworking.h>][gio-gnetworking.h]
4901  * header pulls in system headers that will define most of the
4902  * standard/portable socket options. For unusual socket protocols or
4903  * platform-dependent options, you may need to include additional
4904  * headers.
4905  *
4906  * Returns: success or failure. On failure, @error will be set, and
4907  *   the system error value (`errno` or WSAGetLastError()) will still
4908  *   be set to the result of the setsockopt() call.
4909  *
4910  * Since: 2.36
4911  */
4912 gboolean
4913 g_socket_set_option (GSocket  *socket,
4914                      gint      level,
4915                      gint      optname,
4916                      gint      value,
4917                      GError  **error)
4918 {
4919   gint errsv;
4920
4921   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
4922
4923   if (setsockopt (socket->priv->fd, level, optname, &value, sizeof (gint)) == 0)
4924     return TRUE;
4925
4926 #if !defined (__linux__) && !defined (G_OS_WIN32)
4927   /* Linux and Windows let you set a single-byte value from an int,
4928    * but most other platforms don't.
4929    */
4930   if (errno == EINVAL && value >= SCHAR_MIN && value <= CHAR_MAX)
4931     {
4932 #if G_BYTE_ORDER == G_BIG_ENDIAN
4933       value = value << (8 * (sizeof (gint) - 1));
4934 #endif
4935       if (setsockopt (socket->priv->fd, level, optname, &value, 1) == 0)
4936         return TRUE;
4937     }
4938 #endif
4939
4940   errsv = get_socket_errno ();
4941
4942   g_set_error_literal (error,
4943                        G_IO_ERROR,
4944                        socket_io_error_from_errno (errsv),
4945                        socket_strerror (errsv));
4946 #ifndef G_OS_WIN32
4947   errno = errsv;
4948 #endif
4949   return FALSE;
4950 }
4951