Struct RpcClient

pub struct RpcClient<Ops, Id = Id64>
where
    Ops: OpsT,
    Id: IdT,
{ /* private fields */ }

Implementations

impl<Ops, Id> RpcClient<Ops, Id>

where Ops: OpsT, Id: IdT,

pub fn new_with_encoding( encoding: Encoding, interface: Option<Arc<Interface<Ops>>>, options: Options<'_>, config: Option<WebSocketConfig>, ) -> Result<RpcClient<Ops, Id>>

Create new wRPC client connecting to the supplied URL

This function accepts the Encoding enum argument denoting the underlying protocol that will be used by the client. Current variants supported are:

• Encoding::Borsh
• Encoding::SerdeJson

pub fn new<T>( interface: Option<Arc<Interface<Ops>>>, options: Options<'_>, config: Option<WebSocketConfig>, ) -> Result<RpcClient<Ops, Id>>

where T: ProtocolHandler<Ops> + Send + Sync + 'static,

Create new wRPC client connecting to the supplied URL.

This function accepts a generic denoting the underlying protocol that will be used by the client. Current protocols supported are:

• BorshProtocol
• JsonProtocol

pub async fn connect(&self, options: ConnectOptions) -> ConnectResult<Error>

Connect to the target wRPC endpoint (websocket address)

pub async fn shutdown(&self) -> Result<()>

Stop wRPC client services

pub fn ctl_multiplexer(&self) -> &Option<Multiplexer<Ctl>>

pub fn is_connected(&self) -> bool

Test if the underlying WebSocket is currently open

pub fn url(&self) -> Option<String>

Obtain the current URL of the underlying WebSocket

pub fn set_url(&self, url: &str) -> Result<()>

Change the URL of the underlying WebSocket (applicable only to the next connection). Alternatively, the new URL can be supplied in the connect() method using ConnectOptions.

pub fn configure(&self, config: WebSocketConfig)

Change the configuration of the underlying WebSocket. This method can be used to alter the configuration for the next connection.

pub async fn notify<Msg>(&self, op: Ops, payload: Msg) -> Result<()>

where Msg: BorshSerialize + Serialize + Send + Sync + 'static,

Issue an async Notification to the server (no response is expected)

Following are the trait requirements on the arguments:

• Ops: OpsT
• Msg: MsgT

pub async fn call<Req, Resp>(&self, op: Ops, req: Req) -> Result<Resp>

where Req: MsgT, Resp: MsgT,

Issue an async wRPC call and wait for response.

Following are the trait requirements on the arguments:

• Ops: OpsT
• Req: MsgT
• Resp: MsgT

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

Triggers a disconnection on the underlying WebSocket. This is intended for debug purposes only. Can be used to test application reconnection logic.

Trait Implementations

impl<Ops, Id> Clone for RpcClient<Ops, Id>

where Ops: OpsT + Clone, Id: IdT + Clone,

fn clone(&self) -> RpcClient<Ops, Id>

Returns a copy of the value.

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

Performs copy-assignment from source.