Struct ws_actix_web::MyWebSocket

pub struct MyWebSocket { /* fields omitted */ }

websocket connection is long running connection, it easier to handle with an actor

Methods

impl MyWebSocket

pub fn new() -> Self

pub fn hb(&self, ctx: &mut Self::Context)

helper method that sends ping to client every second.

also this method checks heartbeats from client

Trait Implementations

impl Actor for MyWebSocket

type Context = WebsocketContext<Self>

Actor execution context type

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

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

fn stopping(&mut self, ctx: &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>(arb: &Arbiter, f: F) -> Addr<Self> where
    F: FnOnce(&mut Context<Self>) -> Self + Send + 'static,
    Self: Actor<Context = Context<Self>>, 

Start new actor in arbiter's thread.

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

Start a new asynchronous actor given a Context.

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

Handler for ws::Message

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

Method is called for every message received by this Actor

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

Method is called when stream get polled first time.

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

Method is called when stream finishes.

fn add_stream<S>(fut: S, ctx: &mut Self::Context) -> SpawnHandle where
    I: 'static,
    S: Stream<Item = I> + 'static,
    Self::Context: AsyncContext<Self>, 

This method register stream to an actor context and allows to handle Stream in similar way as normal actor messages.