Struct arti_rpcserver::connection::Connection

pub struct Connection {
    inner: Mutex<Inner>,
    dispatch_table: Arc<RwLock<DispatchTable>>,
    connection_id: ConnectionId,
    global_id_mac_key: MacKey,
    mgr: Weak<RpcMgr>,
}

An open connection from an RPC client.

Tracks information that persists from one request to another.

The client might not have authenticated; access and permissions control is handled via the capability system. Specifically, the objects table in Inner hold capabilities that the client will use to do things, including an RpcSession.

Fields

inner: Mutex<Inner>

The mutable state of this connection.

dispatch_table: Arc<RwLock<DispatchTable>>

Lookup table to find the implementations for methods based on RPC object and method types.

NOTE: observe the Lock hierarchy

connection_id: ConnectionId

A unique identifier for this connection.

This kind of ID is used to refer to the connection from outside of the context of an RPC connection: it can uniquely identify the connection from e.g. a SOCKS session so that clients can attach streams to it.

global_id_mac_key: MacKey

A MacKey used to create GlobalIds for the objects whose identifiers need to exist outside this connection.

mgr: Weak<RpcMgr>

A reference to the manager associated with this session.

Implementations

impl Connection

pub(crate) fn new( connection_id: ConnectionId, dispatch_table: Arc<RwLock<DispatchTable>>, global_id_mac_key: MacKey, mgr: Weak<RpcMgr> ) -> Self

Create a new connection.

fn id_into_local_idx(&self, id: &ObjectId) -> Result<GenIdx, LookupError>

If possible, convert an ObjectId into a GenIdx that can be used in this connection’s ObjMap.

pub(crate) fn lookup_object( self: &Arc<Self>, id: &ObjectId ) -> Result<Arc<dyn Object>, LookupError>

Look up a given object by its object ID relative to this connection.

pub(crate) fn lookup_by_idx( self: &Arc<Self>, idx: GenIdx ) -> Option<Arc<dyn Object>>

As lookup_object, but expect a GenIdx.

fn remove_request(&self, id: &RequestId)

Un-register the request id and stop tracking its information.

fn register_request(&self, id: RequestId, handle: CancelHandle)

Register the request id as a cancellable request.

pub async fn run<IN, OUT>( self: Arc<Self>, input: IN, output: OUT ) -> Result<(), ConnectionError>

where IN: AsyncRead + Send + Sync + Unpin + 'static, OUT: AsyncWrite + Send + Sync + Unpin + 'static,

Run in a loop, decoding JSON requests from input and writing JSON responses onto output.

pub(crate) async fn run_loop( self: Arc<Self>, request_stream: Pin<Box<dyn FusedStream<Item = Result<FlexibleRequest, JsonCodecError>> + Send>>, response_sink: Pin<Box<dyn Sink<BoxedResponse, Error = JsonCodecError> + Send>> ) -> Result<(), ConnectionError>

Run in a loop, handling requests from request_stream and writing responses onto response_stream.

async fn run_method_and_deliver_response( self: &Arc<Self>, tx_response: Sender<BoxedResponse>, request: Request )

Invoke request and send all of its responses to tx_response.

async fn run_method_lowlevel( self: &Arc<Self>, tx_updates: BoxedUpdateSink, obj: ObjectId, method: Box<dyn DeserMethod> ) -> Result<Box<dyn Serialize + Send + 'static>, RpcError>

Run a single method, and return its final response.

If tx_updates is provided, and this method generates updates, it should send those updates on tx_updates

Note that this function is able to send responses with IDs that do not match the original. It should enforce correct IDs on whatever response it generates.

pub(crate) fn mgr(&self) -> Result<Arc<RpcMgr>, MgrDisappearedError>

Try to get a strong reference to the RpcMgr for this connection, and return an error if we can’t.

Trait Implementations

impl Object for Connection

where Connection: Send + Sync + 'static,

fn get_cast_table(&self) -> &CastTable

Return a CastTable that can be used to downcast a dyn Object of this type into various kinds of dyn Trait references.

fn expose_outside_of_session(&self) -> bool

Return true if this object should be given an identifier that allows it to be used outside of the session that generated it.