Struct paperplane::Server

pub struct Server { /* fields omitted */ }

A TCP WebSocket Server.

Implementations

impl Server

pub fn new(cap: usize) -> Arc<Self>

Create a new Server instance. Takes channel capacity and returns Arc<Server> for convenience. Channel is currently created with futures::channel::mpsc::channel but might be with async_std::channel::bounded in the future.

pub async fn accept(self: &Arc<Self>, stream: TcpStream) -> Result<u128>

Accept given TcpStream as a WebSocket connection.

pub async fn listen<A: ToSocketAddrs>(self: &Arc<Self>, addr: A) -> Result<()>

Start listening on given socket address.

pub async fn close(self: &Arc<Self>) -> Result<()>

Close all connections and stop all listeners.

pub async fn next(&self) -> Option<Event>

Get next server event.

pub async fn send(&self, id: u128, msg: Message) -> Result<()>

Send a message to a connection with the given id.

pub async fn send_all(&self, msg: Message) -> Result<()>

Send a message to all current connections.

pub async fn send_map<F: Fn(u128) -> Option<Message>>(
    &self,
    map: F
) -> Result<()>

Loop through connections and send messages determined by the given closure.

pub async fn kick(&self, id: u128, reason: &str) -> Result<()>

Close a connection with the given id and reason.

pub async fn kick_all(self: &Arc<Self>, reason: &str) -> Result<()>

Close all current connections with the given reason.

pub async fn kick_map<F: Fn(u128) -> Option<String>>(
    self: &Arc<Self>,
    map: F
) -> Result<()>

Loop through connections and kick the ones for which's id the given closure returns a reason.