Struct Listener 

pub struct Listener<CM, SM>
where
    CM: Send + Sync + 'static,
    SM: Send + Sync + 'static,
{ /* private fields */ }

Binds to a configured port and accepts incoming connections.

Implementations

impl<CM, SM> Listener<CM, SM>

where CM: Send + Sync + 'static, SM: Send + Sync + 'static,

pub async fn bind( config: ListenerConfig, cancellation_token: CancellationToken, ) -> Result<Self, ListenerError>

Constructs the listener and binds it to the configured socket.

Arguments

• config - configuration for the listener and all its clients.
• cancellation_token - cancels the listener, unbinding it from the socket and sends a termination signal to all clients spawned from this listener.

Returns

Ok(Self) if it successfully bound to the socket. See ListenerError for errors descriptions.

Trait Implementations

impl<CM, SM> Cancellable for Listener<CM, SM>

where CM: Send + Sync + 'static, SM: Send + Sync + 'static,

type Result = Client<Connection<WebSocketStream<TcpStream>>, CM, SM>

Type of values that can be yielded by the service.

type Handle = ()

Type of a handle for communicating with the service.

type Error = ListenerError

Error returned by Self::run method.

fn new_handle<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Self::Handle> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Constructs a new handle for communicating with the service.

fn run<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<CancellationResult<Self::Result>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Performs a single unit of work.

fn spawn<'async_trait>( self, cancellation_token: CancellationToken, ) -> Pin<Box<dyn Future<Output = CancellableHandle<Self>> + Send + 'async_trait>>

where Self: Sized + Send + 'static + 'async_trait,

Consumes the service and spawns its work loop.

fn spawn_with_callback<'async_trait, F>( self, cancellation_token: CancellationToken, callback: F, ) -> Pin<Box<dyn Future<Output = CancellableHandle<Self>> + Send + 'async_trait>>

where Self: Sized + Send + 'static + 'async_trait, F: FnMut(Self::Result) -> Result<(), Self::Result> + Send + 'static + 'async_trait,

Consumes the service and spawns its work loop.

impl<CM, SM> Debug for Listener<CM, SM>

where CM: Send + Sync + 'static + Debug, SM: Send + Sync + 'static + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.