Skip to main content

Crate antenna_protocol

Crate antenna_protocol 

Source
Expand description

SansIO core of the antenna P2P mesh SDK.

This crate is the platform-independent engine that drives every antenna peer. It contains no network, no async runtime, no WebRTC — only a synchronous state machine that turns Input events into Output commands. Platform drivers (antenna-client-web, antenna-client-native) wrap it and perform the actual I/O.

The full protocol — handshake modes, relay, reconnection, mesh-completeness guarantees — is described in docs/protocol.md.

Structs§

HandshakeFSM
Per-peer handshake state machine.
Host
Host-side handshake FSM
Identity
Persistent ED25519 identity of a peer.
Joiner
Joiner-side handshake FSM
MeshNodeFSM
Top-level state machine for a mesh node.
PeerID
Mesh peer identifier — wraps the peer’s biscuit public key directly.
SignalingPayload
SDP offer or answer signed by the sender’s crate::Identity.

Enums§

FSMState
Coarse mesh-membership state for the local node.
HandshakeInput
Events fed into the handshake FSM from the driver.
HandshakeMode
How the SDP offer/answer pair is exchanged between two peers.
HandshakeOutput
Commands emitted by the handshake FSM for the driver to execute.
HandshakeState
Handshake-level state of the client handshake FSM.
HandshakeStrategy
Which side of the handshake the local peer plays.
Input
Common event that client FSM receives
MsgPayload
Every frame that crosses a data channel.
Output
Common event that client FSM sends
RelayPayload
Inner payload of a relay-signaling frame between two peers via an intermediary.
Scheduled
Scheduled action identifier

Traits§

UserMsgPayload
Marker trait for application message types carried over the mesh.