Struct rpc_it::rpc::Handle

pub struct Handle { /* private fields */ }

Handle to control RPC driver instance.

Implementations

impl Handle

pub fn downgrade(this: &Self) -> WeakHandle

pub fn is_closed(&self) -> bool

Check if this RPC channel was closed.

pub fn try_recv_inbound(&self) -> Result<Inbound, TryRecvError>

Try to receive single inbound from the remote end.

pub async fn recv_inbound(&self) -> Option<Inbound>

Receive single inbound from the remote end asynchronously.

Will return None if the channel is closed.

pub async fn blocking_recv_inbound(&self) -> Option<Inbound>

Receive single inbound from the remote end synchronously.

Will block until an inbound is available, or the channel is closed.

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

Flush all queued write requests. This is simply a function that forwards flush requests to the internal transport layer.

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

Shutdown underlying write stream.

pub fn post_flush(&self) -> Option<()>

pub fn post_shutdown(&self) -> Option<()>

pub fn pending_requests(&self) -> usize

Number of pending requests.

pub async fn request<'a, T: AsRef<[u8]> + 'a + ?Sized>( &self, route: &str, payload: impl IntoIterator<Item = &'a T> ) -> Result<ReplyWait>

Send a request to the remote end, and returns awaitable reply.

pub async fn notify<'a, T: AsRef<[u8]> + 'a + ?Sized>( &self, route: &str, payload: impl IntoIterator<Item = &'a T> ) -> Result<()>

Send a notify to the remote end. This will return after writing all payload to underlying transport.

pub fn post_notify( &self, route: &str, payload: Option<PooledBuffer> ) -> Option<()>

The non-blocking version of the notify function. Instead of waiting for the returned future object to send the message immediately, it pools a new buffer to generate the header and requests a separate write driver task to send it.

Because it pushes a buffer into the channel and immediately returns it, we don’t know if the send operation itself was successful or not.

If the transmission fails because the driver channel is closed, return the buffer you passed in.

pub fn post_request( &self, route: &str, payload: Option<PooledBuffer> ) -> Option<ReplyWait>

The request version of the send-notify function.

pub fn pool(&self) -> &Arc<VecPool>

Pool an empty buffer from the driver’s internal allocator. It is recommended that you do not write values to the buffer beyond the capacity you pass.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.