Struct GraphSessionManager 

pub struct GraphSessionManager { /* private fields */ }

Implementations

impl GraphSessionManager

pub fn new( host_addr: String, max_connections: usize, session_idle_timeout: Duration, ) -> Arc<Self>

Create a new session manager.

This constructor does not automatically initiate background cleanup tasks. Need to explicitly call start_cleanup_task() to start

pub fn new_with_shared( host_addr: String, max_connections: usize, session_idle_timeout: Duration, shared: Arc<EventSubscriptions<SessionEvent>>, ) -> Arc<Self>

Build a manager sharing one session-event registry with QueryManager.

pub fn shared_session_callbacks(&self) -> Arc<EventSubscriptions<SessionEvent>>

Shared session-event registry behind this manager.

pub fn mask_session_id(session_id: i64) -> String

Mask a session id for logs: prefix plus a short hash only.

pub fn idle_timeout(&self) -> Duration

Session idle timeout driving reclamation and expiry responses.

pub fn set_default_auto_commit(&self, auto_commit: bool)

Set the auto-commit mode applied to sessions created from now on.

pub fn set_shared_session_callbacks( &mut self, shared: Arc<EventSubscriptions<SessionEvent>>, )

Point this manager at a shared session-event registry.

The field is an Arc, so an already-published instance needs &mut access to switch sources; managers behind Arc should prefer new_with_shared at construction time instead.

pub fn register_session_callback( &self, callback: SessionEventCallback, ) -> SubscriptionId

Register a runtime observer for session lifecycle events.

pub fn register_session_callback_filtered( &self, callback: SessionEventCallback, filter: EventFilter<SessionEvent>, ) -> SubscriptionId

Register a filtered observer invoked only when filter returns true.

pub fn unregister_session_callback(&self, id: SubscriptionId) -> bool

Remove a previously registered observer. Returns true if present.

pub fn session_callback_count(&self) -> usize

Number of registered session observers.

pub async fn start_cleanup_task(self: &Arc<Self>)

Start the background session cleanup task.

If the task is already running, this method will not start it again.

pub fn stop_cleanup_task(&self)

Stop the background session cleaning task.

Set a stop flag; the background task will exit during the next iteration.

pub fn is_cleanup_task_running(&self) -> bool

Check whether the background cleanup task is currently running.

pub async fn create_session( &self, user_name: String, _client_ip: String, ) -> Result<Arc<ClientSession>, String>

Creates a new session

pub fn find_session(&self, session_id: i64) -> Option<Arc<ClientSession>>

Finds an existing session

pub fn find_session_from_cache( &self, session_id: i64, ) -> Option<Arc<ClientSession>>

Finds an existing session only from local cache

pub async fn remove_session(&self, session_id: i64)

Removes a session from local cache

pub async fn remove_sessions_by_username( &self, username: &str, except_session_id: Option<i64>, ) -> Vec<i64>

Invalidate all sessions of a user, optionally keeping one session.

Used when a user is disabled or dropped so existing sessions stop working immediately. Returns the removed session ids.

pub fn get_sessions_from_local_cache(&self) -> Vec<Session>

Gets all sessions from the local cache

pub async fn list_sessions(&self) -> Vec<SessionInfo>

Obtain information about the session list, which is used for the SHOW SESSIONS command.

pub async fn get_session_info(&self, session_id: i64) -> Option<SessionInfo>

Obtain detailed information about the specified session.

pub async fn kill_session( &self, session_id: i64, current_user: &str, is_admin: bool, ) -> SessionResult<()>

Terminate the specified session (KILL SESSION)

Parameters

session_id – The ID of the session that needs to be terminated. current_user – The username of the user who is performing the termination operation. is_admin – Determines whether the current user has the Admin role.

Return

• Ok(()) - Successfully terminate the session
• Err(SessionError) - Specific reasons for termination failure

pub async fn kill_multiple_sessions( &self, session_ids: &[i64], current_user: &str, is_admin: bool, ) -> Vec<SessionResult<()>>

Batch termination of multiple sessions

pub async fn is_out_of_connections(&self) -> bool

Whether exceeds the max allowed connections

pub async fn active_session_count(&self) -> usize

Obtain the number of active sessions

pub fn total_sessions_created(&self) -> u64

Cumulative number of sessions created since process start.

pub fn max_connections(&self) -> usize

Obtaining the maximum limit for the number of connections

Trait Implementations

impl Debug for GraphSessionManager

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

Formats the value using the given formatter.