Enum SessionState

pub enum SessionState {
    Uninitialized,
    Initialized(Rc<ConnectionInfo>),
    Connecting(Rc<ConnectionInfo>),
    Authorizing(Rc<ConnectionInfo>),
    Lost(ConnectionLostReason, Rc<ConnectionInfo>),
    Opened(Rc<ConnectionInfo>),
    Finished(CloseReason),
}

State for the WebSocketRpcSession.

State transition scheme

     +---------------+
+--->+ Uninitialized |
|    +-------+-------+
|            |
|            v
|    +-------+-------+
|    |  Initialized  |
|    +-------+-------+
|            |
|            v                    +------------+
|    +-------+-------+<-----------+            |
|    |  Connecting   |            |   Failed   |
|    +-------+-------+----------->+            |
|            |                    +------+-----+
|            v                           ^
|    +-------+-------+                   |
+----+  Authorizing  +------------------>+
     +-------+-------+                   |
             |                           |
             v                           |
     +-------+-------+                   |
     |    Opened     +------------------>+
     +-------+-------+
             |
             v
     +-------+-------+
     |   Finished    |
     +---------------+

Variants

Uninitialized

WebSocketRpcSession currently doesn’t have ConnectionInfo to authorize with.

Initialized(Rc<ConnectionInfo>)

ConnectionInfo was specified, but no transport connection establishment attempts were made yet.

Connecting(Rc<ConnectionInfo>)

Ongoing transport connection establishment.

Authorizing(Rc<ConnectionInfo>)

Transport connection is establish and WebSocketRpcSession is currently performing session authorization.

Lost(ConnectionLostReason, Rc<ConnectionInfo>)

Connection with a server was lost but can be recovered.

Opened(Rc<ConnectionInfo>)

Connection with a server is established and WebSocketRpcSession is authorized.

Finished(CloseReason)

Terminal state: transport is closed and can not be reopened.

Trait Implementations

impl Clone for SessionState

fn clone(&self) -> SessionState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionState

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

Formats the value using the given formatter.

impl PartialEq for SessionState

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.