Skip to main content

Session

Struct Session 

Source
pub struct Session {
    id: SessionId,
    is_mcp: bool,
    last_activity: Mutex<Instant>,
    sender: UnboundedSender<SessionMessage>,
    connection_count: AtomicU32,
    shutdown_requested: AtomicBool,
    pack_names: RwLock<BTreeMap<String, String>>,
    jobs: Arc<JobRegistry>,
    settings: RwLock<Arc<Settings>>,
    queued: AtomicUsize,
    diagnostics_check: Mutex<Option<DiagnosticsCheck>>,
}
Expand description

A session represents a single client’s connection state.

Each session has its own background thread for processing commands, ensuring complete isolation between clients.

Fields§

§id: SessionId

Unique identifier for this session.

§is_mcp: bool

Whether this is the session of the MCP clients, removed by inactivity instead of by connection count.

§last_activity: Mutex<Instant>

Instant of the last command sent to this session’s background thread.

Only updated by Session::call, so it reflects actual work, not transport-level pings.

§sender: UnboundedSender<SessionMessage>

Sender to communicate with this session’s background thread.

§connection_count: AtomicU32

Number of active connections using this session.

§shutdown_requested: AtomicBool

Whether this session has been marked for shutdown.

§pack_names: RwLock<BTreeMap<String, String>>

Names of the packs currently open in this session, by pack key.

§jobs: Arc<JobRegistry>

Jobs of this session.

§settings: RwLock<Arc<Settings>>

Settings the session runs with. Behind an Arc so requests can hold them without copying.

§queued: AtomicUsize

Amount of requests sent to the background thread that it hasn’t started yet.

§diagnostics_check: Mutex<Option<DiagnosticsCheck>>

The last diagnostics check requested, so a new one can replace it.

Implementations§

Source§

impl Session

Source

pub fn new(id: SessionId, is_mcp: bool) -> Arc<Self> ⓘ

Create a new session with its own background thread.

is_mcp marks the session of the MCP clients, which is removed by inactivity instead of by connection count (see Session::is_mcp).

Source

fn start_autosave_timer(session: &Arc<Self>)

Starts the timer asking the background thread to autosave the changed packs, every autosave_interval minutes of the settings.

An interval of 0 disables autosaves. The timer stops when the session shuts down or is dropped.

Source

pub fn id(&self) -> SessionId

Get the session ID.

Source

pub fn is_mcp(&self) -> bool

Whether this is the session of the MCP clients.

Source

fn touch(&self)

Record that a command was just sent to this session’s background thread.

Source

pub fn last_activity(&self) -> Instant

Get the instant of the last command sent to this session.

Source

pub fn connect(&self)

Increment the connection count.

Source

pub fn disconnect(&self)

Decrement the connection count.

Source

pub fn connection_count(&self) -> u32

Get the current connection count.

Source

pub fn is_shutdown_requested(&self) -> bool

Check if shutdown has been requested.

Source

pub fn pack_names(&self) -> Vec<String>

Get the names of the packs open in this session.

Source

pub fn set_pack_name(&self, pack_key: &str, name: &str)

Set the name of an open pack of this session, adding it if it’s not there yet.

Source

pub fn remove_pack(&self, pack_key: &str)

Remove a pack from the open ones of this session.

Source

pub fn shutdown(&self)

Shutdown this session by stopping its background thread.

Source

pub fn jobs(&self) -> &Arc<JobRegistry> ⓘ

Returns the jobs of this session.

Source

pub fn settings(&self) -> Arc<Settings> ⓘ

Returns the settings of this session.

Source

fn configure(&self, request: RpcRequest) -> RpcResponse

Replaces the settings of this session, applying their telemetry choices to the whole process.

Source

pub fn call(&self, request: RpcRequest) -> UnboundedReceiver<RpcResponse>

Send a request to this session’s background thread.

Configuration and job control requests are answered without waiting for the background thread, and jobs are answered right away with their ID, before they run.

Returns a receiver to get the response.

Source

fn enqueue( &self, message: SessionMessage, ) -> Result<(), SendError<SessionMessage>>

Sends a request to the background thread, counting it as queued until the thread starts it.

Source

pub fn dequeued(&self)

Marks a request sent to the background thread as started.

Source

pub fn has_queued_requests(&self) -> bool

Returns if there are requests waiting for the background thread.

Source

fn replace_diagnostics_check(&self, job: u64, request: RpcRequest) -> RpcRequest

Makes a new diagnostics check replace the last one, if it hasn’t ended yet.

The new check also checks the paths the replaced one would have checked. A queued replaced check is cancelled, and a running one is cancelled once it stops for the new one (see Self::requeue_diagnostics_check).

§Arguments
  • job - Job of the new check.
  • request - Request of the new check.
§Returns

The request of the new check, with the paths of the replaced one added.

Source

pub fn requeue_diagnostics_check(&self, job: u64, request: RpcRequest)

Queues again a diagnostics check that stopped to let other requests run, or cancels it if a newer one replaced it.

§Arguments
  • job - Job of the check.
  • request - Request of the check.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> MaybeSend for T

§

impl<T> MaybeSync for T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more