SocketControlMessage

Added in version 2.22.

class SocketControlMessage(**properties: Any)

Superclasses: Object

Subclasses: UnixCredentialsMessage, UnixFDMessage

Constructors:

SocketControlMessage(**properties)

Methods

class SocketControlMessage

deserialize(level: int, type: int, data: Sequence[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.

Added in version 2.22.

Parameters:

• level – a socket level

• type – a socket control message type for the given level

• data – pointer to the message data

get_level() → int

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

Added in version 2.22.

get_msg_type() → int

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

Added in version 2.22.

get_size() → int

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

Added in version 2.22.

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 get_size() on this object.

Added in version 2.22.

Parameters:

data – A buffer to write data to

Virtual Methods

class SocketControlMessage

do_get_level() → int

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

Added in version 2.22.

do_get_size() → int

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

Added in version 2.22.

do_get_type() → int

gets the protocol specific type of the message.

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 get_size() on this object.

Added in version 2.22.

Parameters:

data – A buffer to write data to

Fields

class SocketControlMessage

parent_instance

priv