Struct SnapTunEndpoint 

pub struct SnapTunEndpoint { /* private fields */ }

Snap tunnel endpoint that allows creating new snap tun connections. It holds one static identity and manages the registration of this identity with all connected control planes.

The data plane binds a tunnel to the socket address that the endpoint sends from and to the static identity of the endpoint. Two rules follow for an application that reconnects:

• Reuse the static identity if you reuse the socket address. Store the identity and pass it to SnapTunEndpoint::new again. The data plane then accepts the handshake at once and gives the endpoint a new tunnel session.
• Use a new socket address if you start with a new static identity. On the old address the data plane answers no handshake, and it drops the packets of the new identity, until the tunnel of the old identity expires. That takes several minutes.

An application that lets the socket address and the static identity change together is always correct. An application that pins its port must also pin its identity. SnapTunServer documents why the data plane holds an address for one identity.

Implementations

impl SnapTunEndpoint

pub fn new( token_source: Arc<dyn TokenSource>, static_private: StaticSecret, ) -> Self

Creates a new SNAP tunnel socket manager.

pub async fn connect_tunnel( &self, peer_public: PublicKey, dataplane_address: SocketAddr, control_plane: Url, control_plane_client: Arc<dyn SnapTunControlPlaneClient>, underlay_socket: Arc<UdpSocket>, receive_queue_capacity: usize, pool: PacketBufPool<PACKET_BUF_POOL_SIZE>, ) -> Result<SnapTunnel, ConnectSnapTunSocketError>

Connects a new SNAP tunnel. If the endpoints static identity is not already registered with the selected snap-tun control plane, it is registered before this method returns.

Trait Implementations

impl Drop for SnapTunEndpoint

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.