InputMessage

Added in version 2.48.

class InputMessage(*args, **kwargs)

Structure used for scatter/gather data input when receiving multiple messages or packets in one go. You generally pass in an array of empty InputVector and the operation will use all the buffers as if they were one buffer, and will set bytes_received to the total number of bytes received across all InputVector.

This structure closely mirrors struct mmsghdr and struct msghdr from the POSIX sockets API (see man 2 recvmmsg).

If address is non-None then it is set to the source address the message was received from, and the caller must free it afterwards.

If control_messages is non-None then it is set to an array of control messages received with the message (if any), and the caller must free it afterwards. num_control_messages is set to the number of elements in this array, which may be zero.

Flags relevant to this message will be returned in flags. For example, MSG_EOR or MSG_TRUNC.

Fields

class InputMessage

address

Return location

for a SocketAddress, or None

bytes_received

Will be set to the number of bytes that have been

received

control_messages

Return location for a

caller-allocated array of SocketControlMessage, or None

flags

Collection of GSocketMsgFlags for the received message,

outputted by the call

num_control_messages

Return location for the number of

elements in control_messages

num_vectors

The number of input vectors pointed to by vectors

vectors

Pointer to an

array of input vectors