:right-sidebar: True

SocketControlMessage
===================================================================

.. currentmodule:: gi.repository.Gio


.. versionadded:: 2.22




.. class:: SocketControlMessage(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`


Subclasses: :class:`~gi.repository.Gio.UnixCredentialsMessage`, :class:`~gi.repository.Gio.UnixFDMessage`




:Constructors:

::

    SocketControlMessage(**properties)





Methods
-------

.. rst-class:: interim-class

.. class:: SocketControlMessage
   :no-index:


   .. method:: deserialize(level: int, type: int, data: ~typing.Sequence[int]) -> ~gi.repository.Gio.SocketControlMessage | None

      Tries to deserialize a socket control message of a given
      ``level`` and ``type``. This will ask all known (to GType) subclasses
      of :obj:`~gi.repository.Gio.SocketControlMessage` if they can understand this kind
      of message and if so deserialize it into a :obj:`~gi.repository.Gio.SocketControlMessage`.

      If there is no implementation for this kind of control message, :const:`None`
      will be returned.



      .. versionadded:: 2.22





      :param level: a socket level


      :param type: a socket control message type for the given ``level``


      :param data: pointer to the message data





   .. method:: get_level() -> int

      Returns the "level" (i.e. the originating protocol) of the control message.
      This is often SOL_SOCKET.



      .. versionadded:: 2.22








   .. method:: get_msg_type() -> int

      Returns the protocol specific type of the control message.
      For instance, for UNIX fd passing this would be SCM_RIGHTS.



      .. versionadded:: 2.22








   .. method:: get_size() -> int

      Returns the space required for the control message, not including
      headers or alignment.



      .. versionadded:: 2.22








   .. method:: serialize(data: None) -> None

      Converts the data in the message to bytes placed in the
      message.

      ``data`` is guaranteed to have enough space to fit the size
      returned by :func:`~gi.repository.Gio.SocketControlMessage.get_size` on this
      object.



      .. versionadded:: 2.22





      :param data: A buffer to write data to













Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: SocketControlMessage
   :no-index:
   

   .. method:: do_get_level() -> int

      Returns the "level" (i.e. the originating protocol) of the control message.
      This is often SOL_SOCKET.



      .. versionadded:: 2.22








   .. method:: do_get_size() -> int

      Returns the space required for the control message, not including
      headers or alignment.



      .. versionadded:: 2.22








   .. method:: do_get_type() -> int

      gets the protocol specific type of the message.










   .. method:: do_serialize(data: None) -> None

      Converts the data in the message to bytes placed in the
      message.

      ``data`` is guaranteed to have enough space to fit the size
      returned by :func:`~gi.repository.Gio.SocketControlMessage.get_size` on this
      object.



      .. versionadded:: 2.22





      :param data: A buffer to write data to









Fields
------

.. rst-class:: interim-class

.. class:: SocketControlMessage
   :no-index:
   

   .. attribute:: parent_instance

      






   .. attribute:: priv