ServerSession

Struct ServerSession 

Source
pub struct ServerSession<S: SyncState> { /* private fields */ }
Available on crate feature server only.
Expand description

Per-client session.

Implementations§

Source§

impl<S: SyncState> ServerSession<S>

Source

pub fn new( id: ServerSessionId, client_addr: SocketAddr, client_public_key: [u8; 32], initial_state: S, ) -> Self

Create a new session.

Source

pub fn id(&self) -> ServerSessionId

Get the session ID.

Source

pub fn client_addr(&self) -> SocketAddr

Get the client address.

Source

pub fn client_public_key(&self) -> &[u8; 32]

Get the client’s public key.

Source

pub fn state(&self) -> SessionState

Get the session state.

Source

pub fn set_state(&mut self, state: SessionState)

Set the session state.

Source

pub fn server_state(&self) -> &S

Get the current server state.

Source

pub fn server_state_mut(&mut self) -> &mut S

Get mutable access to the server state.

Source

pub fn update_server_state(&mut self, state: S)

Update the server state and increment version.

Source

pub fn client_state_version(&self) -> u64

Get the client state version.

Source

pub fn update_client_state_version(&mut self, version: u64)

Update the client state version (from ack).

Source

pub fn server_state_version(&self) -> u64

Get the server state version.

Source

pub fn touch(&mut self)

Record activity.

Source

pub fn idle_time(&self) -> Duration

Get time since last activity.

Source

pub fn age(&self) -> Duration

Get session age.

Source

pub fn is_active(&self) -> bool

Check if session is active.

Source

pub fn update_client_addr(&mut self, addr: SocketAddr)

Update the client address (for IP roaming).

Source

pub fn set_extensions(&mut self, extensions: Vec<u16>)

Set negotiated extensions.

Source

pub fn extensions(&self) -> &[u16]

Get negotiated extensions.

Source

pub fn compression_enabled(&self) -> bool

Check if compression is enabled.

Trait Implementations§

Source§

impl<S: Debug + SyncState> Debug for ServerSession<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for ServerSession<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for ServerSession<S>
where S: RefUnwindSafe,

§

impl<S> Send for ServerSession<S>

§

impl<S> Sync for ServerSession<S>

§

impl<S> Unpin for ServerSession<S>
where S: Unpin,

§

impl<S> UnwindSafe for ServerSession<S>
where S: UnwindSafe,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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

Source§

fn vzip(self) -> V