Struct RpcSession 

pub struct RpcSession {
    client: Arc<dyn Client>,
    superuser: Mutex<Option<Arc<dyn Object>>>,
}

An authenticated RPC session: a capability through which most other RPC functionality is available

This relates to Connection as follows:

• A Connection exists prior to authentication; whereas an RpcSession comes into being as a result of authentication.

• The RpcSession is principally owned by the Connection’s object table.

• Typically, after authentication, there is one RpcSession for the Connection. But a client may authenticate more than once; each time produces a new RpcSession.

In the arti rpc system

Base type for an authenticated RPC session.

Upon successful authentication via auth:authenticate, a connection will return either a Session object of this type, or a Session object that wraps this type. All other useful objects are available via an RPC session.

This ObjectID for this object can be used as the target of a SOCKS stream.

Fields

client: Arc<dyn Client>

An inner TorClient object that we use to implement remaining functionality.

superuser: Mutex<Option<Arc<dyn Object>>>

A superuser object representing administrative capability.

If this object is absent, this session never had this capability, or dropped it.

Implementations

impl RpcSession

pub fn new_with_client<R: Runtime>(client: Arc<TorClient<R>>) -> Arc<Self>

Create a new session object containing a single client object.

pub fn provide_superuser_permission(&self, superuser: Arc<dyn Object>)

Set the superuser object for this session to superuser.

Calling this function indicates that this session has administrative privilege.

fn client_as_object(&self) -> Arc<dyn Object>

Return a view of the client associated with this session, as an Arc<dyn rpc::Object>.

Trait Implementations

impl Object for RpcSession

where RpcSession: Send + Sync + 'static,

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.

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 delegate(&self) -> Option<Arc<dyn Object>>

Optionally, return a delegation target for this `Object``.