Struct arti_rpcserver::mgr::RpcMgr

pub struct RpcMgr {
    global_id_mac_key: MacKey,
    dispatch_table: Arc<RwLock<DispatchTable>>,
    session_factory: Box<dyn Fn(&RpcAuthentication) -> Arc<RpcSession> + Send + Sync>,
    inner: Mutex<Inner>,
}

Shared state, configuration, and data for all RPC sessions.

An RpcMgr knows how to listen for incoming RPC connections, and launch sessions based on them.

TODO RPC: Actually not all of the above functionality is implemented yet. But it should be.

Fields

global_id_mac_key: MacKey

A key that we use to ensure that identifiers are unforgeable.

When giving out a global (non-session-bound) identifier, we use this key to authenticate the identifier when it’s given back to us.

We make copies of this key when constructing a session.

dispatch_table: Arc<RwLock<DispatchTable>>

Our reference to the dispatch table used to look up the functions that implement each object on each.

Shared with each Connection.

NOTE: observe the Lock hierarchy

session_factory: Box<dyn Fn(&RpcAuthentication) -> Arc<RpcSession> + Send + Sync>

A function that we use to construct new Session objects when authentication is successful.

inner: Mutex<Inner>

Lock-protected view of the manager’s state.

NOTE: observe the Lock hierarchy

This mutex is at an inner level compared to the per-Connection locks. You must not take any per-connection lock if you hold this lock. Code that holds this lock must be checked to make sure that it doesn’t then acquire any Connection lock.

Implementations

impl RpcMgr

pub fn new<F>(make_session: F) -> Arc<Self>

where F: Fn(&RpcAuthentication) -> Arc<RpcSession> + Send + Sync + 'static,

Create a new RpcMgr.

pub fn new_connection(self: &Arc<Self>) -> Arc<Connection>

Start a new session based on this RpcMgr, with a given TorClient.

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

Look up an object in the context of this RpcMgr.

Some object identifiers exist in a manager-global context, so that they can be used outside of a single RPC session. This function looks up an object by such an identifier string. It returns an error if the identifier is invalid or the object does not exist.

pub(crate) fn lookup_by_global_id( &self, id: &GlobalId ) -> Option<Arc<dyn Object>>

As lookup_object, but takes a parsed and validated GlobalId.

pub(crate) fn create_session(&self, auth: &RpcAuthentication) -> Arc<RpcSession>

Construct a new object to serve as the session for a connection.