Trait ServerListener

pub trait ServerListener: Send + Sync {
    // Provided methods
    fn on_message_data(
        &self,
        _client: Client,
        _client_channel: &ClientChannel,
        _payload: &[u8],
    ) { ... }
    fn on_subscribe(&self, _client: Client, _channel: ChannelView<'_>) { ... }
    fn on_unsubscribe(&self, _client: Client, _channel: ChannelView<'_>) { ... }
    fn on_client_advertise(&self, _client: Client, _channel: &ClientChannel) { ... }
    fn on_client_unadvertise(&self, _client: Client, _channel: &ClientChannel) { ... }
    fn on_get_parameters(
        &self,
        _client: Client,
        _param_names: Vec<String>,
        _request_id: Option<&str>,
    ) -> Vec<Parameter> { ... }
    fn on_set_parameters(
        &self,
        _client: Client,
        parameters: Vec<Parameter>,
        _request_id: Option<&str>,
    ) -> Vec<Parameter> { ... }
    fn on_parameters_subscribe(&self, _param_names: Vec<String>) { ... }
    fn on_parameters_unsubscribe(&self, _param_names: Vec<String>) { ... }
    fn on_connection_graph_subscribe(&self) { ... }
    fn on_connection_graph_unsubscribe(&self) { ... }
}

Available on crate feature live_visualization only.

Provides a mechanism for registering callbacks for handling client message events.

These methods are invoked from the client’s main poll loop and must not block. If blocking or long-running behavior is required, the implementation should use tokio::task::spawn (or tokio::task::spawn_blocking).

Provided Methods

fn on_message_data( &self, _client: Client, _client_channel: &ClientChannel, _payload: &[u8], )

Callback invoked when a client message is received.

fn on_subscribe(&self, _client: Client, _channel: ChannelView<'_>)

Callback invoked when a client subscribes to a channel. Only invoked if the channel is associated with the server and isn’t already subscribed to by the client.

fn on_unsubscribe(&self, _client: Client, _channel: ChannelView<'_>)

Callback invoked when a client unsubscribes from a channel or disconnects. Only invoked for channels that had an active subscription from the client.

fn on_client_advertise(&self, _client: Client, _channel: &ClientChannel)

Callback invoked when a client advertises a client channel. Requires Capability::ClientPublish.

fn on_client_unadvertise(&self, _client: Client, _channel: &ClientChannel)

Callback invoked when a client unadvertises a client channel. Requires Capability::ClientPublish.

fn on_get_parameters( &self, _client: Client, _param_names: Vec<String>, _request_id: Option<&str>, ) -> Vec<Parameter>

Callback invoked when a client requests parameters. Requires Capability::Parameters. Should return the named paramters, or all paramters if param_names is empty.

fn on_set_parameters( &self, _client: Client, parameters: Vec<Parameter>, _request_id: Option<&str>, ) -> Vec<Parameter>

Callback invoked when a client sets parameters. Requires Capability::Parameters. Should return the updated parameters for the passed parameters. The implementation could return the modified parameters. All clients subscribed to updates for the returned parameters will be notified.

Note that only parameters which have changed are included in the callback, but the return value must include all parameters.

fn on_parameters_subscribe(&self, _param_names: Vec<String>)

Callback invoked when a client subscribes to the named parameters for the first time. Requires Capability::Parameters.

fn on_parameters_unsubscribe(&self, _param_names: Vec<String>)

Callback invoked when the last client unsubscribes from the named parameters. Requires Capability::Parameters.

fn on_connection_graph_subscribe(&self)

Callback invoked when the first client subscribes to the connection graph. Requires Capability::ConnectionGraph.

fn on_connection_graph_unsubscribe(&self)

Callback invoked when the last client unsubscribes from the connection graph. Requires Capability::ConnectionGraph.

Implementors