Module node_adapter

Expand description

Node-layer adapters for chat-style applications (feature node).

inbound_text classifies a received frame for a chat session, with the display rules of the well-known channels, and copies a text frame out of the receive callback for the ChatFacade.
TransmitQueue carries the facade’s transmissions to LocalNode sends, and maps acknowledgments and timeouts back onto the engine. Channel sends need the software-crypto feature.
Thin wrappers for applications that send and receive text directly on a peer connection or a bound channel.

Structs§

Departure: A frame let go by TransmitQueue::depart, with where it goes, until TransmitQueue::departed is told how its send went.
InboundText: A text frame copied out of a receive callback.
MulticastTextChatWrapper
RxSummary: Radio observations for a received frame.
Stall: A transmission that has stayed in flight past TRANSMISSION_STALL_MS.
TransmitPolicy: What a send needs to know beyond the frame itself.
TransmitQueue: The chat transmit queue.
Undeliverable: A frame that will not go out: an unregistrable peer, a channel no longer held.
UnicastTextChatWrapper: Thin convenience wrapper for plain unicast text chat over a peer connection.
WellKnownChannels: The protocol’s two well-known channels, which carry rules of their own (multicast-channels.md §Default Channels).

Departed: What TransmitQueue::departed made of a send.
Inbound: What a received frame is to a chat session.
Refusal: Why a text frame was refused (multicast-channels.md §Default Channels).
Sent: How a send went.
TextReceiveIssue: Reason a received packet did not become a text message callback.

TRANSMISSION_STALL_MS: How long an in-flight transmission may go unresolved before it is called out. Longer than any ordinary acknowledgment wait, so this fires on trouble rather than on a slow link.
WELL_KNOWN_CHANNEL_MAX_FLOOD_HOPS: The flood-hop ceiling the protocol fixes for public and EMERGENCY.

bound_channel: Bind a held channel, so it can be sent over.
channel_reach: How far traffic on a channel may travel: the ceiling the user registered for it, otherwise default_hops—and never past the ceiling the protocol fixes for the well-known public and EMERGENCY channels.
inbound_text: Classify a received frame for a chat session whose identity is local_key.
parse_text_payload: Parse a typed text payload in the context of the enclosing packet type.
transmit: Sends a departed frame. Needs only the node, so a caller may hold nothing else across it.
with_flood_reach: Spend hops on options: a budget for a flood, or no flood at all for zero.