:right-sidebar: True Socket =================================================================== .. currentmodule:: gi.repository.Gio .. versionadded:: 2.22 .. class:: Socket(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` Implemented Interfaces: :class:`~gi.repository.Gio.DatagramBased`, :class:`~gi.repository.Gio.Initable` A ``GSocket`` is a low-level networking primitive. It is a more or less direct mapping of the BSD socket API in a portable GObject based API. It supports both the UNIX socket implementations and winsock2 on Windows. ``GSocket`` is the platform independent base upon which the higher level network primitives are based. Applications are not typically meant to use it directly, but rather through classes like :obj:`~gi.repository.Gio.SocketClient`\, :obj:`~gi.repository.Gio.SocketService` and :obj:`~gi.repository.Gio.SocketConnection`\. However there may be cases where direct use of ``GSocket`` is useful. ``GSocket`` implements the :obj:`~gi.repository.Gio.Initable` interface, so if it is manually constructed by e.g. :obj:`~gi.repository.GObject.Object.new` you must call :obj:`~gi.repository.Gio.Initable.init` and check the results before using the object. This is done automatically in :obj:`~gi.repository.Gio.Socket.new` and :obj:`~gi.repository.Gio.Socket.new_from_fd`\, so these functions can return ``NULL``\. Sockets operate in two general modes, blocking or non-blocking. When in blocking mode all operations (which don’t take an explicit blocking parameter) block until the requested operation is finished or there is an error. In non-blocking mode all calls that would block return immediately with a ``G_IO_ERROR_WOULD_BLOCK`` error. To know when a call would successfully run you can call :obj:`~gi.repository.Gio.Socket.condition_check`\, or :obj:`~gi.repository.Gio.Socket.condition_wait`\. You can also use :obj:`~gi.repository.Gio.Socket.create_source` and attach it to a :obj:`~gi.repository.GLib.MainContext` to get callbacks when I/O is possible. Note that all sockets are always set to non blocking mode in the system, and blocking mode is emulated in ``GSocket``\. When working in non-blocking mode applications should always be able to handle getting a ``G_IO_ERROR_WOULD_BLOCK`` error even when some other function said that I/O was possible. This can easily happen in case of a race condition in the application, but it can also happen for other reasons. For instance, on Windows a socket is always seen as writable until a write returns ``G_IO_ERROR_WOULD_BLOCK``\. ``GSocket``\s can be either connection oriented or datagram based. For connection oriented types you must first establish a connection by either connecting to an address or accepting a connection from another address. For connectionless socket types the target/source address is specified or received in each I/O operation. All socket file descriptors are set to be close-on-exec. Note that creating a ``GSocket`` causes the signal ``SIGPIPE`` to be ignored for the remainder of the program. If you are writing a command-line utility that uses ``GSocket``\, you may need to take into account the fact that your program will not automatically be killed if it tries to write to ``stdout`` after it has been closed. Like most other APIs in GLib, ``GSocket`` is not inherently thread safe. To use a ``GSocket`` concurrently from multiple threads, you must implement your own locking. Nagle’s algorithm -------------------------------------------------------------------------------- Since GLib 2.80, ``GSocket`` will automatically set the ``TCP_NODELAY`` option on all ``G_SOCKET_TYPE_STREAM`` sockets. This disables `Nagle’s algorithm `__ as it typically does more harm than good on modern networks. If your application needs Nagle’s algorithm enabled, call :obj:`~gi.repository.Gio.Socket.set_option` after constructing a ``GSocket`` to enable it: .. code-block:: c :dedent: socket = g_socket_new (…, G_SOCKET_TYPE_STREAM, …); if (socket != NULL) { g_socket_set_option (socket, IPPROTO_TCP, TCP_NODELAY, FALSE, &local_error); // handle error if needed } Constructors ------------ .. rst-class:: interim-class .. class:: Socket :no-index: .. classmethod:: new(family: ~gi.repository.Gio.SocketFamily, type: ~gi.repository.Gio.SocketType, protocol: ~gi.repository.Gio.SocketProtocol) -> ~gi.repository.Gio.Socket Creates a new :obj:`~gi.repository.Gio.Socket` with the defined family, type and protocol. If ``protocol`` is 0 (:const:`~gi.repository.Gio.SocketProtocol.DEFAULT`) the default protocol type for the family and type is used. The ``protocol`` is a family and type specific int that specifies what kind of protocol to use. :obj:`~gi.repository.Gio.SocketProtocol` lists several common ones. Many families only support one protocol, and use 0 for this, others support several and using 0 means to use the default protocol for the family and type. The protocol id is passed directly to the operating system, so you can use protocols not listed in :obj:`~gi.repository.Gio.SocketProtocol` if you know the protocol number used for it. .. versionadded:: 2.22 :param family: the socket family to use, e.g. :const:`~gi.repository.Gio.SocketFamily.IPV4`. :param type: the socket type to use. :param protocol: the id of the protocol to use, or 0 for default. .. classmethod:: new_from_fd(fd: int) -> ~gi.repository.Gio.Socket Creates a new :obj:`~gi.repository.Gio.Socket` from a native file descriptor or winsock SOCKET handle. This reads all the settings from the file descriptor so that all properties should work. Note that the file descriptor will be set to non-blocking mode, independent on the blocking mode of the :obj:`~gi.repository.Gio.Socket`\. On success, the returned :obj:`~gi.repository.Gio.Socket` takes ownership of ``fd``\. On failure, the caller must close ``fd`` themselves. Since GLib 2.46, it is no longer a fatal error to call this on a non-socket descriptor. Instead, a GError will be set with code :const:`~gi.repository.Gio.IOErrorEnum.FAILED` .. versionadded:: 2.22 :param fd: a native socket file descriptor. Methods ------- .. rst-class:: interim-class .. class:: Socket :no-index: .. method:: accept(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Gio.Socket Accept incoming connections on a connection-based socket. This removes the first outstanding connection request from the listening socket and creates a :obj:`~gi.repository.Gio.Socket` object for it. The ``socket`` must be bound to a local address with :func:`~gi.repository.Gio.Socket.bind` and must be listening for incoming connections (:func:`~gi.repository.Gio.Socket.listen`). If there are no outstanding connections then the operation will block or return :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` if non-blocking I/O is enabled. To be notified of an incoming connection, wait for the %G_IO_IN condition. .. versionadded:: 2.22 :param cancellable: a %GCancellable or :const:`None` .. method:: bind(address: ~gi.repository.Gio.SocketAddress, allow_reuse: bool) -> bool When a socket is created it is attached to an address family, but it doesn't have an address in this family. :func:`~gi.repository.Gio.Socket.bind` assigns the address (sometimes called name) of the socket. It is generally required to bind to a local address before you can receive connections. (See :func:`~gi.repository.Gio.Socket.listen` and :func:`~gi.repository.Gio.Socket.accept` ). In certain situations, you may also want to bind a socket that will be used to initiate connections, though this is not normally required. If ``socket`` is a TCP socket, then ``allow_reuse`` controls the setting of the ``SO_REUSEADDR`` socket option; normally it should be :const:`True` for server sockets (sockets that you will eventually call :func:`~gi.repository.Gio.Socket.accept` on), and :const:`False` for client sockets. (Failing to set this flag on a server socket may cause :func:`~gi.repository.Gio.Socket.bind` to return :const:`~gi.repository.Gio.IOErrorEnum.ADDRESS_IN_USE` if the server program is stopped and then immediately restarted.) If ``socket`` is a UDP socket, then ``allow_reuse`` determines whether or not other UDP sockets can be bound to the same address at the same time. In particular, you can have several UDP sockets bound to the same address, and they will all receive all of the multicast and broadcast packets sent to that address. (The behavior of unicast UDP packets to an address with multiple listeners is not defined.) .. versionadded:: 2.22 :param address: a :obj:`~gi.repository.Gio.SocketAddress` specifying the local address. :param allow_reuse: whether to allow reusing this address .. method:: check_connect_result() -> bool Checks and resets the pending connect error for the socket. This is used to check for errors when :func:`~gi.repository.Gio.Socket.connect` is used in non-blocking mode. .. versionadded:: 2.22 .. method:: close() -> bool Closes the socket, shutting down any active connection. Closing a socket does not wait for all outstanding I/O operations to finish, so the caller should not rely on them to be guaranteed to complete even if the close returns with no error. Once the socket is closed, all other operations will return :const:`~gi.repository.Gio.IOErrorEnum.CLOSED`. Closing a socket multiple times will not return an error. Sockets will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible. Beware that due to the way that TCP works, it is possible for recently-sent data to be lost if either you close a socket while the %G_IO_IN condition is set, or else if the remote connection tries to send something to you after you close the socket but before it has finished reading all of the data you sent. There is no easy generic way to avoid this problem; the easiest fix is to design the network protocol such that the client will never send data "out of turn". Another solution is for the server to half-close the connection by calling :func:`~gi.repository.Gio.Socket.shutdown` with only the ``shutdown_write`` flag set, and then wait for the client to notice this and close its side of the connection, after which the server can safely call :func:`~gi.repository.Gio.Socket.close`. (This is what :obj:`~gi.repository.Gio.TcpConnection` does if you call :func:`~gi.repository.Gio.TcpConnection.set_graceful_disconnect`. But of course, this only works if the client will close its connection after the server does.) .. versionadded:: 2.22 .. method:: condition_check(condition: ~gi.repository.GLib.IOCondition) -> ~gi.repository.GLib.IOCondition Checks on the readiness of ``socket`` to perform operations. The operations specified in ``condition`` are checked for and masked against the currently-satisfied conditions on ``socket``\. The result is returned. Note that on Windows, it is possible for an operation to return :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` even immediately after :func:`~gi.repository.Gio.Socket.condition_check` has claimed that the socket is ready for writing. Rather than calling :func:`~gi.repository.Gio.Socket.condition_check` and then writing to the socket if it succeeds, it is generally better to simply try writing to the socket right away, and try again later if the initial attempt returns :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK`. It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition; these conditions will always be set in the output if they are true. This call never blocks. .. versionadded:: 2.22 :param condition: a :obj:`~gi.repository.GLib.IOCondition` mask to check .. method:: condition_timed_wait(condition: ~gi.repository.GLib.IOCondition, timeout_us: int, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Waits for up to ``timeout_us`` microseconds for ``condition`` to become true on ``socket``\. If the condition is met, :const:`True` is returned. If ``cancellable`` is cancelled before the condition is met, or if ``timeout_us`` (or the socket's :obj:`~gi.repository.Gio.Socket`\:timeout) is reached before the condition is met, then :const:`False` is returned and ``error``\, if non-:const:`None`, is set to the appropriate value (:const:`~gi.repository.Gio.IOErrorEnum.CANCELLED` or :const:`~gi.repository.Gio.IOErrorEnum.TIMED_OUT`). If you don't want a timeout, use :func:`~gi.repository.Gio.Socket.condition_wait`. (Alternatively, you can pass -1 for ``timeout_us``\.) Note that although ``timeout_us`` is in microseconds for consistency with other GLib APIs, this function actually only has millisecond resolution, and the behavior is undefined if ``timeout_us`` is not an exact number of milliseconds. .. versionadded:: 2.32 :param condition: a :obj:`~gi.repository.GLib.IOCondition` mask to wait for :param timeout_us: the maximum time (in microseconds) to wait, or -1 :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`\, or :const:`None` .. method:: condition_wait(condition: ~gi.repository.GLib.IOCondition, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Waits for ``condition`` to become true on ``socket``\. When the condition is met, :const:`True` is returned. If ``cancellable`` is cancelled before the condition is met, or if the socket has a timeout set and it is reached before the condition is met, then :const:`False` is returned and ``error``\, if non-:const:`None`, is set to the appropriate value (:const:`~gi.repository.Gio.IOErrorEnum.CANCELLED` or :const:`~gi.repository.Gio.IOErrorEnum.TIMED_OUT`). See also :func:`~gi.repository.Gio.Socket.condition_timed_wait`. .. versionadded:: 2.22 :param condition: a :obj:`~gi.repository.GLib.IOCondition` mask to wait for :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`\, or :const:`None` .. method:: connect(address: ~gi.repository.Gio.SocketAddress, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool Connect the socket to the specified remote address. For connection oriented socket this generally means we attempt to make a connection to the ``address``\. For a connection-less socket it sets the default address for :func:`~gi.repository.Gio.Socket.send` and discards all incoming datagrams from other sources. Generally connection oriented sockets can only connect once, but connection-less sockets can connect multiple times to change the default address. If the connect call needs to do network I/O it will block, unless non-blocking I/O is enabled. Then :const:`~gi.repository.Gio.IOErrorEnum.PENDING` is returned and the user can be notified of the connection finishing by waiting for the G_IO_OUT condition. The result of the connection must then be checked with :func:`~gi.repository.Gio.Socket.check_connect_result`. .. versionadded:: 2.22 :param address: a :obj:`~gi.repository.Gio.SocketAddress` specifying the remote address. :param cancellable: a %GCancellable or :const:`None` .. method:: connection_factory_create_connection() -> ~gi.repository.Gio.SocketConnection Creates a :obj:`~gi.repository.Gio.SocketConnection` subclass of the right type for ``socket``\. .. versionadded:: 2.22 .. method:: get_available_bytes() -> int Get the amount of data pending in the OS input buffer, without blocking. If ``socket`` is a UDP or SCTP socket, this will return the size of just the next packet, even if additional packets are buffered after that one. Note that on Windows, this function is rather inefficient in the UDP case, and so if you know any plausible upper bound on the size of the incoming packet, it is better to just do a :func:`~gi.repository.Gio.Socket.receive` with a buffer of that size, rather than calling :func:`~gi.repository.Gio.Socket.get_available_bytes` first and then doing a receive of exactly the right size. .. versionadded:: 2.32 .. method:: get_blocking() -> bool Gets the blocking mode of the socket. For details on blocking I/O, see :func:`~gi.repository.Gio.Socket.set_blocking`. .. versionadded:: 2.22 .. method:: get_broadcast() -> bool Gets the broadcast setting on ``socket``\; if :const:`True`, it is possible to send packets to broadcast addresses. .. versionadded:: 2.32 .. method:: get_credentials() -> ~gi.repository.Gio.Credentials Returns the credentials of the foreign process connected to this socket, if any (e.g. it is only supported for :const:`~gi.repository.Gio.SocketFamily.UNIX` sockets). If this operation isn't supported on the OS, the method fails with the :const:`~gi.repository.Gio.IOErrorEnum.NOT_SUPPORTED` error. On Linux this is implemented by reading the %SO_PEERCRED option on the underlying socket. This method can be expected to be available on the following platforms: - Linux since GLib 2.26 - OpenBSD since GLib 2.30 - Solaris, Illumos and OpenSolaris since GLib 2.40 - NetBSD since GLib 2.42 - macOS, tvOS, iOS since GLib 2.66 Other ways to obtain credentials from a foreign peer includes the :obj:`~gi.repository.Gio.UnixCredentialsMessage` type and :func:`~gi.repository.Gio.UnixConnection.send_credentials` / :func:`~gi.repository.Gio.UnixConnection.receive_credentials` functions. .. versionadded:: 2.26 .. method:: get_family() -> ~gi.repository.Gio.SocketFamily Gets the socket family of the socket. .. versionadded:: 2.22 .. method:: get_fd() -> int Returns the underlying OS socket object. On unix this is a socket file descriptor, and on Windows this is a Winsock2 SOCKET handle. This may be useful for doing platform specific or otherwise unusual operations on the socket. .. versionadded:: 2.22 .. method:: get_keepalive() -> bool Gets the keepalive mode of the socket. For details on this, see :func:`~gi.repository.Gio.Socket.set_keepalive`. .. versionadded:: 2.22 .. method:: get_listen_backlog() -> int Gets the listen backlog setting of the socket. For details on this, see :func:`~gi.repository.Gio.Socket.set_listen_backlog`. .. versionadded:: 2.22 .. method:: get_local_address() -> ~gi.repository.Gio.SocketAddress Try to get the local address of a bound socket. This is only useful if the socket has been bound to a local address, either explicitly or implicitly when connecting. .. versionadded:: 2.22 .. method:: get_multicast_loopback() -> bool Gets the multicast loopback setting on ``socket``\; if :const:`True` (the default), outgoing multicast packets will be looped back to multicast listeners on the same host. .. versionadded:: 2.32 .. method:: get_multicast_ttl() -> int Gets the multicast time-to-live setting on ``socket``\; see :func:`~gi.repository.Gio.Socket.set_multicast_ttl` for more details. .. versionadded:: 2.32 .. method:: get_option(level: int, optname: int) -> ~typing.Tuple[bool, int] Gets the value of an integer-valued option on ``socket``\, as with getsockopt(). (If you need to fetch a non-integer-valued option, you will need to call getsockopt() directly.) The ````` `__ header pulls in system headers that will define most of the standard/portable socket options. For unusual socket protocols or platform-dependent options, you may need to include additional headers. Note that even for socket options that are a single byte in size, ``value`` is still a pointer to a :obj:`int` variable, not a :obj:`~gi.repository.guint8`\; :func:`~gi.repository.Gio.Socket.get_option` will handle the conversion internally. .. versionadded:: 2.36 :param level: the "API level" of the option (eg, ``SOL_SOCKET``\) :param optname: the "name" of the option (eg, ``SO_BROADCAST``\) .. method:: get_protocol() -> ~gi.repository.Gio.SocketProtocol Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned. .. versionadded:: 2.22 .. method:: get_remote_address() -> ~gi.repository.Gio.SocketAddress Try to get the remote address of a connected socket. This is only useful for connection oriented sockets that have been connected. .. versionadded:: 2.22 .. method:: get_socket_type() -> ~gi.repository.Gio.SocketType Gets the socket type of the socket. .. versionadded:: 2.22 .. method:: get_timeout() -> int Gets the timeout setting of the socket. For details on this, see :func:`~gi.repository.Gio.Socket.set_timeout`. .. versionadded:: 2.26 .. method:: get_ttl() -> int Gets the unicast time-to-live setting on ``socket``\; see :func:`~gi.repository.Gio.Socket.set_ttl` for more details. .. versionadded:: 2.32 .. method:: is_closed() -> bool Checks whether a socket is closed. .. versionadded:: 2.22 .. method:: is_connected() -> bool Check whether the socket is connected. This is only useful for connection-oriented sockets. If using :func:`~gi.repository.Gio.Socket.shutdown`, this function will return :const:`True` until the socket has been shut down for reading and writing. If you do a non-blocking connect, this function will not return :const:`True` until after you call :func:`~gi.repository.Gio.Socket.check_connect_result`. .. versionadded:: 2.22 .. method:: join_multicast_group(group: ~gi.repository.Gio.InetAddress, source_specific: bool, iface: str | None = None) -> bool Registers ``socket`` to receive multicast messages sent to ``group``\. ``socket`` must be a :const:`~gi.repository.Gio.SocketType.DATAGRAM` socket, and must have been bound to an appropriate interface and port with :func:`~gi.repository.Gio.Socket.bind`. If ``iface`` is :const:`None`, the system will automatically pick an interface to bind to based on ``group``\. If ``source_specific`` is :const:`True`, source-specific multicast as defined in RFC 4604 is used. Note that on older platforms this may fail with a :const:`~gi.repository.Gio.IOErrorEnum.NOT_SUPPORTED` error. To bind to a given source-specific multicast address, use :func:`~gi.repository.Gio.Socket.join_multicast_group_ssm` instead. .. versionadded:: 2.32 :param group: a :obj:`~gi.repository.Gio.InetAddress` specifying the group address to join. :param source_specific: :const:`True` if source-specific multicast should be used :param iface: Name of the interface to use, or :const:`None` .. method:: join_multicast_group_ssm(group: ~gi.repository.Gio.InetAddress, source_specific: ~gi.repository.Gio.InetAddress | None = None, iface: str | None = None) -> bool Registers ``socket`` to receive multicast messages sent to ``group``\. ``socket`` must be a :const:`~gi.repository.Gio.SocketType.DATAGRAM` socket, and must have been bound to an appropriate interface and port with :func:`~gi.repository.Gio.Socket.bind`. If ``iface`` is :const:`None`, the system will automatically pick an interface to bind to based on ``group``\. If ``source_specific`` is not :const:`None`, use source-specific multicast as defined in RFC 4604. Note that on older platforms this may fail with a :const:`~gi.repository.Gio.IOErrorEnum.NOT_SUPPORTED` error. Note that this function can be called multiple times for the same ``group`` with different ``source_specific`` in order to receive multicast packets from more than one source. .. versionadded:: 2.56 :param group: a :obj:`~gi.repository.Gio.InetAddress` specifying the group address to join. :param source_specific: a :obj:`~gi.repository.Gio.InetAddress` specifying the source-specific multicast address or :const:`None` to ignore. :param iface: Name of the interface to use, or :const:`None` .. method:: leave_multicast_group(group: ~gi.repository.Gio.InetAddress, source_specific: bool, iface: str | None = None) -> bool Removes ``socket`` from the multicast group defined by ``group``\, ``iface``\, and ``source_specific`` (which must all have the same values they had when you joined the group). ``socket`` remains bound to its address and port, and can still receive unicast messages after calling this. To unbind to a given source-specific multicast address, use :func:`~gi.repository.Gio.Socket.leave_multicast_group_ssm` instead. .. versionadded:: 2.32 :param group: a :obj:`~gi.repository.Gio.InetAddress` specifying the group address to leave. :param source_specific: :const:`True` if source-specific multicast was used :param iface: Interface used .. method:: leave_multicast_group_ssm(group: ~gi.repository.Gio.InetAddress, source_specific: ~gi.repository.Gio.InetAddress | None = None, iface: str | None = None) -> bool Removes ``socket`` from the multicast group defined by ``group``\, ``iface``\, and ``source_specific`` (which must all have the same values they had when you joined the group). ``socket`` remains bound to its address and port, and can still receive unicast messages after calling this. .. versionadded:: 2.56 :param group: a :obj:`~gi.repository.Gio.InetAddress` specifying the group address to leave. :param source_specific: a :obj:`~gi.repository.Gio.InetAddress` specifying the source-specific multicast address or :const:`None` to ignore. :param iface: Name of the interface to use, or :const:`None` .. method:: listen() -> bool Marks the socket as a server socket, i.e. a socket that is used to accept incoming requests using :func:`~gi.repository.Gio.Socket.accept`. Before calling this the socket must be bound to a local address using :func:`~gi.repository.Gio.Socket.bind`. To set the maximum amount of outstanding clients, use :func:`~gi.repository.Gio.Socket.set_listen_backlog`. .. versionadded:: 2.22 .. method:: receive(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~typing.Tuple[int, list[int]] Receive data (up to ``size`` bytes) from a socket. This is mainly used by connection-oriented sockets; it is identical to :func:`~gi.repository.Gio.Socket.receive_from` with ``address`` set to :const:`None`. For :const:`~gi.repository.Gio.SocketType.DATAGRAM` and :const:`~gi.repository.Gio.SocketType.SEQPACKET` sockets, :func:`~gi.repository.Gio.Socket.receive` will always read either 0 or 1 complete messages from the socket. If the received message is too large to fit in ``buffer``\, then the data beyond ``size`` bytes will be discarded, without any explicit indication that this has occurred. For :const:`~gi.repository.Gio.SocketType.STREAM` sockets, :func:`~gi.repository.Gio.Socket.receive` can return any number of bytes, up to ``size``\. If more than ``size`` bytes have been received, the additional data will be returned in future calls to :func:`~gi.repository.Gio.Socket.receive`. If the socket is in blocking mode the call will block until there is some data to receive, the connection is closed, or there is an error. If there is no data available and the socket is in non-blocking mode, a :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` error will be returned. To be notified when data is available, wait for the %G_IO_IN condition. On error -1 is returned and ``error`` is set accordingly. .. versionadded:: 2.22 :param cancellable: a %GCancellable or :const:`None` .. method:: receive_bytes(size: int, timeout_us: int, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.GLib.Bytes Receives data (up to ``size`` bytes) from a socket. This function is a variant of :obj:`~gi.repository.Gio.Socket.receive` which returns a :obj:`~gi.repository.GLib.Bytes` rather than a plain buffer. Pass ``-1`` to ``timeout_us`` to block indefinitely until data is received (or the connection is closed, or there is an error). Pass ``0`` to use the default timeout from :obj:`~gi.repository.Gio.Socket.props.timeout`\, or pass a positive number to wait for that many microseconds for data before returning ``G_IO_ERROR_TIMED_OUT``\. .. versionadded:: 2.80 :param size: the number of bytes you want to read from the socket :param timeout_us: the timeout to wait for, in microseconds, or ``-1`` to block indefinitely :param cancellable: a %GCancellable, or ``NULL`` .. method:: receive_bytes_from(size: int, timeout_us: int, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~typing.Tuple[~gi.repository.GLib.Bytes, ~gi.repository.Gio.SocketAddress] Receive data (up to ``size`` bytes) from a socket. This function is a variant of :obj:`~gi.repository.Gio.Socket.receive_from` which returns a :obj:`~gi.repository.GLib.Bytes` rather than a plain buffer. If ``address`` is non-:const:`None` then ``address`` will be set equal to the source address of the received packet. The ``address`` is owned by the caller. Pass ``-1`` to ``timeout_us`` to block indefinitely until data is received (or the connection is closed, or there is an error). Pass ``0`` to use the default timeout from :obj:`~gi.repository.Gio.Socket.props.timeout`\, or pass a positive number to wait for that many microseconds for data before returning ``G_IO_ERROR_TIMED_OUT``\. .. versionadded:: 2.80 :param size: the number of bytes you want to read from the socket :param timeout_us: the timeout to wait for, in microseconds, or ``-1`` to block indefinitely :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`\, or ``NULL`` .. method:: receive_from(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~typing.Tuple[int, ~gi.repository.Gio.SocketAddress, list[int]] Receive data (up to ``size`` bytes) from a socket. If ``address`` is non-:const:`None` then ``address`` will be set equal to the source address of the received packet. ``address`` is owned by the caller. See :func:`~gi.repository.Gio.Socket.receive` for additional information. .. versionadded:: 2.22 :param cancellable: a %GCancellable or :const:`None` .. method:: receive_message(vectors: list[~gi.repository.Gio.InputVector], flags: int, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~typing.Tuple[int, ~gi.repository.Gio.SocketAddress, list[~gi.repository.Gio.SocketControlMessage] | None, int] Receive data from a socket. For receiving multiple messages, see :func:`~gi.repository.Gio.Socket.receive_messages`; for easier use, see :func:`~gi.repository.Gio.Socket.receive` and :func:`~gi.repository.Gio.Socket.receive_from`. If ``address`` is non-:const:`None` then ``address`` will be set equal to the source address of the received packet. ``address`` is owned by the caller. ``vector`` must point to an array of :obj:`~gi.repository.Gio.InputVector` structs and ``num_vectors`` must be the length of this array. These structs describe the buffers that received data will be scattered into. If ``num_vectors`` is -1, then ``vectors`` is assumed to be terminated by a :obj:`~gi.repository.Gio.InputVector` with a :const:`None` buffer pointer. As a special case, if ``num_vectors`` is 0 (in which case, ``vectors`` may of course be :const:`None`), then a single byte is received and discarded. This is to facilitate the common practice of sending a single '\0' byte for the purposes of transferring ancillary data. ``messages``\, if non-:const:`None`, will be set to point to a newly-allocated array of :obj:`~gi.repository.Gio.SocketControlMessage` instances or :const:`None` if no such messages was received. These correspond to the control messages received from the kernel, one :obj:`~gi.repository.Gio.SocketControlMessage` per message from the kernel. This array is :const:`None`-terminated and must be freed by the caller using :func:`~gi.repository.GLib.free` after calling :func:`~gi.repository.GObject.GObject.Object.unref` on each element. If ``messages`` is :const:`None`, any control messages received will be discarded. ``num_messages``\, if non-:const:`None`, will be set to the number of control messages received. If both ``messages`` and ``num_messages`` are non-:const:`None`, then ``num_messages`` gives the number of :obj:`~gi.repository.Gio.SocketControlMessage` instances in ``messages`` (ie: not including the :const:`None` terminator). ``flags`` is an in/out parameter. The commonly available arguments for this are available in the ``GSocketMsgFlags`` enum, but the values there are the same as the system values, and the flags are passed in as-is, so you can pass in system-specific flags too (and :func:`~gi.repository.Gio.Socket.receive_message` may pass system-specific flags out). Flags passed in to the parameter affect the receive operation; flags returned out of it are relevant to the specific returned message. As with :func:`~gi.repository.Gio.Socket.receive`, data may be discarded if ``socket`` is :const:`~gi.repository.Gio.SocketType.DATAGRAM` or :const:`~gi.repository.Gio.SocketType.SEQPACKET` and you do not provide enough buffer space to read a complete message. You can pass :const:`~gi.repository.Gio.SocketMsgFlags.PEEK` in ``flags`` to peek at the current message without removing it from the receive queue, but there is no portable way to find out the length of the message other than by reading it into a sufficiently-large buffer. If the socket is in blocking mode the call will block until there is some data to receive, the connection is closed, or there is an error. If there is no data available and the socket is in non-blocking mode, a :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` error will be returned. To be notified when data is available, wait for the %G_IO_IN condition. On error -1 is returned and ``error`` is set accordingly. .. versionadded:: 2.22 :param vectors: an array of :obj:`~gi.repository.Gio.InputVector` structs :param flags: a pointer to an int containing ``GSocketMsgFlags`` flags, which may additionally contain `other platform specific flags `__ :param cancellable: a %GCancellable or :const:`None` .. method:: receive_messages(messages: list[~gi.repository.Gio.InputMessage], flags: int, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> int Receive multiple data messages from ``socket`` in one go. This is the most complicated and fully-featured version of this call. For easier use, see :func:`~gi.repository.Gio.Socket.receive`, :func:`~gi.repository.Gio.Socket.receive_from`, and :func:`~gi.repository.Gio.Socket.receive_message`. ``messages`` must point to an array of :obj:`~gi.repository.Gio.InputMessage` structs and ``num_messages`` must be the length of this array. Each :obj:`~gi.repository.Gio.InputMessage` contains a pointer to an array of :obj:`~gi.repository.Gio.InputVector` structs describing the buffers that the data received in each message will be written to. Using multiple :obj:`~gi.repository.Gio.InputVector` is more memory-efficient than manually copying data out of a single buffer to multiple sources, and more system-call-efficient than making multiple calls to :func:`~gi.repository.Gio.Socket.receive`, such as in scenarios where a lot of data packets need to be received (e.g. high-bandwidth video streaming over RTP/UDP). ``flags`` modify how all messages are received. The commonly available arguments for this are available in the ``GSocketMsgFlags`` enum, but the values there are the same as the system values, and the flags are passed in as-is, so you can pass in system-specific flags too. These flags affect the overall receive operation. Flags affecting individual messages are returned in :obj:`~gi.repository.Gio.InputMessage`\.flags. The other members of :obj:`~gi.repository.Gio.InputMessage` are treated as described in its documentation. If :obj:`~gi.repository.Gio.Socket`\:blocking is :const:`True` the call will block until ``num_messages`` have been received, or the end of the stream is reached. If :obj:`~gi.repository.Gio.Socket`\:blocking is :const:`False` the call will return up to ``num_messages`` without blocking, or :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` if no messages are queued in the operating system to be received. In blocking mode, if :obj:`~gi.repository.Gio.Socket`\:timeout is positive and is reached before any messages are received, :const:`~gi.repository.Gio.IOErrorEnum.TIMED_OUT` is returned, otherwise up to ``num_messages`` are returned. (Note: This is effectively the behaviour of ``MSG_WAITFORONE`` with recvmmsg().) To be notified when messages are available, wait for the %G_IO_IN condition. Note though that you may still receive :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` from :func:`~gi.repository.Gio.Socket.receive_messages` even if you were previously notified of a %G_IO_IN condition. If the remote peer closes the connection, any messages queued in the operating system will be returned, and subsequent calls to :func:`~gi.repository.Gio.Socket.receive_messages` will return 0 (with no error set). On error -1 is returned and ``error`` is set accordingly. An error will only be returned if zero messages could be received; otherwise the number of messages successfully received before the error will be returned. .. versionadded:: 2.48 :param messages: an array of :obj:`~gi.repository.Gio.InputMessage` structs :param flags: an int containing ``GSocketMsgFlags`` flags for the overall operation, which may additionally contain `other platform specific flags `__ :param cancellable: a %GCancellable or :const:`None` .. method:: receive_with_blocking(blocking: bool, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~typing.Tuple[int, list[int]] This behaves exactly the same as :func:`~gi.repository.Gio.Socket.receive`, except that the choice of blocking or non-blocking behavior is determined by the ``blocking`` argument rather than by ``socket``\'s properties. .. versionadded:: 2.26 :param blocking: whether to do blocking or non-blocking I/O :param cancellable: a %GCancellable or :const:`None` .. method:: send(buffer: list[int], cancellable: ~gi.repository.Gio.Cancellable | None = None) -> int Tries to send ``size`` bytes from ``buffer`` on the socket. This is mainly used by connection-oriented sockets; it is identical to :func:`~gi.repository.Gio.Socket.send_to` with ``address`` set to :const:`None`. If the socket is in blocking mode the call will block until there is space for the data in the socket queue. If there is no space available and the socket is in non-blocking mode a :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` error will be returned. To be notified when space is available, wait for the %G_IO_OUT condition. Note though that you may still receive :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` from :func:`~gi.repository.Gio.Socket.send` even if you were previously notified of a %G_IO_OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.) On error -1 is returned and ``error`` is set accordingly. .. versionadded:: 2.22 :param buffer: the buffer containing the data to send. :param cancellable: a %GCancellable or :const:`None` .. method:: send_message(address: ~gi.repository.Gio.SocketAddress | None, vectors: list[~gi.repository.Gio.OutputVector], messages: list[~gi.repository.Gio.SocketControlMessage] | None, flags: int, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> int Send data to ``address`` on ``socket``\. For sending multiple messages see :func:`~gi.repository.Gio.Socket.send_messages`; for easier use, see :func:`~gi.repository.Gio.Socket.send` and :func:`~gi.repository.Gio.Socket.send_to`. If ``address`` is :const:`None` then the message is sent to the default receiver (set by :func:`~gi.repository.Gio.Socket.connect`). ``vectors`` must point to an array of :obj:`~gi.repository.Gio.OutputVector` structs and ``num_vectors`` must be the length of this array. (If ``num_vectors`` is -1, then ``vectors`` is assumed to be terminated by a :obj:`~gi.repository.Gio.OutputVector` with a :const:`None` buffer pointer.) The :obj:`~gi.repository.Gio.OutputVector` structs describe the buffers that the sent data will be gathered from. Using multiple :obj:`~gi.repository.Gio.OutputVector` is more memory-efficient than manually copying data from multiple sources into a single buffer, and more network-efficient than making multiple calls to :func:`~gi.repository.Gio.Socket.send`. ``messages``\, if non-:const:`None`, is taken to point to an array of ``num_messages`` :obj:`~gi.repository.Gio.SocketControlMessage` instances. These correspond to the control messages to be sent on the socket. If ``num_messages`` is -1 then ``messages`` is treated as a :const:`None`-terminated array. ``flags`` modify how the message is sent. The commonly available arguments for this are available in the ``GSocketMsgFlags`` enum, but the values there are the same as the system values, and the flags are passed in as-is, so you can pass in system-specific flags too. If the socket is in blocking mode the call will block until there is space for the data in the socket queue. If there is no space available and the socket is in non-blocking mode a :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` error will be returned. To be notified when space is available, wait for the %G_IO_OUT condition. Note though that you may still receive :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` from :func:`~gi.repository.Gio.Socket.send` even if you were previously notified of a %G_IO_OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.) The sum of the sizes of each :obj:`~gi.repository.Gio.OutputVector` in vectors must not be greater than %G_MAXSSIZE. If the message can be larger than this, then it is mandatory to use the :func:`~gi.repository.Gio.Socket.send_message_with_timeout` function. On error -1 is returned and ``error`` is set accordingly. .. versionadded:: 2.22 :param address: a :obj:`~gi.repository.Gio.SocketAddress`\, or :const:`None` :param vectors: an array of :obj:`~gi.repository.Gio.OutputVector` structs :param messages: a pointer to an array of :obj:`~gi.repository.Gio.SocketControlMessage`\, or :const:`None`. :param flags: an int containing ``GSocketMsgFlags`` flags, which may additionally contain `other platform specific flags `__ :param cancellable: a %GCancellable or :const:`None` .. method:: send_message_with_timeout(address: ~gi.repository.Gio.SocketAddress | None, vectors: list[~gi.repository.Gio.OutputVector], messages: list[~gi.repository.Gio.SocketControlMessage] | None, flags: int, timeout_us: int, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~typing.Tuple[~gi.repository.Gio.PollableReturn, int] This behaves exactly the same as :func:`~gi.repository.Gio.Socket.send_message`, except that the choice of timeout behavior is determined by the ``timeout_us`` argument rather than by ``socket``\'s properties. On error :const:`~gi.repository.Gio.PollableReturn.FAILED` is returned and ``error`` is set accordingly, or if the socket is currently not writable :const:`~gi.repository.Gio.PollableReturn.WOULD_BLOCK` is returned. ``bytes_written`` will contain 0 in both cases. .. versionadded:: 2.60 :param address: a :obj:`~gi.repository.Gio.SocketAddress`\, or :const:`None` :param vectors: an array of :obj:`~gi.repository.Gio.OutputVector` structs :param messages: a pointer to an array of :obj:`~gi.repository.Gio.SocketControlMessage`\, or :const:`None`. :param flags: an int containing ``GSocketMsgFlags`` flags, which may additionally contain `other platform specific flags `__ :param timeout_us: the maximum time (in microseconds) to wait, or -1 :param cancellable: a %GCancellable or :const:`None` .. method:: send_messages(messages: list[~gi.repository.Gio.OutputMessage], flags: int, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> int Send multiple data messages from ``socket`` in one go. This is the most complicated and fully-featured version of this call. For easier use, see :func:`~gi.repository.Gio.Socket.send`, :func:`~gi.repository.Gio.Socket.send_to`, and :func:`~gi.repository.Gio.Socket.send_message`. ``messages`` must point to an array of :obj:`~gi.repository.Gio.OutputMessage` structs and ``num_messages`` must be the length of this array. Each :obj:`~gi.repository.Gio.OutputMessage` contains an address to send the data to, and a pointer to an array of :obj:`~gi.repository.Gio.OutputVector` structs to describe the buffers that the data to be sent for each message will be gathered from. Using multiple :obj:`~gi.repository.Gio.OutputVector` is more memory-efficient than manually copying data from multiple sources into a single buffer, and more network-efficient than making multiple calls to :func:`~gi.repository.Gio.Socket.send`. Sending multiple messages in one go avoids the overhead of making a lot of syscalls in scenarios where a lot of data packets need to be sent (e.g. high-bandwidth video streaming over RTP/UDP), or where the same data needs to be sent to multiple recipients. ``flags`` modify how the message is sent. The commonly available arguments for this are available in the ``GSocketMsgFlags`` enum, but the values there are the same as the system values, and the flags are passed in as-is, so you can pass in system-specific flags too. If the socket is in blocking mode the call will block until there is space for all the data in the socket queue. If there is no space available and the socket is in non-blocking mode a :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` error will be returned if no data was written at all, otherwise the number of messages sent will be returned. To be notified when space is available, wait for the %G_IO_OUT condition. Note though that you may still receive :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` from :func:`~gi.repository.Gio.Socket.send` even if you were previously notified of a %G_IO_OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.) On error -1 is returned and ``error`` is set accordingly. An error will only be returned if zero messages could be sent; otherwise the number of messages successfully sent before the error will be returned. .. versionadded:: 2.44 :param messages: an array of :obj:`~gi.repository.Gio.OutputMessage` structs :param flags: an int containing ``GSocketMsgFlags`` flags, which may additionally contain `other platform specific flags `__ :param cancellable: a %GCancellable or :const:`None` .. method:: send_to(address: ~gi.repository.Gio.SocketAddress | None, buffer: list[int], cancellable: ~gi.repository.Gio.Cancellable | None = None) -> int Tries to send ``size`` bytes from ``buffer`` to ``address``\. If ``address`` is :const:`None` then the message is sent to the default receiver (set by :func:`~gi.repository.Gio.Socket.connect`). See :func:`~gi.repository.Gio.Socket.send` for additional information. .. versionadded:: 2.22 :param address: a :obj:`~gi.repository.Gio.SocketAddress`\, or :const:`None` :param buffer: the buffer containing the data to send. :param cancellable: a %GCancellable or :const:`None` .. method:: send_with_blocking(buffer: list[int], blocking: bool, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> int This behaves exactly the same as :func:`~gi.repository.Gio.Socket.send`, except that the choice of blocking or non-blocking behavior is determined by the ``blocking`` argument rather than by ``socket``\'s properties. .. versionadded:: 2.26 :param buffer: the buffer containing the data to send. :param blocking: whether to do blocking or non-blocking I/O :param cancellable: a %GCancellable or :const:`None` .. method:: set_blocking(blocking: bool) -> None Sets the blocking mode of the socket. In blocking mode all operations (which don’t take an explicit blocking parameter) block until they succeed or there is an error. In non-blocking mode all functions return results immediately or with a :const:`~gi.repository.Gio.IOErrorEnum.WOULD_BLOCK` error. All sockets are created in blocking mode. However, note that the platform level socket is always non-blocking, and blocking mode is a GSocket level feature. .. versionadded:: 2.22 :param blocking: Whether to use blocking I/O or not. .. method:: set_broadcast(broadcast: bool) -> None Sets whether ``socket`` should allow sending to broadcast addresses. This is :const:`False` by default. .. versionadded:: 2.32 :param broadcast: whether ``socket`` should allow sending to broadcast addresses .. method:: set_keepalive(keepalive: bool) -> None Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When this flag is set on a socket, the system will attempt to verify that the remote socket endpoint is still present if a sufficiently long period of time passes with no data being exchanged. If the system is unable to verify the presence of the remote endpoint, it will automatically close the connection. This option is only functional on certain kinds of sockets. (Notably, :const:`~gi.repository.Gio.SocketProtocol.TCP` sockets.) The exact time between pings is system- and protocol-dependent, but will normally be at least two hours. Most commonly, you would set this flag on a server socket if you want to allow clients to remain idle for long periods of time, but also want to ensure that connections are eventually garbage-collected if clients crash or become unreachable. .. versionadded:: 2.22 :param keepalive: Value for the keepalive flag .. method:: set_listen_backlog(backlog: int) -> None Sets the maximum number of outstanding connections allowed when listening on this socket. If more clients than this are connecting to the socket and the application is not handling them on time then the new connections will be refused. Note that this must be called before :func:`~gi.repository.Gio.Socket.listen` and has no effect if called after that. .. versionadded:: 2.22 :param backlog: the maximum number of pending connections. .. method:: set_multicast_loopback(loopback: bool) -> None Sets whether outgoing multicast packets will be received by sockets listening on that multicast address on the same host. This is :const:`True` by default. .. versionadded:: 2.32 :param loopback: whether ``socket`` should receive messages sent to its multicast groups from the local host .. method:: set_multicast_ttl(ttl: int) -> None Sets the time-to-live for outgoing multicast datagrams on ``socket``\. By default, this is 1, meaning that multicast packets will not leave the local network. .. versionadded:: 2.32 :param ttl: the time-to-live value for all multicast datagrams on ``socket`` .. method:: set_option(level: int, optname: int, value: int) -> bool Sets the value of an integer-valued option on ``socket``\, as with setsockopt(). (If you need to set a non-integer-valued option, you will need to call setsockopt() directly.) The ````` `__ header pulls in system headers that will define most of the standard/portable socket options. For unusual socket protocols or platform-dependent options, you may need to include additional headers. .. versionadded:: 2.36 :param level: the "API level" of the option (eg, ``SOL_SOCKET``\) :param optname: the "name" of the option (eg, ``SO_BROADCAST``\) :param value: the value to set the option to .. method:: set_timeout(timeout: int) -> None Sets the time in seconds after which I/O operations on ``socket`` will time out if they have not yet completed. On a blocking socket, this means that any blocking :obj:`~gi.repository.Gio.Socket` operation will time out after ``timeout`` seconds of inactivity, returning :const:`~gi.repository.Gio.IOErrorEnum.TIMED_OUT`. On a non-blocking socket, calls to :func:`~gi.repository.Gio.Socket.condition_wait` will also fail with :const:`~gi.repository.Gio.IOErrorEnum.TIMED_OUT` after the given time. Sources created with :func:`~gi.repository.Gio.Socket.create_source` will trigger after ``timeout`` seconds of inactivity, with the requested condition set, at which point calling :func:`~gi.repository.Gio.Socket.receive`, :func:`~gi.repository.Gio.Socket.send`, :func:`~gi.repository.Gio.Socket.check_connect_result`, etc, will fail with :const:`~gi.repository.Gio.IOErrorEnum.TIMED_OUT`. If ``timeout`` is 0 (the default), operations will never time out on their own. Note that if an I/O operation is interrupted by a signal, this may cause the timeout to be reset. .. versionadded:: 2.26 :param timeout: the timeout for ``socket``\, in seconds, or 0 for none .. method:: set_ttl(ttl: int) -> None Sets the time-to-live for outgoing unicast packets on ``socket``\. By default the platform-specific default value is used. .. versionadded:: 2.32 :param ttl: the time-to-live value for all unicast packets on ``socket`` .. method:: shutdown(shutdown_read: bool, shutdown_write: bool) -> bool Shut down part or all of a full-duplex connection. If ``shutdown_read`` is :const:`True` then the receiving side of the connection is shut down, and further reading is disallowed. If ``shutdown_write`` is :const:`True` then the sending side of the connection is shut down, and further writing is disallowed. It is allowed for both ``shutdown_read`` and ``shutdown_write`` to be :const:`True`. One example where it is useful to shut down only one side of a connection is graceful disconnect for TCP connections where you close the sending side, then wait for the other side to close the connection, thus ensuring that the other side saw all sent data. .. versionadded:: 2.22 :param shutdown_read: whether to shut down the read side :param shutdown_write: whether to shut down the write side .. method:: speaks_ipv4() -> bool Checks if a socket is capable of speaking IPv4. IPv4 sockets are capable of speaking IPv4. On some operating systems and under some combinations of circumstances IPv6 sockets are also capable of speaking IPv4. See RFC 3493 section 3.7 for more information. No other types of sockets are currently considered as being capable of speaking IPv4. .. versionadded:: 2.22 Properties ---------- .. rst-class:: interim-class .. class:: Socket :no-index: .. attribute:: props.blocking :type: bool The type of the None singleton. .. versionadded:: 2.22 .. attribute:: props.broadcast :type: bool The type of the None singleton. .. versionadded:: 2.32 .. attribute:: props.family :type: ~gi.repository.Gio.SocketFamily The type of the None singleton. .. versionadded:: 2.22 .. attribute:: props.fd :type: int The type of the None singleton. .. versionadded:: 2.22 .. attribute:: props.keepalive :type: bool The type of the None singleton. .. versionadded:: 2.22 .. attribute:: props.listen_backlog :type: int The type of the None singleton. .. versionadded:: 2.22 .. attribute:: props.local_address :type: ~gi.repository.Gio.SocketAddress The type of the None singleton. .. versionadded:: 2.22 .. attribute:: props.multicast_loopback :type: bool The type of the None singleton. .. versionadded:: 2.32 .. attribute:: props.multicast_ttl :type: int The type of the None singleton. .. versionadded:: 2.32 .. attribute:: props.protocol :type: ~gi.repository.Gio.SocketProtocol The type of the None singleton. .. versionadded:: 2.22 .. attribute:: props.remote_address :type: ~gi.repository.Gio.SocketAddress The type of the None singleton. .. versionadded:: 2.22 .. attribute:: props.timeout :type: int The type of the None singleton. .. versionadded:: 2.26 .. attribute:: props.ttl :type: int The type of the None singleton. .. versionadded:: 2.32 .. attribute:: props.type :type: ~gi.repository.Gio.SocketType The type of the None singleton. .. versionadded:: 2.22 Fields ------ .. rst-class:: interim-class .. class:: Socket :no-index: .. attribute:: parent_instance .. attribute:: priv