Struct workflow_rpc::asynchronous::server::RpcWebSocketHandler

pub struct RpcWebSocketHandler<Ops>where
    Ops: Send + Sync + TryFrom<u32> + 'static,{ /* private fields */ }

Implementations

impl<Ops> RpcWebSocketHandler<Ops>where
    Ops: Send + Sync + TryFrom<u32> + 'static,

pub fn new(rpc_handler: Arc<dyn RpcHandler<Ops>>) -> Self

Trait Implementations

impl<Ops: Clone> Clone for RpcWebSocketHandler<Ops>where
    Ops: Send + Sync + TryFrom<u32> + 'static,

fn clone(&self) -> RpcWebSocketHandler<Ops>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ops> WebSocketHandler for RpcWebSocketHandler<Ops>where
    Ops: Send + Sync + TryFrom<u32> + 'static,
    <Ops as TryFrom<u32>>::Error: Sync + Send + 'static,

type Context = Arc<RpcContext>

Context type used by impl trait to represent websocket connection

fn connect<'life0, 'async_trait>(
    self: &'life0 Arc<Self>,
    peer: SocketAddr
) -> Pin<Box<dyn Future<Output = WebSocketResult<Self::Context>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Called immediately when connection is established This function can return an error to terminate the connection

fn handshake<'life0, 'life1, 'life2, 'async_trait>(
    self: &'life0 Arc<Self>,
    _ctx: &'life1 Self::Context,
    _msg: Message,
    _sink: &'life2 UnboundedSender<Message>
) -> Pin<Box<dyn Future<Output = WebSocketResult<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Called upon receipt of the first websocket message if with_handshake() returns true This function can return an error to terminate the connection

fn message<'life0, 'life1, 'life2, 'async_trait>(
    self: &'life0 Arc<Self>,
    _ctx: &'life1 Self::Context,
    msg: Message,
    sink: &'life2 UnboundedSender<Message>
) -> Pin<Box<dyn Future<Output = WebSocketResult<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Called for every websocket message This function can return an error to terminate the connection

fn with_handshake(self: &Arc<Self>) -> bool

Enables optional invocation of the handshake method with the first message received form the incoming websocket

fn with_timeout(self: &Arc<Self>) -> Duration

Sets the default connection timeout if no messages have been received

fn disconnect<'life0, 'async_trait>(
    self: &'life0 Arc<Self>,
    _ctx: Self::Context,
    _result: Result<(), Error>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    Self: 'async_trait + Sync,

Called upon websocket disconnection