Struct SessionLock 

pub struct SessionLock { /* private fields */ }

Represents a lock on a session for exclusive message processing.

A session lock ensures that only one consumer can process messages from a session at a time, maintaining FIFO ordering guarantees. Locks have an expiration time and can be renewed to extend processing time.

Design

• Expiration: Locks automatically expire after a timeout period
• Renewal: Locks can be renewed before expiration to extend processing
• Owner Tracking: Each lock tracks which consumer owns it
• Timeout Handling: Expired locks can be acquired by other consumers

Example

use queue_runtime::sessions::SessionLock;
use queue_runtime::message::SessionId;
use std::time::Duration;

let session_id = SessionId::new("user-123".to_string()).unwrap();
let lock = SessionLock::new(session_id.clone(), "consumer-1".to_string(), Duration::from_secs(30));

assert!(!lock.is_expired());
assert_eq!(lock.owner(), "consumer-1");

Implementations

impl SessionLock

pub fn new( session_id: SessionId, owner: String, lock_duration: Duration, ) -> Self

Create a new session lock.

Arguments

• session_id - The session being locked
• owner - Identifier of the consumer owning this lock
• lock_duration - How long the lock is valid before expiration

Returns

A new session lock that expires after lock_duration

pub fn session_id(&self) -> &SessionId

Get the session ID this lock is for.

pub fn owner(&self) -> &str

Get the owner of this lock.

pub fn acquired_at(&self) -> Instant

Get when this lock was acquired.

pub fn expires_at(&self) -> Instant

Get when this lock expires.

pub fn lock_duration(&self) -> Duration

Get the configured lock duration.

pub fn is_expired(&self) -> bool

Check if this lock has expired.

Returns

true if the current time is past the expiration time

pub fn time_remaining(&self) -> Duration

Get the remaining time before this lock expires.

Returns

Duration until expiration, or zero if already expired

pub fn renew(&self, extension: Duration) -> Self

Renew this lock, extending its expiration time.

Arguments

• extension - How long to extend the lock by

Returns

A new lock with updated expiration time

Trait Implementations

impl Clone for SessionLock

fn clone(&self) -> SessionLock

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SessionLock

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

Formats the value using the given formatter.