Struct ServerEventCallbacks 

pub struct ServerEventCallbacks<R>
where
    R: DeserializeOwned + 'static,
{ /* private fields */ }

Configuration for a server’s event callbacks.

Events

There are four events for which callbacks can be registered:

• connect
• disconnect
• receive
• stop

All callbacks are optional, and can be registered for any combination of these events. Note that each callback must be provided as a function or closure returning a thread-safe future. The future will be awaited by the runtime.

Example

let server = Server::builder()
    .sending::<usize>()
    .receiving::<String>()
    .with_event_callbacks(
        ServerEventCallbacks::new()
            .on_connect(move |client_id| async move {
                // some async operation...
                println!("Client with ID {} connected", client_id);
            })
            .on_disconnect(move |client_id| async move {
                // some async operation...
                println!("Client with ID {} disconnected", client_id);
            })
            .on_receive(move |client_id, data| async move {
                // some async operation...
                println!("Received data from client with ID {}: {}", client_id, data);
            })
            .on_stop(move || async move {
                // some async operation...
                println!("Server closed");
            })
    )
    .start(("127.0.0.1", 29275))
    .await
    .unwrap();

Implementations

impl<R> ServerEventCallbacks<R>

where R: DeserializeOwned + 'static,

pub const fn new() -> Self

Creates a new server event callbacks configuration with all callbacks empty.

pub fn on_connect<C, F>(self, callback: C) -> Self

where C: Fn(usize) -> F + Send + Sync + 'static, F: Future<Output = ()> + Send + 'static,

Registers a callback on the connect event.

pub fn on_disconnect<C, F>(self, callback: C) -> Self

where C: Fn(usize) -> F + Send + Sync + 'static, F: Future<Output = ()> + Send + 'static,

Registers a callback on the disconnect event.

pub fn on_receive<C, F>(self, callback: C) -> Self

where C: Fn(usize, R) -> F + Send + Sync + 'static, F: Future<Output = ()> + Send + 'static,

Registers a callback on the receive event.

pub fn on_stop<C, F>(self, callback: C) -> Self

where C: Fn() -> F + Send + Sync + 'static, F: Future<Output = ()> + Send + 'static,

Registers a callback on the stop event.

Trait Implementations

impl<R> Default for ServerEventCallbacks<R>

where R: DeserializeOwned + 'static,

fn default() -> Self

Returns the “default value” for a type.