pub struct SessionManager { /* private fields */ }Expand description
Manages session lifecycle: create, suspend, resume, expire.
Framework-agnostic — the user’s WebSocket integration code is responsible for calling the lifecycle methods at the right times (on connect, on message, on disconnect).
Mirrors the Go SDK’s SessionManager and the Swift SDK’s
SessionManager in shape.
§Example
use hypen_server::remote::SessionManager;
let manager = SessionManager::new(Default::default());
// On connect:
let session = manager.create_session(Default::default());
manager.track_connection(&session.id, conn_id);
// On disconnect:
manager.untrack_connection(&session.id, conn_id);
if manager.connection_count(&session.id) == 0 {
let state = /* snapshot state */;
manager.suspend_session(&session.id, state, || { /* on expire */ });
}
// On reconnect (client sends hello with session_id):
if let Some(pending) = manager.resume_session(&session_id) {
// Apply pending.saved_state to the new session
}Implementations§
Source§impl SessionManager
impl SessionManager
Sourcepub fn new(config: SessionManagerConfig) -> Self
pub fn new(config: SessionManagerConfig) -> Self
Create a new session manager with the given configuration.
Sourcepub fn create_session(&self, props: HashMap<String, Value>) -> SessionInfo
pub fn create_session(&self, props: HashMap<String, Value>) -> SessionInfo
Create a new active session.
Sourcepub fn get_active_session(&self, id: &str) -> Option<SessionInfo>
pub fn get_active_session(&self, id: &str) -> Option<SessionInfo>
Get an active session by ID.
Sourcepub fn suspend_session<F>(
&self,
id: &str,
saved_state: Value,
on_expire: F,
) -> bool
pub fn suspend_session<F>( &self, id: &str, saved_state: Value, on_expire: F, ) -> bool
Suspend an active session with a saved state snapshot.
The on_expire callback fires after the TTL elapses without a
reconnect. If resume_session is called before the TTL, the
callback is cancelled.
Returns true if the session was suspended, false if no active
session with the given ID exists.
Sourcepub fn resume_session(&self, id: &str) -> Option<PendingSession>
pub fn resume_session(&self, id: &str) -> Option<PendingSession>
Resume a suspended session. Returns the pending session with its
saved state, or None if the session is unknown or already expired.
Sourcepub fn destroy_session(&self, id: &str)
pub fn destroy_session(&self, id: &str)
Destroy a session (active or pending), cancelling any TTL timer.
Sourcepub fn track_connection(&self, session_id: &str, conn_id: u64)
pub fn track_connection(&self, session_id: &str, conn_id: u64)
Track a connection for a session. conn_id should be a unique
identifier for the connection (e.g. a monotonic counter or hash).
Sourcepub fn untrack_connection(&self, session_id: &str, conn_id: u64)
pub fn untrack_connection(&self, session_id: &str, conn_id: u64)
Untrack a connection.
Sourcepub fn connection_count(&self, session_id: &str) -> usize
pub fn connection_count(&self, session_id: &str) -> usize
Get the number of active connections for a session.
Auto Trait Implementations§
impl !Freeze for SessionManager
impl !RefUnwindSafe for SessionManager
impl !UnwindSafe for SessionManager
impl Send for SessionManager
impl Sync for SessionManager
impl Unpin for SessionManager
impl UnsafeUnpin for SessionManager
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Erasable for T
impl<T> Erasable for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);