Struct xi_rpc::RawPeer

pub struct RawPeer<W: Write + 'static>(_);

An interface to access the other side of the RPC channel. The main purpose is to send RPC requests and notifications to the peer.

A single shared RawPeer exists for each RpcLoop; a reference can be taken with RpcLoop::get_peer().

In general, RawPeer shouldn't be used directly, but behind a pointer as the Peer trait object.

Trait Implementations

impl<W: Write + Send + 'static> Peer for RawPeer<W>

fn box_clone(&self) -> Box<dyn Peer>

Used to implement clone in an object-safe way. For an explanation on this approach, see this thread.

fn send_rpc_notification(&self, method: &str, params: &Value)

Sends a notification (asynchronous RPC) to the peer.

fn send_rpc_request_async(
    &self,
    method: &str,
    params: &Value,
    f: Box<dyn Callback>
)

Sends a request asynchronously, and the supplied callback will be called when the response arrives.

fn send_rpc_request(&self, method: &str, params: &Value) -> Result<Value, Error>

Sends a request (synchronous RPC) to the peer, and waits for the result.

fn request_is_pending(&self) -> bool

Determines whether an incoming request (or notification) is pending. This is intended to reduce latency for bulk operations done in the background.

fn schedule_idle(&self, token: usize)

Adds a token to the idle queue. When the runloop is idle and the queue is not empty, the handler's idle fn will be called with the earliest added token.

fn schedule_timer(&self, after: Instant, token: usize)

Like schedule_idle, with the guarantee that the handler's idle fn will not be called before the provided Instant.

impl<W: Write> Clone for RawPeer<W>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.