Struct workflow_rpc::server::RpcServer

pub struct RpcServer { /* private fields */ }

RpcServer - a server-side object that listens for incoming websocket connections and delegates interaction with them to the supplied interfaces: RpcHandler (for RPC server management) and Interface (for method and notification dispatch).

Implementations

impl RpcServer

pub fn new<ServerContext, ConnectionContext, Protocol, Ops>( rpc_handler: Arc<dyn RpcHandler<Context = ConnectionContext>>, interface: Arc<Interface<ServerContext, ConnectionContext, Ops>>, counters: Option<Arc<WebSocketCounters>>, enable_async_handling: bool, ) -> RpcServer

where ServerContext: Clone + Send + Sync + 'static, ConnectionContext: Clone + Send + Sync + 'static, Protocol: ProtocolHandler<ServerContext, ConnectionContext, Ops> + Send + Sync + 'static, Ops: OpsT,

Create a new RpcServer supplying an Arc of the previously-created RpcHandler trait and the Interface struct. This method takes 4 generics:

• ConnectionContext: a struct used as RpcHandler::Context to represent the connection. This struct is passed to each RPC method and notification call.
• ServerContext: a struct supplied to the Interface at the Interface creation time. This struct is passed to each RPC method and notification call.
• Protocol: A protocol type used for the RPC message serialization and deserialization (this can be omitted by using RpcServer::new_with_encoding)
• Ops: A data type (index or an enum) representing the RPC method or notification.

pub fn new_with_encoding<ServerContext, ConnectionContext, Ops, Id>( encoding: Encoding, rpc_handler: Arc<dyn RpcHandler<Context = ConnectionContext>>, interface: Arc<Interface<ServerContext, ConnectionContext, Ops>>, counters: Option<Arc<WebSocketCounters>>, enable_async_handling: bool, ) -> RpcServer

where ServerContext: Clone + Send + Sync + 'static, ConnectionContext: Clone + Send + Sync + 'static, Ops: OpsT, Id: IdT,

Create a new RpcServer supplying an Arc of the previously-created RpcHandler trait and the Interface struct. This method takes 4 generics:

• ConnectionContext: a struct used as RpcHandler::Context to represent the connection. This struct is passed to each RPC method and notification call.
• ServerContext: a struct supplied to the Interface at the Interface creation time. This struct is passed to each RPC method and notification call.
• Ops: A data type (index or an enum) representing the RPC method or notification.
• Id: A data type representing a message Id - this type must implement the id::Generator trait. Implementation for default Ids such as Id32 and Id64 can be found in the id module.

This function call receives an encoding: Encoding argument containing Encoding::Borsh or Encoding::SerdeJson, based on which it will instantiate the corresponding protocol handler (BorshProtocol or JsonProtocol respectively).

enable_async_handling is a boolean flag that determines if the server should spawn a new async task for each incoming message. If set to false, the server will handle message intake synchronously where each message is posted to the underlying handler one-at-a-time. (i.e. RPC awaits for the message intake processing to be complete before the next message arrives). If true, each message is dispatched via a new async task.

pub async fn bind(&self, addr: &str) -> WebSocketResult<TcpListener>

Bind network interface address to the TcpListener

pub async fn listen( &self, listener: TcpListener, config: Option<WebSocketConfig>, ) -> WebSocketResult<()>

Start listening for incoming RPC connections on the supplied TcpListener

pub fn stop(&self) -> WebSocketResult<()>

Signal the listening task to stop

pub async fn join(&self) -> WebSocketResult<()>

Blocks until the listening task has stopped

pub async fn stop_and_join(&self) -> WebSocketResult<()>

Signal the listening task to stop and block until it has stopped

Trait Implementations

impl Clone for RpcServer

fn clone(&self) -> RpcServer

Returns a copy of the value.

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

Performs copy-assignment from source.