Crate perspective_server

This crate contains the server/engine components of the Perspective data visualization suite. It is meant to be used in conjunction with the other crates of this project, e.g. perspective-client to create client connections to a server.

The [perspective] crate provides a convenient frontend for Rust developers, including both perspective_client and [perspective_server] as well as other convenient integration helpers.

Architecture

The basic dataflow of a Perspective applications looks something like this:

                     : Network or sync boundary
                     :
 Client 1            :   Session 1                      Server
┏━━━━━━━━━━━━━━━━━━┓ :  ┏━━━━━━━━━━━━━━━━━━┓           ┏━━━━━━━━━━━━━━━━━━┓
┃ handle_response  ┃<━━━┃ send_response    ┃<━┳━━━━━━━━┃ send_response    ┃
┃ send_request     ┃━┳━>┃ handle_request   ┃━━━━━┳━━━━>┃ handle_request   ┃
┗━━━━━━━━━━━━━━━━━━┛ ┗━>┃ poll             ┃━━━━━━━━┳━>┃ poll             ┃
                     :  ┃ session_id       ┃  ┃  ┃  ┃  ┃ generate_id      ┃
                     :  ┗━━━━━━━━━━━━━━━━━━┛  ┃  ┃  ┃  ┃ cleanup_id       ┃
                     :                        ┃  ┃  ┃  ┗━━━━━━━━━━━━━━━━━━┛
 Client 2            :   Session 2            ┃  ┃  ┃
┏━━━━━━━━━━━━━━━━━━┓ :  ┏━━━━━━━━━━━━━━━━━━┓  ┃  ┃  ┃  
┃ handle_response  ┃<━━━┃ send_response    ┃<━┛  ┃  ┃                         
┃ send_request     ┃━┳━>┃ handle_request   ┃━━━━━┛  ┃                                        
┗━━━━━━━━━━━━━━━━━━┛ ┗━>┃ poll             ┃━━━━━━━━┛
                     :  ┃ session_id       ┃                                                 
                     :  ┗━━━━━━━━━━━━━━━━━━┛

Feature Flags

The following feature flags are available to enable in your Cargo.toml:

• external-cpp Set this flag to configure this crate’s compile process to look for Perspective C++ source code in the environment rather than locally, e.g. for when you build this crate in-place in the Perspective repo source tree.

Structs

• LocalSession
  A struct for implementing perspective_client::Session against an same-process Server instance. See also perspective_client::ProxySession for implement the trait against an arbitrary remote transport.
• Server
  An instance of a Perspective server. Each Server instance is separate, and does not share perspective_client::Table (or other) data with other Servers.

Traits

• Session
  The server-side representation of a connection to a [perspective_client::Client]. For each [perspective_client::Client] that wants to connect to a [Server], a dedicated Session must be created. The Session handles routing messages emitted by the [Server], as well as owning any resources the Client may request.
• SessionHandler
  Use SessionHandler to implement a callback for messages emitted from a Session, to be passed to the Server::new_session constructor. Alternatively, a Session can be created from a closure instead via Server::new_session_with_callback.

Type Aliases

• ServerError