Struct Session

Source

pub struct Session {
    pub inner: Arc<Inner>,
}

Expand description

Synchronous AvesTerra client. Exposes the same API as SessionAsync, but all methods are blocking.

This Session is backed by a Tokio runtime and internally uses a SessionAsync.

This makes it possible to switch to using the asynchronous client at any time. See the example [examples/hybrid_sync_async.rs] for an example of how to do that.

WARNING: CALLING .call() WILL PANIC IF USED FROM AN ASYNCHRONOUS CONTEXT. IF YOU WANT TO USE YOUR OWN ASYNCHRONOUS CONTEXT, USE SessionAsync. Session WILL CREATE ITS OWN CONTEXT, AND THERE SHOULD ONLY BE ONE. (it’s technically possible to have multiple, but you have to be very careful, and it’s probably not what you want anyways).

See SessionAsync for more details.

You need to create the Session with Session::initialize

Fields§

§inner: Arc<Inner>

Struct SessionCopy item path

Fields§

Implementations§

impl Session

pub fn initialize(config: SessionConfig) -> Result<Self>

pub fn finalize(self)

pub fn run_async<'a, Fn, Fut>(&'a self, func: Fn) -> <Fut as Future>::Outputwhere Fn: FnOnce(&'a SessionAsync) -> Fut + Send, Fut: Future + Send + 'a, <Fut as Future>::Output: Send,

impl Session

pub fn invoke_entity( &self, entity: Entity, method: Method, authorization: Token, ) -> InvokeEntity<Self>

impl Session

pub fn create_entity( &self, name: String255, authorization: Token, ) -> CreateEntity<Self>

impl Session

pub fn delete_entity( &self, entity: Entity, authorization: Token, ) -> DeleteEntity<Self>

impl Session

pub fn inquire_entity( &self, entity: Entity, attribute: Attribute, authorization: Token, ) -> InquireEntity<Self>

impl Session

pub fn reference_entity( &self, entity: Entity, authorization: Token, ) -> ReferenceEntity<Self>

impl Session

pub fn dereference_entity( &self, entity: Entity, authorization: Token, ) -> DereferenceEntity<Self>

impl Session

pub fn connect_method( &self, entity: Entity, outlet: Entity, authorization: Token, ) -> ConnectMethod<Self>

impl Session

pub fn disconnect_method( &self, entity: Entity, outlet: Entity, method: Method, authorization: Token, ) -> DisconnectMethod<Self>

impl Session

pub fn entity_connection( &self, entity: Entity, index: i64, authorization: Token, ) -> EntityConnection<Self>

impl Session

pub fn attach_attribute( &self, entity: Entity, outlet: Entity, authorization: Token, ) -> AttachAttribute<Self>

impl Session

pub fn detach_attribute( &self, entity: Entity, outlet: Entity, attribute: Attribute, authorization: Token, ) -> DetachAttribute<Self>

impl Session

pub fn entity_attachment( &self, entity: Entity, index: i64, authorization: Token, ) -> EntityAttachment<Self>

impl Session

pub fn activate_outlet( &self, outlet: Entity, authorization: Token, ) -> ActivateOutlet<Self>

impl Session

pub fn deactivate_outlet( &self, outlet: Entity, authorization: Token, ) -> DeactivateOutlet<Self>

impl Session

pub fn reset_outlet( &self, outlet: Entity, authorization: Token, ) -> ResetOutlet<Self>

impl Session

pub fn publish_event( &self, entity: Entity, event: Event, authorization: Token, ) -> PublishEvent<Self>

impl Session

pub fn subscribe_event( &self, entity: Entity, outlet: Entity, authorization: Token, ) -> SubscribeEvent<Self>

impl Session

pub fn unsubscribe_event( &self, entity: Entity, outlet: Entity, event: Event, authorization: Token, ) -> UnsubscribeEvent<Self>

impl Session

pub fn wait_event( &self, outlet: Entity, authorization: Token, ) -> WaitEvent<Self>

impl Session

pub fn subscribe_entity( &self, entity: Entity, outlet: Entity, event: Event, authorization: Token, ) -> SubscribeEntity<Self>

impl Session

pub fn lock_outlet( &self, outlet: Entity, authorization: Token, ) -> LockOutlet<Self>

impl Session

pub fn unlock_outlet( &self, outlet: Entity, authorization: Token, ) -> UnlockOutlet<Self>

impl Session

pub fn authorize_entity( &self, entity: Entity, authority: Token, authorization: Token, ) -> AuthorizeEntity<Self>

impl Session

pub fn deauthorize_entity( &self, entity: Entity, authority: Token, authorization: Token, ) -> DeauthorizeEntity<Self>

impl Session

pub fn entity_authorized( &self, entity: Entity, authority: Token, authorization: Token, ) -> EntityAuthorized<Self>

impl Session

pub fn entity_authority( &self, entity: Entity, authorization: Token, ) -> EntityAuthority<Self>

impl Session

pub fn entity_name( &self, entity: Entity, authorization: Token, ) -> EntityName<Self>

impl Session

pub fn entity_class( &self, entity: Entity, authorization: Token, ) -> EntityClass<Self>

impl Session

pub fn entity_category( &self, entity: Entity, authorization: Token, ) -> EntityCategory<Self>

impl Session

pub fn local_server(&self, authorization: Token) -> LocalServer<Self>

impl Session

pub fn local_version(&self) -> LocalVersion<Self>

impl Session

pub fn entity_redirection( &self, entity: Entity, authorization: Token, ) -> EntityRedirection<Self>

impl Session

pub fn entity_redirect( &self, auxiliary: Entity, ancillary: Entity, authorization: Token, ) -> EntityRedirect<Self>

impl Session

pub fn change_entity( &self, entity: Entity, authorization: Token, ) -> ChangeEntity<Self>

impl Session

pub fn entity_timestamp( &self, entity: Entity, authorization: Token, ) -> EntityTimestamp<Self>

impl Session

pub fn entity_available( &self, entity: Entity, authorization: Token, ) -> EntityAvailable<Self>

impl Session

Struct Session

pub fn run_async<'a, Fn, Fut>(&'a self, func: Fn) -> <Fut as Future>::Output
where Fn: FnOnce(&'a SessionAsync) -> Fut + Send, Fut: Future + Send + 'a, <Fut as Future>::Output: Send,