SessionManager

zoe_client::session_manager

Struct SessionManager

pub struct SessionManager<S: StateStorage + 'static, M: MessagesManagerTrait + 'static> {
    storage: Arc<S>,
    messages_manager: Arc<M>,
    pqxdh_handlers: RwLock<BTreeMap<PqxdhInboxProtocol, (Arc<PqxdhProtocolHandler<M>>, JoinHandle<()>)>>,
    group_manager: GroupManager,
    group_manager_task: JoinHandle<()>,
    client_keypair: Arc<KeyPair>,
}

Expand description

State synchronization manager that automatically listens to and persists state changes.

This manager follows the persistent messenger pattern:

External objects register with the manager
The manager listens to their state changes
State changes are automatically persisted to storage
State change events are broadcast to subscribers

The SessionManager is designed to be long-lived and handles the lifecycle of multiple PQXDH protocol handlers and group encryption sessions, automatically managing their state persistence and providing reactive access to state changes.

Fields§

§storage: Arc<S>

Underlying state storage

§messages_manager: Arc<M>

Messages manager for subscription and message handling

§pqxdh_handlers: RwLock<BTreeMap<PqxdhInboxProtocol, (Arc<PqxdhProtocolHandler<M>>, JoinHandle<()>)>>

PQXDH handlers with their background listener tasks

§group_manager: GroupManager

Group manager instance with background listener task

§group_manager_task: JoinHandle<()>§client_keypair: Arc<KeyPair>

Implementations§

impl<S: StateStorage + 'static, M: MessagesManagerTrait + 'static> SessionManager<S, M>

pub fn builder( storage: Arc<S>, messages_manager: Arc<M>, ) -> SessionManagerBuilder<S, M>

Create a new SessionManager builder

§Arguments

storage - The state storage backend
messages_manager - The messages manager for subscription and message handling

§Returns

A SessionManagerBuilder for configuring and building the SessionManager

pub fn storage(&self) -> &Arc<S>

Get a reference to the underlying storage

pub fn messages_manager(&self) -> &Arc<M>

Get a reference to the messages manager

pub async fn pqxdh_handler( &self, protocol: PqxdhInboxProtocol, ) -> SessionManagerResult<Arc<PqxdhProtocolHandler<M>>>

impl<S: StateStorage + 'static, M: MessagesManagerTrait + 'static> SessionManager<S, M>

Group Manager Integration

async fn init_group_manager( storage: Arc<S>, client_keypair: Arc<KeyPair>, ) -> SessionManagerResult<(GroupManager, JoinHandle<()>)>

Initialize group manager with listener task

pub fn group_manager(&self) -> GroupManager

Get access to the group manager

impl<S: StateStorage + 'static, M: MessagesManagerTrait + 'static> SessionManager<S, M>

Live Object Access and State Cloning

async fn load_pqxdh_states( storage: Arc<S>, messages_manager: Arc<M>, client_keypair: Arc<KeyPair>, namespace: StateNamespace, ) -> SessionManagerResult<Vec<(PqxdhInboxProtocol, (Arc<PqxdhProtocolHandler<M>>, JoinHandle<()>))>>

Load PQXDH states from storage

async fn init_pqxdh_handler( storage: Arc<S>, handler_id: PqxdhInboxProtocol, handler: Arc<PqxdhProtocolHandler<M>>, namespace: StateNamespace, persist_initial_state: bool, ) -> SessionManagerResult<(PqxdhInboxProtocol, (Arc<PqxdhProtocolHandler<M>>, JoinHandle<()>))>

Auto Trait Implementations§

impl<S, M> !Freeze for SessionManager<S, M>

impl<S, M> !RefUnwindSafe for SessionManager<S, M>

impl<S, M> Send for SessionManager<S, M>

impl<S, M> Sync for SessionManager<S, M>

impl<S, M> Unpin for SessionManager<S, M>

impl<S, M> !UnwindSafe for SessionManager<S, M>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Classify for T

type Classified = T

fn classify(self) -> T

impl<T> Classify for T

type Classified = T

fn classify(self) -> T

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> Declassify for T

type Declassified = T

fn declassify(self) -> T

impl<T> Declassify for T

type Declassified = T

fn declassify(self) -> T

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> DartSafe for T

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> TaskRetFutTrait for T
where T: Send,