Struct Endpoint 

pub struct Endpoint { /* private fields */ }

A WireGuard endpoint capable of communicating with multiple remote peers.

Implementations

impl Endpoint

pub fn new(my_key: NodeKeyPair) -> Self

Construct a new endpoint with the given keypair.

pub fn add_peer(&mut self, cfg: PeerConfig) -> Option<PeerId>

Add a new peer.

Returns a handle to the newly configured peer, or None if a peer is already configured with the given node key.

pub fn remove_peer(&mut self, peer: PeerId) -> bool

Remove the given peer.

Returns whether the peer in question existed.

pub fn send( &mut self, packets: impl IntoIterator<Item = (PeerId, Vec<PacketMut>)>, ) -> SendResult

Send packets to peers.

pub fn recv( &mut self, packets: impl IntoIterator<Item = PacketMut>, ) -> RecvResult

Receive packets from peers.

pub fn dispatch_events(&mut self, now: Instant) -> EventResult

Dispatch time-based events that are due to occur at or before the given instant.

Use Endpoint::next_event to know when to call dispatch_events. It is inefficient but harmless to call it more frequently than specified by Endpoint::next_event.

pub fn next_event(&self) -> Option<TimeRange>

Returns the next time range in which Endpoint::dispatch_events should next be called to dispatch events.

Endpoint::dispatch_events should be called at some point in the returned TimeRange to keep the wireguard state machine functioning correctly.

See Scheduler::next_dispatch_range for additional details.

pub fn peer_key(&self, id: PeerId) -> Option<NodePublicKey>

Return the node key for the selected peer.

pub fn peer_id(&self, key: NodePublicKey) -> Option<PeerId>

Return the peer id that has the selected node key.