Struct voxelize::WsSession

pub struct WsSession {
    pub id: String,
    pub hb: Instant,
    pub name: Option<String>,
    pub is_transport: bool,
    pub addr: Addr<Server>,
}

Fields

id: String

unique session id

hb: Instant

Client must send ping at least once per 10 seconds (CLIENT_TIMEOUT), otherwise we drop connection.

name: Option<String>

peer name

is_transport: bool

Is this WS session a TS transport?

addr: Addr<Server>

Chat server

Trait Implementations

impl Actor for WsSession

fn started(&mut self, ctx: &mut Self::Context)

Method is called on actor start. We register ws session with ChatServer

type Context = WebsocketContext<WsSession>

Actor execution context type

fn stopping(&mut self, _: &mut Self::Context) -> Running

Called after an actor is in Actor::Stopping state.

fn stopped(&mut self, ctx: &mut Self::Context)

Called after an actor is stopped.

fn start(self) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>, 

Start a new asynchronous actor, returning its address.

fn start_default() -> Addr<Self> where
    Self: Actor<Context = Context<Self>> + Default, 

Construct and start a new asynchronous actor, returning its address.

fn start_in_arbiter<F>(wrk: &ArbiterHandle, f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: 'static + FnOnce(&mut Context<Self>) -> Self + Send, 

Start new actor in arbiter’s thread.

fn create<F>(f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self, 

Start a new asynchronous actor given a Context.

impl Debug for WsSession

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

Formats the value using the given formatter.

impl Handler<Disconnect> for WsSession

type Result = ()

The type of value that this handler will return.

fn handle(&mut self, _: Disconnect, ctx: &mut Self::Context)

This method is called for every message received by this actor.

impl Handler<EncodedMessage> for WsSession

Handle messages from chat server, we simply send it to peer websocket

type Result = ()

The type of value that this handler will return.

fn handle(&mut self, msg: EncodedMessage, ctx: &mut Self::Context)

This method is called for every message received by this actor.

impl StreamHandler<Result<Message, ProtocolError>> for WsSession

WebSocket message handler

fn handle(&mut self, msg: Result<Message, ProtocolError>, ctx: &mut Self::Context)

Called for every message emitted by the stream.

fn started(&mut self, ctx: &mut Self::Context)

Called when stream emits first item.

fn finished(&mut self, ctx: &mut Self::Context)

Called when stream finishes.

fn add_stream<S>(stream: S, ctx: &mut Self::Context) -> SpawnHandle where
    S: 'static + Stream,
    Self: StreamHandler<<S as Stream>::Item>,
    Self::Context: AsyncContext<Self>, 

Register a Stream to the actor context.