Struct Server

pub struct Server { /* private fields */ }

A Server is a structure that holds connected clients, manages their links and handles their responses. Notice that there is no actual network code here, the Server accepts packets by value from Server::handle_packet, sends packets back to clients via futures::sync::mpsc::UnboundedSender<Packet> channel, accepts onion responses from Server::handle_udp_onion_response and sends onion requests via futures::sync::mpsc::UnboundedSender<OnionRequest> channel. The outer code should manage how to handshake connections, get packets from clients, pass them into Server::handle_packet, get onion responses from UPD socket and send them to Server::handle_udp_onion_response, create mpsc channels, take packets from futures::sync::mpsc::UnboundedReceiver<Packet> send them back to clients via network.

Implementations

impl Server

pub fn new() -> Server

Create a new Server without onion

pub fn set_udp_onion_sink( &mut self, onion_sink: Sender<(OnionRequest, SocketAddr)>, )

Create a new Server with onion

pub async fn insert(&self, client: Client) -> Result<(), Error>

Insert the client into connected_clients. If connected_clients contains a client with the same pk it will be terminated.

pub async fn handle_packet( &self, pk: &PublicKey, packet: Packet, ) -> Result<(), Error>

The main processing function. Call in on each incoming packet from connected and handshaked client.

pub async fn handle_udp_onion_response( &self, ip_addr: IpAddr, port: u16, payload: InnerOnionResponse, ) -> Result<(), Error>

Send OnionResponse packet to the client by it’s std::net::IpAddr.

pub async fn shutdown_client( &self, pk: &PublicKey, ip_addr: IpAddr, port: u16, ) -> Result<(), Error>

Gracefully shutdown client by pk, IP address and port. IP address and port are used to ensure that the right client will be removed. If the client with passed pk has different IP address or port it means that it was recently reconnected and it shouldn’t be removed by the old connection finalization step. If IP address with port are correct remove it from the list of connected clients. If there are any clients mutually linked to current client, we send them corresponding DisconnectNotification.

pub async fn send_pings(&self) -> Result<(), Error>

Send pings to all connected clients and terminate all timed out clients.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Server

fn default() -> Server

Returns the “default value” for a type.