GitHub

BackingSocket

API reference for BackingSocket.

What a platform adapter gives make_from_backing_socket.

address is the bound address, scope_ids maps IPv6 zone names to scope ids, peer is the default destination and connected marks a connected socket, whose sends take no destination. send and send_many call done exactly once, from any thread, when the platform reports the result; send_many passes the index of the datagram that failed when it knows it. close does not raise.

Attributes

AttributeTypeDescription
addressBackingAddress
scope_idsMapping[str, int]
peerBackingAddress | None
connectedbool

Functions

send

send(payload, destination, done) -> None
ParameterTypeDescription
payloadbytes
destinationBackingAddress | None
doneSendDone
def send(self, payload: bytes, destination: BackingAddress | None, done: SendDone) -> None: ...

send_many

send_many(payloads, destinations, done) -> None
ParameterTypeDescription
payloadsSequence[bytes]
destinationsSequence[BackingAddress | None]
doneSendManyDone
def send_many(
    self,
    payloads: Sequence[bytes],
    destinations: Sequence[BackingAddress | None],
    done: SendManyDone,
) -> None: ...

join_multicast

join_multicast(group, interface, source) -> Effect[Leave, DatagramSocketError]
ParameterTypeDescription
groupIpAddress
interfaceIPv4Address | int | None
sourceIpAddress | None

Returns Effect[Leave, DatagramSocketError]

def join_multicast(
    self, group: IpAddress, interface: IPv4Address | int | None, source: IpAddress | None
) -> Effect[Leave, DatagramSocketError]: ...

close

close() -> None
def close(self) -> None: ...