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 a capacity for channel and returns Arc<Server> for convenience.

pub async fn connections(&self) -> Vec<u128>

List connection ids.

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

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<M>(&self) -> Option<Event<M>> where
    M: From<Message>, 

Get next server event.

pub async fn next_transform<M>(
    &self
) -> Option<Result<Event<M>, <M as TryFrom<Message>>::Error>> where
    M: TryFrom<Message>, 

Get next server event and try converting if it’s a Event::Message.

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

Send a message to a connection with the given id. If id is None then the messages will be sent to all connections.

pub async fn send_transform<M>(
    &self,
    id: Option<u128>,
    msg: M
) -> Result<Result<()>, <M as TryInto<Message>>::Error> where
    M: TryInto<Message>, 

Try converting the message and send to a connection with the given id. If id is None then the messages will be sent to all connections.

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

Close a connection with the given id and reason. If id is None then all connections will be closed.