Struct Server 

pub struct Server { /* private fields */ }

An instance of a Perspective server. Each Server instance is separate, and does not share perspective_client::Table (or other) data with other Servers.

Implementations

impl Server

pub fn new( on_poll_request: Option<Arc<dyn Fn(&Server) -> BoxFuture<'static, Result<(), ServerError>> + Send + Sync>>, ) -> Self

Create a new Server.

Arguments

• on_poll_request A callback function which the Server will invoke when there are updates that need to be flushed, after which you must eventually call Server::poll (or else no updates will be processed). This optimization allows batching updates, depending on context.

pub async fn new_session_with_callback<F>( &self, send_response: F, ) -> LocalSession

where F: for<'a> Fn(&'a [u8]) -> BoxFuture<'a, Result<(), ServerError>> + 'static + Sync + Send,

An alternative method for creating a new [Session] for this Server, from a callback closure instead of a via a trait. See Server::new_session for details.

Arguments

• send_response - A function invoked by the Server when a response message needs to be sent to the perspective_client::Client.

pub async fn new_session<F>(&self, session_handler: F) -> LocalSession

where F: SessionHandler + 'static + Sync + Send + Clone,

Create a [Session] for this Server, suitable for exactly one perspective_client::Client (not necessarily in this process). A [Session] represents the server-side state of a single client-to-server connection.

Arguments

• session_handler - An implementor of SessionHandler which will be invoked by the Server when a response message needs to be sent to the [Client]. The response itself should be passed to [Client::handle_response] eventually, though it may-or-may-not be in the same process.

pub fn new_local_client(&self) -> LocalClient

Create a new [Client] instance bound to this Server directly.

pub async fn poll(&self) -> Result<(), ServerError>

Flush any pending messages which may have resulted from previous [Session::handle_request] calls.

Server::poll only needs to be called if you’ve implemented a custom Perspective Server and provided the on_poll_request constructor keyword argument.

Calling [Session::poll] may result in the send_response parameter which was used to construct this (or other) [Session] to fire. Whenever a [Session::handle_request] method is invoked for a perspective_server::Server, at least one [Session::poll] should be scheduled to clear other clients message queues.

poll() must be called after [Table::update] or [Table::remove] and on_poll_request is notified, or the changes will not be applied.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Server

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

Formats the value using the given formatter.