Struct workflow_rpc::server::Messenger

pub struct Messenger { /* private fields */ }

The Messenger struct is supplied to the RpcHandler::handshake() call at the connection negotiation time. This structure comes in as Arc<Messenger> and can be retained for later processing. It provides two methods: Messenger::notify that can be used asynchronously to dispatch RPC notifications to the client and Messenger::close that can be used to terminate the RPC connection with the client.

Implementations

impl Messenger

pub fn new(encoding: Encoding, sink: &WebSocketSink) -> Self

pub fn close(&self) -> Result<()>

Close the WebSocket connection. The server checks for the connection channel for the dispatch of this message and relays it to the client as well as proactively terminates the connection.

pub async fn notify<Ops, Msg>(&self, op: Ops, msg: Msg) -> Result<()>where
Ops: OpsT,
Msg: BorshSerialize + BorshDeserialize + Serialize + Send + Sync + 'static,

Post notification message to the WebSocket connection

pub fn serialize_notification_message<Ops, Msg>(
&self,
op: Ops,
msg: Msg
) -> Result<Message>where
Ops: OpsT,
Msg: MsgT,

Serialize message into a tungstenite::Message for direct websocket delivery. Once serialized it can be relayed using [send_raw_message()].

pub fn send_raw_message(&self, msg: Message) -> Result<()>

Send a raw tungstenite::Message via the websocket tokio channel.

pub fn sink(&self) -> &WebSocketSink

Provides direct access to the underlying tokio channel.

Trait Implementations

impl Debug for Messenger

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

Formats the value using the given formatter.