Struct RequestHandle

pub struct RequestHandle {
    conn: Mutex<Arc<Receiver>>,
    id: AnyRequestId,
}

A handle to an open request.

These handles are created with RpcConn::execute_with_handle.

Note that dropping a RequestHandle does not cancel the associated request: it will continue running, but you won’t have a way to receive updates from it. To cancel a request, use RpcConn::cancel.

Fields

conn: Mutex<Arc<Receiver>>

The underlying Receiver that we’ll use to get updates for this request

It’s wrapped in a Mutex to prevent concurrent calls to Receiver::wait_on_message_for.

id: AnyRequestId

The ID of this request.

Implementations

impl RequestHandle

pub fn id(&self) -> &AnyRequestId

Return the ID of this request, to help cancelling it.

pub fn wait(self) -> Result<Result<SuccessResponse, ErrorResponse>, ProtoError>

Wait for success or failure, and return what happened.

(Ignores any update messages that are received.)

Note that this function will return Err(.) only if sending the command or getting a response failed. If the command was sent successfully, and Arti reported an error in response, this function returns Ok(Err(.)).

pub fn wait_with_updates(&self) -> Result<AnyResponse, ProtoError>

Wait for the next success, failure, or update from this handle.

Note that this function will return Err(.) only if sending the command or getting a response failed. If the command was sent successfully, and Arti reported an error in response, this function returns Ok(AnyResponse::Error(.)).

You may call this method on the same RequestHandle from multiple threads. If you do so, those calls will receive responses (or errors) in an unspecified order.

If this function returns Success or Error, then you shouldn’t call it again. All future calls to this function will fail with CmdError::RequestCancelled. (TODO RPC: Maybe rename that error.)

Trait Implementations

impl Debug for RequestHandle

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

Formats the value using the given formatter.