Struct Session

pub struct Session {
    pub app: Data<App>,
    /* private fields */
}

Fields

app: Data<App>

Implementations

impl Session

pub fn set<T: 'static>(&mut self, val: T)

save extension data

pub fn get<T: 'static>(&self) -> Option<&T>

get extension data

pub fn id(&self) -> usize

Get session id

pub fn ip(&self) -> &String

Get ip

pub fn new(ip: String, app: Data<App>) -> Session

Trait Implementations

impl Actor for Session

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

Method is called on actor start. We start the heartbeat process here.

type Context = WebsocketContext<Session>

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.

impl Handler<OutgoingMessage> for Session

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

type Result = ()

The type of value that this handler will return.

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

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

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

Handler for ws::Message

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: Stream + 'static, Self: StreamHandler<<S as Stream>::Item>, Self::Context: AsyncContext<Self>,

Register a Stream to the actor context.