Skip to main content

SessionCache

Struct SessionCache 

Source
pub struct SessionCache { /* private fields */ }
Expand description

Thread-safe in-memory TLS session cache

Stores session tickets for TLS 1.3 resumption. This enables clients to reconnect without performing full handshakes, reducing latency by 50-70%.

Pass the same cache (in an Arc) to every TlsClient::connect_with_session call: the TLS layer stores the server’s session tickets in it and offers them on the next connection to the same server name. Those TLS tickets are kept in a rustls session store bounded by max_entries and expire as the server’s ticket lifetime says; default_ttl applies to entries added with store.

rustls only resumes a session with the same certificate verifier that checked the original connection, so the cache also keeps the TLS client configuration built for each distinct TlsClientConfig and reuses it. Certificate, key and CA files are therefore read on the first connection with a given configuration; call clear after replacing those files.

Implementations§

Source§

impl SessionCache

Source

pub fn new(max_entries: usize, default_ttl: Duration) -> Self

Create a new session cache

§Arguments
  • max_entries - Maximum number of sessions to cache (e.g., 1000)
  • default_ttl - Default time-to-live for each session (e.g., 1 hour)
§Example
ⓘ
let cache = SessionCache::new(1000, Duration::from_secs(3600));
Source

pub async fn store<S: Into<String>>(&self, session_id: S, ticket: Vec<u8>)

Store a session ticket in the cache

This is typically called by the TLS layer after establishing a connection. Automatically manages eviction when cache is full.

§Arguments
  • session_id - Unique session identifier
  • ticket - Serialized TLS session ticket
Source

pub async fn get(&self, session_id: &str) -> Option<Arc<Vec<u8>>>

Retrieve a session ticket from the cache

Returns the ticket if found and not expired, None otherwise.

§Example
ⓘ
if let Some(ticket) = cache.get("session-123").await {
    // Use ticket for resumption
}
Source

pub async fn clear(&self)

Clear all sessions from the cache

Source

pub async fn stats(&self) -> SessionCacheStats

Get current cache statistics

Trait Implementations§

Source§

impl Clone for SessionCache

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

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

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