arti_rpcserver/connection/
methods.rs

Help
1//! Implementations for methods on Connection.
2
3use derive_deftly::Deftly;
4use std::sync::Arc;
5use tor_rpcbase::{self as rpc, templates::*};
6
7use super::Connection;
8
9/// Cancel a single request.
10///
11/// Note that calling this method does not guarantee that the request is actually cancelled:
12/// the request might finish first.
13///
14/// What we do guarantee is that either this method returns successfully and the request is cancelled,
15/// or that this method fails and the request is not cancelled.
16/// We also guarantee that both the request and this method will finish "fairly quickly"
17/// after this method is called.
18///
19/// In Arti's current implementation, a cancel request is itself is not cancellable.
20///
21/// For more information see `rpc-meta-draft.md`.
22#[derive(Debug, serde::Deserialize, Deftly)]
23#[derive_deftly(DynMethod)]
24#[deftly(rpc(method_name = "rpc:cancel", no_cancel))]
25struct RpcCancel {
26    /// The ID for the request that we should try to cancel.
27    request_id: crate::msgs::RequestId,
28}
29
30impl rpc::RpcMethod for RpcCancel {
31    type Output = rpc::Nil;
32    type Update = rpc::NoUpdates;
33}
34
35/// Implement `RpcCancel` on a connection.
36async fn connection_rpc_cancel(
37    conn: Arc<Connection>,
38    cancel: Box<RpcCancel>,
39    _ctx: Arc<dyn rpc::Context>,
40) -> Result<rpc::Nil, super::CancelError> {
41    conn.cancel_request(&cancel.request_id).map(|()| rpc::NIL)
42}
43
44rpc::static_rpc_invoke_fn! {
45    connection_rpc_cancel;
46}
arti_rpcserver/connection/methods.rs

arti_rpcserver/connection/
methods.rs
