Gio.DatagramBased

interface

Interface for socket-like objects with datagram semantics.

A GDatagramBased is a networking interface for representing datagram-based communications. It is a more or less direct mapping of the core parts of the BSD socket API in a portable GObject interface. It is implemented by Socket, which wraps the UNIX socket API on UNIX and winsock2 on Windows.

GDatagramBased is entirely platform independent, and is intended to be used alongside higher-level networking APIs such as IOStream.

It uses vectored scatter/gather I/O by default, allowing for many messages to be sent or received in a single call. Where possible, implementations of the interface should take advantage of vectored I/O to minimise processing or system calls. For example, GSocket uses recvmmsg() and sendmmsg() where possible. Callers should take advantage of scatter/gather I/O (the use of multiple buffers per message) to avoid unnecessary copying of data to assemble or disassemble a message.

Each GDatagramBased operation has a timeout parameter which may be negative for blocking behaviour, zero for non-blocking behaviour, or positive for timeout behaviour. A blocking operation blocks until finished or there is an error. A non-blocking operation will return immediately with a G_IO_ERROR_WOULD_BLOCK error if it cannot make progress. A timeout operation will block until the operation is complete or the timeout expires; if the timeout expires it will return what progress it made, or G_IO_ERROR_TIMED_OUT if no progress was made. To know when a call would successfully run you can call DatagramBased.condition_check or DatagramBased.condition_wait. You can also use DatagramBased.create_source and attach it to a GLib.MainContext to get callbacks when I/O is possible.

When running a non-blocking operation 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.

As with GSocket, GDatagramBaseds can be either connection oriented (for example, SCTP) or connectionless (for example, UDP). GDatagramBaseds must be datagram-based, not stream-based. The interface does not cover connection establishment — use methods on the underlying type to establish a connection before sending and receiving data through the GDatagramBased API. For connectionless socket types the target/source address is specified or received in each I/O operation.

Like most other APIs in GLib, GDatagramBased is not inherently thread safe. To use a GDatagramBased concurrently from multiple threads, you must implement your own locking.

Methods

condition_check

def condition_check(self, condition: GLib.IOCondition | int) -> GLib.IOCondition

Checks on the readiness of datagram_based to perform operations. The operations specified in condition are checked for and masked against the currently-satisfied conditions on datagram_based. The result is returned.

GObject.IOCondition.IN will be set in the return value if data is available to read with DatagramBased.receive_messages, or if the connection is closed remotely (EOS); and if the datagram_based has not been closed locally using some implementation-specific method (such as Socket.close or Socket.shutdown with shutdown_read set, if it’s a Socket).

If the connection is shut down or closed (by calling Socket.close or Socket.shutdown with shutdown_read set, if it’s a Socket, for example), all calls to this function will return IOErrorEnum.CLOSED.

GObject.IOCondition.OUT will be set if it is expected that at least one byte can be sent using DatagramBased.send_messages without blocking. It will not be set if the datagram_based has been closed locally.

GObject.IOCondition.HUP will be set if the connection has been closed locally.

GObject.IOCondition.ERR will be set if there was an asynchronous error in transmitting data previously enqueued using DatagramBased.send_messages.

Note that on Windows, it is possible for an operation to return IOErrorEnum.WOULD_BLOCK even immediately after DatagramBased.condition_check has claimed that the DatagramBased is ready for writing. Rather than calling DatagramBased.condition_check and then writing to the DatagramBased if it succeeds, it is generally better to simply try writing right away, and try again later if the initial attempt returns IOErrorEnum.WOULD_BLOCK.

It is meaningless to specify GObject.IOCondition.ERR or GObject.IOCondition.HUP in condition; these conditions will always be set in the output if they are true. Apart from these flags, the output is guaranteed to be masked by condition.

This call never blocks.

Parameters:

• condition — a GObject.IOCondition mask to check

condition_wait

def condition_wait(self, condition: GLib.IOCondition | int, timeout: int, cancellable: Cancellable | None = ...) -> bool

Waits for up to timeout microseconds for condition to become true on datagram_based. If the condition is met, True is returned.

If cancellable is cancelled before the condition is met, or if timeout is reached before the condition is met, then False is returned and error is set appropriately (IOErrorEnum.CANCELLED or IOErrorEnum.TIMED_OUT).

Parameters:

• condition — a GObject.IOCondition mask to wait for
• timeout — the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
• cancellable — a Cancellable

create_source

def create_source(self, condition: GLib.IOCondition | int, cancellable: Cancellable | None = ...) -> GLib.Source

Creates a GLib.Source that can be attached to a GLib.MainContext to monitor for the availability of the specified condition on the DatagramBased. The GLib.Source keeps a reference to the datagram_based.

The callback on the source is of the GDatagramBasedSourceFunc type.

It is meaningless to specify GObject.IOCondition.ERR or GObject.IOCondition.HUP in condition; these conditions will always be reported in the callback if they are true.

If non-None, cancellable can be used to cancel the source, which will cause the source to trigger, reporting the current condition (which is likely 0 unless cancellation happened at the same time as a condition change). You can check for this in the callback using Cancellable.is_cancelled.

Parameters:

• condition — a GObject.IOCondition mask to monitor
• cancellable — a Cancellable

receive_messages

def receive_messages(self, messages: list[InputMessage], flags: int, timeout: int, cancellable: Cancellable | None = ...) -> int

Receive one or more data messages from datagram_based in one go.

messages must point to an array of InputMessage structs and num_messages must be the length of this array. Each InputMessage contains a pointer to an array of InputVector structs describing the buffers that the data received in each message will be written to.

flags modify how all messages are received. The commonly available arguments for this are available in the SocketMsgFlags 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 InputMessage.flags.

The other members of InputMessage are treated as described in its documentation.

If timeout is negative the call will block until num_messages have been received, the connection is closed remotely (EOS), cancellable is cancelled, or an error occurs.

If timeout is 0 the call will return up to num_messages without blocking, or IOErrorEnum.WOULD_BLOCK if no messages are queued in the operating system to be received.

If timeout is positive the call will block on the same conditions as if timeout were negative. If the timeout is reached before any messages are received, IOErrorEnum.TIMED_OUT is returned, otherwise it will return the number of messages received before timing out. (Note: This is effectively the behaviour of MSG_WAITFORONE with recvmmsg().)

To be notified when messages are available, wait for the GObject.IOCondition.IN condition. Note though that you may still receive IOErrorEnum.WOULD_BLOCK from DatagramBased.receive_messages even if you were previously notified of a GObject.IOCondition.IN condition.

If the remote peer closes the connection, any messages queued in the underlying receive buffer will be returned, and subsequent calls to DatagramBased.receive_messages will return 0 (with no error set).

If the connection is shut down or closed (by calling Socket.close or Socket.shutdown with shutdown_read set, if it’s a Socket, for example), all calls to this function will return IOErrorEnum.CLOSED.

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. If cancellable is cancelled, IOErrorEnum.CANCELLED is returned as with any other error.

Parameters:

• messages — an array of InputMessage structs
• flags — an int containing SocketMsgFlags flags for the overall operation
• timeout — the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
• cancellable — a GCancellable

send_messages

def send_messages(self, messages: list[OutputMessage], flags: int, timeout: int, cancellable: Cancellable | None = ...) -> int

Send one or more data messages from datagram_based in one go.

messages must point to an array of OutputMessage structs and num_messages must be the length of this array. Each OutputMessage contains an address to send the data to, and a pointer to an array of OutputVector structs to describe the buffers that the data to be sent for each message will be gathered from.

flags modify how the message is sent. The commonly available arguments for this are available in the SocketMsgFlags 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.

The other members of OutputMessage are treated as described in its documentation.

If timeout is negative the call will block until num_messages have been sent, cancellable is cancelled, or an error occurs.

If timeout is 0 the call will send up to num_messages without blocking, or will return IOErrorEnum.WOULD_BLOCK if there is no space to send messages.

If timeout is positive the call will block on the same conditions as if timeout were negative. If the timeout is reached before any messages are sent, IOErrorEnum.TIMED_OUT is returned, otherwise it will return the number of messages sent before timing out.

To be notified when messages can be sent, wait for the GObject.IOCondition.OUT condition. Note though that you may still receive IOErrorEnum.WOULD_BLOCK from DatagramBased.send_messages even if you were previously notified of a GObject.IOCondition.OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.)

If the connection is shut down or closed (by calling Socket.close or Socket.shutdown with shutdown_write set, if it’s a Socket, for example), all calls to this function will return IOErrorEnum.CLOSED.

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. If cancellable is cancelled, IOErrorEnum.CANCELLED is returned as with any other error.

Parameters:

• messages — an array of OutputMessage structs
• flags — an int containing SocketMsgFlags flags
• timeout — the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
• cancellable — a GCancellable

Virtual methods

do_condition_check

def do_condition_check(self, condition: GLib.IOCondition | int) -> GLib.IOCondition

Checks on the readiness of datagram_based to perform operations. The operations specified in condition are checked for and masked against the currently-satisfied conditions on datagram_based. The result is returned.

GObject.IOCondition.IN will be set in the return value if data is available to read with DatagramBased.receive_messages, or if the connection is closed remotely (EOS); and if the datagram_based has not been closed locally using some implementation-specific method (such as Socket.close or Socket.shutdown with shutdown_read set, if it’s a Socket).

If the connection is shut down or closed (by calling Socket.close or Socket.shutdown with shutdown_read set, if it’s a Socket, for example), all calls to this function will return IOErrorEnum.CLOSED.

GObject.IOCondition.OUT will be set if it is expected that at least one byte can be sent using DatagramBased.send_messages without blocking. It will not be set if the datagram_based has been closed locally.

GObject.IOCondition.HUP will be set if the connection has been closed locally.

GObject.IOCondition.ERR will be set if there was an asynchronous error in transmitting data previously enqueued using DatagramBased.send_messages.

Note that on Windows, it is possible for an operation to return IOErrorEnum.WOULD_BLOCK even immediately after DatagramBased.condition_check has claimed that the DatagramBased is ready for writing. Rather than calling DatagramBased.condition_check and then writing to the DatagramBased if it succeeds, it is generally better to simply try writing right away, and try again later if the initial attempt returns IOErrorEnum.WOULD_BLOCK.

It is meaningless to specify GObject.IOCondition.ERR or GObject.IOCondition.HUP in condition; these conditions will always be set in the output if they are true. Apart from these flags, the output is guaranteed to be masked by condition.

This call never blocks.

Parameters:

• condition — a GObject.IOCondition mask to check

do_condition_wait

def do_condition_wait(self, condition: GLib.IOCondition | int, timeout: int, cancellable: Cancellable | None = ...) -> bool

Waits for up to timeout microseconds for condition to become true on datagram_based. If the condition is met, True is returned.

If cancellable is cancelled before the condition is met, or if timeout is reached before the condition is met, then False is returned and error is set appropriately (IOErrorEnum.CANCELLED or IOErrorEnum.TIMED_OUT).

Parameters:

• condition — a GObject.IOCondition mask to wait for
• timeout — the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
• cancellable — a Cancellable

do_create_source

def do_create_source(self, condition: GLib.IOCondition | int, cancellable: Cancellable | None = ...) -> GLib.Source

Creates a GLib.Source that can be attached to a GLib.MainContext to monitor for the availability of the specified condition on the DatagramBased. The GLib.Source keeps a reference to the datagram_based.

The callback on the source is of the GDatagramBasedSourceFunc type.

It is meaningless to specify GObject.IOCondition.ERR or GObject.IOCondition.HUP in condition; these conditions will always be reported in the callback if they are true.

If non-None, cancellable can be used to cancel the source, which will cause the source to trigger, reporting the current condition (which is likely 0 unless cancellation happened at the same time as a condition change). You can check for this in the callback using Cancellable.is_cancelled.

Parameters:

• condition — a GObject.IOCondition mask to monitor
• cancellable — a Cancellable

do_receive_messages

def do_receive_messages(self, messages: list[InputMessage], flags: int, timeout: int, cancellable: Cancellable | None = ...) -> int

Receive one or more data messages from datagram_based in one go.

messages must point to an array of InputMessage structs and num_messages must be the length of this array. Each InputMessage contains a pointer to an array of InputVector structs describing the buffers that the data received in each message will be written to.

flags modify how all messages are received. The commonly available arguments for this are available in the SocketMsgFlags 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 InputMessage.flags.

The other members of InputMessage are treated as described in its documentation.

If timeout is negative the call will block until num_messages have been received, the connection is closed remotely (EOS), cancellable is cancelled, or an error occurs.

If timeout is 0 the call will return up to num_messages without blocking, or IOErrorEnum.WOULD_BLOCK if no messages are queued in the operating system to be received.

If timeout is positive the call will block on the same conditions as if timeout were negative. If the timeout is reached before any messages are received, IOErrorEnum.TIMED_OUT is returned, otherwise it will return the number of messages received before timing out. (Note: This is effectively the behaviour of MSG_WAITFORONE with recvmmsg().)

To be notified when messages are available, wait for the GObject.IOCondition.IN condition. Note though that you may still receive IOErrorEnum.WOULD_BLOCK from DatagramBased.receive_messages even if you were previously notified of a GObject.IOCondition.IN condition.

If the remote peer closes the connection, any messages queued in the underlying receive buffer will be returned, and subsequent calls to DatagramBased.receive_messages will return 0 (with no error set).

If the connection is shut down or closed (by calling Socket.close or Socket.shutdown with shutdown_read set, if it’s a Socket, for example), all calls to this function will return IOErrorEnum.CLOSED.

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. If cancellable is cancelled, IOErrorEnum.CANCELLED is returned as with any other error.

Parameters:

• messages — an array of InputMessage structs
• flags — an int containing SocketMsgFlags flags for the overall operation
• timeout — the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
• cancellable — a GCancellable

do_send_messages

def do_send_messages(self, messages: list[OutputMessage], flags: int, timeout: int, cancellable: Cancellable | None = ...) -> int

Send one or more data messages from datagram_based in one go.

messages must point to an array of OutputMessage structs and num_messages must be the length of this array. Each OutputMessage contains an address to send the data to, and a pointer to an array of OutputVector structs to describe the buffers that the data to be sent for each message will be gathered from.

flags modify how the message is sent. The commonly available arguments for this are available in the SocketMsgFlags 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.

The other members of OutputMessage are treated as described in its documentation.

If timeout is negative the call will block until num_messages have been sent, cancellable is cancelled, or an error occurs.

If timeout is 0 the call will send up to num_messages without blocking, or will return IOErrorEnum.WOULD_BLOCK if there is no space to send messages.

If timeout is positive the call will block on the same conditions as if timeout were negative. If the timeout is reached before any messages are sent, IOErrorEnum.TIMED_OUT is returned, otherwise it will return the number of messages sent before timing out.

To be notified when messages can be sent, wait for the GObject.IOCondition.OUT condition. Note though that you may still receive IOErrorEnum.WOULD_BLOCK from DatagramBased.send_messages even if you were previously notified of a GObject.IOCondition.OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.)

If the connection is shut down or closed (by calling Socket.close or Socket.shutdown with shutdown_write set, if it’s a Socket, for example), all calls to this function will return IOErrorEnum.CLOSED.

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. If cancellable is cancelled, IOErrorEnum.CANCELLED is returned as with any other error.

Parameters:

• messages — an array of OutputMessage structs
• flags — an int containing SocketMsgFlags flags
• timeout — the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
• cancellable — a GCancellable