Struct sshx_server::session::Session

pub struct Session { /* private fields */ }

In-memory state for a single sshx session.

Implementations

impl Session

pub fn snapshot(&self) -> Result<Vec<u8>>

Snapshot the session, returning a compressed representation.

pub fn restore(data: &[u8]) -> Result<Self>

Restore the session from a previous compressed snapshot.

impl Session

pub fn new(metadata: Metadata) -> Self

Construct a new session.

pub fn metadata(&self) -> &Metadata

Returns the metadata for this session.

pub fn counter(&self) -> &IdCounter

Gives access to the ID counter for obtaining new IDs.

pub fn sequence_numbers(&self) -> SequenceNumbers

Return the sequence numbers for current shells.

pub fn subscribe_broadcast( &self, ) -> impl Stream<Item = Result<WsServer, BroadcastStreamRecvError>> + Unpin

Receive a notification on broadcasted message events.

pub fn subscribe_shells( &self, ) -> impl Stream<Item = Vec<(Sid, WsWinsize)>> + Unpin

Receive a notification every time the set of shells is changed.

pub fn subscribe_chunks( &self, id: Sid, chunknum: u64, ) -> impl Stream<Item = (u64, Vec<Bytes>)> + '_

Subscribe for chunks from a shell, until it is closed.

pub fn add_shell(&self, id: Sid, center: (i32, i32)) -> Result<()>

Add a new shell to the session.

pub fn close_shell(&self, id: Sid) -> Result<()>

Terminates an existing shell.

pub fn move_shell(&self, id: Sid, winsize: Option<WsWinsize>) -> Result<()>

Change the size of a terminal, notifying clients if necessary.

pub fn add_data(&self, id: Sid, data: Bytes, seq: u64) -> Result<()>

Receive new data into the session.

pub fn list_users(&self) -> Vec<(Uid, WsUser)>

List all the users in the session.

pub fn update_user(&self, id: Uid, f: impl FnOnce(&mut WsUser)) -> Result<()>

Update a user in place by ID, applying a callback to the object.

pub fn user_scope(&self, id: Uid) -> Result<impl Drop + '_>

Add a new user, and return a guard that removes the user when dropped.

pub fn send_chat(&self, id: Uid, msg: &str) -> Result<()>

Send a chat message into the room.

pub fn send_latency_measurement(&self, latency: u64)

Send a measurement of the shell latency.

pub fn access(&self)

Register a backend client heartbeat, refreshing the timestamp.

pub fn last_accessed(&self) -> Instant

Returns the timestamp of the last backend client activity.

pub fn update_tx(&self) -> &Sender<ServerMessage>

Access the sender of the client message channel for this session.

pub fn update_rx(&self) -> &Receiver<ServerMessage>

Access the receiver of the client message channel for this session.

pub fn sync_now(&self)

Mark the session as requiring an immediate storage sync.

This is needed for consistency when creating new shells, removing old shells, or updating the ID counter. If these operations are lost in a server restart, then the snapshot that contains them would be invalid compared to the current backend client state.

Note that it is not necessary to do this all the time though, since that would put too much pressure on the database. Lost terminal data is already re-synchronized periodically.

pub async fn sync_now_wait(&self)

Resolves when the session has been marked for an immediate sync.

pub fn shutdown(&self)

Send a termination signal to exit this session.

pub async fn terminated(&self)

Resolves when the session has received a shutdown signal.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.