Struct Session 

pub struct Session {
    pub id: SessionId,
    pub name: String,
    pub features: Vec<String>,
    pub created_at: Instant,
    pub last_activity: RwLock<Instant>,
    pub authenticated: bool,
    pub token: Option<String>,
    pub subject: Option<String>,
    /* private fields */
}

A connected client session

Fields

id: SessionId

Unique session ID

name: String

Client name

features: Vec<String>

Client features

created_at: Instant

Session creation time

last_activity: RwLock<Instant>

Last activity time

authenticated: bool

Is authenticated

token: Option<String>

Permission token (if any)

subject: Option<String>

Subject identifier from token (user, device, or service ID)

Implementations

impl Session

pub fn new( sender: Arc<dyn TransportSender>, name: String, features: Vec<String>, ) -> Self

Create a new session

pub fn set_authenticated( &mut self, token: String, subject: Option<String>, scopes: Vec<Scope>, )

Set authentication info from a validated token

pub fn has_scope(&self, action: Action, address: &str) -> bool

Check if this session has permission for the given action on the given address

pub fn has_strict_read_scope(&self, address: &str) -> bool

Check if this session has an explicit read scope for the given address.

Unlike has_scope(Action::Read, ...), this does NOT match write scopes (which normally imply read via Action::Write.allows(Action::Read)). Use this for SUBSCRIBE checks to prevent write-only scopes from granting subscription access to paths they should only write to.

pub fn scopes(&self) -> &[Scope]

Get the scopes for this session

pub async fn send(&self, data: Bytes) -> Result<(), TransportError>

Send a message to this session

pub fn try_send(&self, data: Bytes) -> Result<(), TransportError>

Try to send a message without blocking (for broadcasts) Returns Ok if sent or queued, Err if buffer is full

pub async fn send_message(&self, message: &Message) -> Result<(), Error>

Send a Clasp message

pub fn welcome_message( &self, server_name: &str, server_features: &[String], ) -> Message

Create welcome message for this session

pub fn add_subscription(&self, id: u32)

Add a subscription

pub fn remove_subscription(&self, id: u32) -> bool

Remove a subscription

pub fn subscriptions(&self) -> Vec<u32>

Get all subscription IDs

pub fn is_connected(&self) -> bool

Check if connected

pub fn touch(&self)

Touch to update last activity

pub fn idle_duration(&self) -> Duration

Get idle duration

pub fn check_rate_limit(&self, max_per_second: u32) -> bool

Check and increment rate limit counter Returns true if within rate limit, false if exceeded

pub fn messages_per_second(&self) -> u32

Get current message count for this second

pub fn record_drop(&self) -> bool

Record a dropped message and check if notification is needed. Returns true if a drop notification should be sent to the client.

pub fn total_drops(&self) -> u64

Get the total number of dropped messages for this session

pub fn drops_in_window(&self) -> u32

Get the drops in the current window

Trait Implementations

impl Debug for Session

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.