Struct Server

Source
pub struct Server { /* private fields */ }
Expand description

A TCP WebSocket Server.

Implementations§

Source§

impl Server

Source

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

Create a new Server instance. Takes a capacity for channel and returns Arc<Server> for convenience.

Source

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

List connection ids.

Source

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

Start listening on given socket address.

Source

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

Close all connections and stop all listeners.

Source

pub async fn next<M>(&self) -> Option<Event<M>>
where M: From<Message>,

Get next server event.

Source

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.

Source

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.

Source

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.

Source

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.

Auto Trait Implementations§

§

impl !Freeze for Server

§

impl !RefUnwindSafe for Server

§

impl Send for Server

§

impl Sync for Server

§

impl Unpin for Server

§

impl !UnwindSafe for Server

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,