Struct Session 

pub struct Session { /* private fields */ }

One connection to one network’s websocket.

Implementations

impl Session

pub fn tick(&mut self, now: u64) -> Tick

What the socket needs at now: a ping after Timing::ping_after_ms with no pong or data (once, until one arrives or as long again passes), or a reconnect after Timing::silent_ms of nothing at all.

pub fn due(&self) -> Option<u64>

When a tick next has something to do; None while closed.

pub fn closed(&mut self, now: u64, random: u64) -> Retry

The socket closed at now, or a connect failed. Gives how long to wait before the next connect, and the posts left unanswered. The wait doubles from Timing::first_retry_ms to Timing::last_retry_ms and random adds up to a quarter more, so many clients dropped at once do not return at once. It starts over after a socket that held (Timing::steady_ms). There is no last attempt.

impl Session

pub fn new(network: Network) -> Self

A closed session on network, with the venue’s limits and the default timing.

pub const fn with_limits(self, limits: Limits) -> Self

The limits are per IP: sessions sharing one split them.

pub const fn with_timing(self, timing: Timing) -> Self

pub const fn network(&self) -> Network

pub const fn url(&self) -> &'static str

Where to connect: the network’s public websocket.

pub const fn is_open(&self) -> bool

pub fn wanted(&self) -> &[Subscription]

What this session subscribes to on every socket, in the order it was asked for.

pub fn users(&self) -> usize

The distinct users the wanted subscriptions follow.

pub fn waiting(&self) -> &[u64]

The ids of posts sent on this socket and not yet answered.

pub fn subscribe( &mut self, subscription: Subscription, ) -> Result<Option<String>, Refused>

Wants subscription from now on, on this socket and every later one. Gives the frame to send when the socket is open and it is new; nothing when it was already wanted. Past the limits, or when the venue would not take it, it is refused and not kept.

pub fn unsubscribe(&mut self, subscription: &Subscription) -> Option<String>

Stops wanting subscription. Gives the frame to send when the socket is open and it was wanted.

pub fn post(&mut self, request: &Post) -> Result<(u64, String), Refused>

Gives the next post’s id and its frame. Only on an open socket, and only while fewer than the limit are waiting for an answer.

pub fn opened(&mut self, now: u64) -> Vec<String>

The socket opened at now. Gives the frames that subscribe to everything wanted, in order.

pub fn received(&mut self, now: u64, text: &str) -> Result<Frame, BadFrame>

A text frame arrived at now. Anything that arrives shows the socket is alive, whether it reads or not; only a pong or a subscription’s data puts off the next ping. A post’s answer or refusal stops it waiting.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.