Gio.SocketControlMessage¶

class — extends GObject.Object

A GSocketControlMessage is a special-purpose utility message that can be sent to or received from a Socket. These types of messages are often called ‘ancillary data’.

The message can represent some sort of special instruction to or information from the socket or can represent a special kind of transfer to the peer (for example, sending a file descriptor over a UNIX socket).

These messages are sent with Socket.send_message and received with Socket.receive_message.

To extend the set of control messages that can be sent, subclass this class and override the get_size, get_level, get_type and serialize methods.

To extend the set of control messages that can be received, subclass this class and implement the deserialize method. Also, make sure your class is registered with the GObject.Type type system before calling Socket.receive_message to read such a message.

Methods¶

get_level¶

def get_level(self) -> int

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

get_msg_type¶

def get_msg_type(self) -> int

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

get_size¶

def get_size(self) -> int

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

serialize¶

def serialize(self, data: int) -> 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 SocketControlMessage.get_size on this object.

Parameters:

data — A buffer to write data to

Static functions¶

deserialize¶

@staticmethod
def deserialize(level: int, type: int, data: list[int]) -> SocketControlMessage | None

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

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

Parameters:

level — a socket level
type — a socket control message type for the given level
data — pointer to the message data

Virtual methods¶

do_get_level¶

def do_get_level(self) -> int

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

do_get_size¶

def do_get_size(self) -> int

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

do_get_type¶

def do_get_type(self) -> int

gets the protocol specific type of the message.

do_serialize¶

def do_serialize(self, data: int) -> 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 SocketControlMessage.get_size on this object.

Parameters:

data — A buffer to write data to