Skip to main content

ClientSession

Struct ClientSession 

Source
pub struct ClientSession<W>
where W: WsWriter,
{ pub client_id: Arc<str>, /* private fields */ }
Expand description

A WebSocket client session that manages subscriptions.

When dropped, all subscription guards are dropped, automatically cleaning up all reactive subscriptions.

Fields§

§client_id: Arc<str>

Unique client identifier

Implementations§

Source§

impl<W> ClientSession<W>
where W: WsWriter,

Source

pub fn new(client_id: Arc<str>, writer: W) -> ClientSession<W>

Create a new client session.

Source

pub fn subscribe_query( &mut self, tx: Arc<str>, cell: CellMap<Arc<str>, Arc<dyn AnyItem>, CellImmutable>, window: Option<QueryWindow>, )

Subscribe to a CellMap from a query cell factory.

This is used by WsHandler when the query registration provides a cell factory.

Source

pub fn subscribe_view( &mut self, tx: Arc<str>, cell: CellMap<Arc<str>, Arc<dyn AnyItem>, CellImmutable>, window: Option<QueryWindow>, )

Subscribe to a CellMap from a view cell factory.

Source

pub fn subscribe_view_with_id( &mut self, tx: Arc<str>, view_id: Arc<str>, cell: CellMap<Arc<str>, Arc<dyn AnyItem>, CellImmutable>, window: Option<QueryWindow>, )

Subscribe to a CellMap from a view cell factory with explicit view id for perf logging.

Source

pub fn subscribe_report( &mut self, tx: Arc<str>, report_id: Arc<str>, cell: Cell<Arc<dyn AnyOutput>, CellImmutable>, )

Subscribe to a report cell.

Source

pub fn update_query_window( &mut self, tx: &Arc<str>, window: Option<QueryWindow>, )

Update window for an active query subscription.

Source

pub fn update_view_window(&mut self, tx: &Arc<str>, window: Option<QueryWindow>)

Update window for an active view subscription.

Source

pub fn cancel(&mut self, tx: &Arc<str>)

Cancel a subscription by transaction ID.

Source

pub fn cancel_all(&mut self)

Cancel all subscriptions.

Source

pub fn subscription_count(&self) -> usize

Get the number of active subscriptions.

Source

pub fn has_subscription(&self, tx: &Arc<str>) -> bool

Check if a subscription exists.

Trait Implementations§

Source§

impl<W> Drop for ClientSession<W>
where W: WsWriter,

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<W> Freeze for ClientSession<W>

§

impl<W> !RefUnwindSafe for ClientSession<W>

§

impl<W> Send for ClientSession<W>

§

impl<W> Sync for ClientSession<W>

§

impl<W> Unpin for ClientSession<W>

§

impl<W> UnsafeUnpin for ClientSession<W>

§

impl<W> !UnwindSafe for ClientSession<W>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Fruit for T
where T: Send + Downcast,

Source§

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

Source§

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