Struct darkfi::rpc::client::RpcClient

pub struct RpcClient {
    req_send: Sender<(JsonRequest, bool)>,
    rep_recv: Receiver<JsonResult>,
    req_skip_send: Sender<()>,
    task: StoppableTaskPtr,
}

JSON-RPC client implementation using asynchronous channels.

Fields

req_send: Sender<(JsonRequest, bool)>

The channel used to send JSON-RPC request objects. The bool marks if we should have a reply read timeout.

rep_recv: Receiver<JsonResult>

The channel used to read the JSON-RPC response object.

req_skip_send: Sender<()>

The channel used to skip waiting for a JSON-RPC client request

task: StoppableTaskPtr

The stoppable task pointer, used on RpcClient::stop()

Implementations

impl RpcClient

pub async fn new(endpoint: Url, ex: Arc<Executor<'_>>) -> Result<Self>

Instantiate a new JSON-RPC client that connects to the given endpoint. The function takes an Executor object, which is needed to start the StoppableTask which represents the client-server connection.

pub async fn stop(&self)

Stop the JSON-RPC client. This will trigger stop() on the inner StoppableTaskPtr resulting in stopping the internal reqrep loop and therefore closing the connection.

async fn reqrep_loop( stream: Box<dyn PtStream>, rep_send: Sender<JsonResult>, req_recv: Receiver<(JsonRequest, bool)>, req_skip_recv: Receiver<()>, ) -> Result<()>

Internal function that loops on a given stream and multiplexes the data

pub async fn request(&self, req: JsonRequest) -> Result<JsonValue>

Send a given JSON-RPC request over the instantiated client and return a possible result. If the response is an error, returns a JsonRpcError.

pub async fn oneshot_request(&self, req: JsonRequest) -> Result<JsonValue>

Oneshot send a given JSON-RPC request over the instantiated client and immediately close the channels upon receiving a reply.

pub async fn subscribe( &self, req: JsonRequest, publisher: PublisherPtr<JsonResult>, ) -> Result<()>

Listen instantiated client for notifications. NOTE: Subscriber listeners must perform response handling.