Struct webterm::Websocket

pub struct Websocket { /* fields omitted */ }

Actix WebSocket actor

Methods

impl Websocket

pub fn new(command: Command) -> Self

Trait Implementations

impl Actor for Websocket

type Context = WebsocketContext<Self>

Actor execution context type

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

Called when an actor gets polled the first time.

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 + 'static,
    Self: Actor<Context = Context<Self>>, 

Start a new asynchronous actor given a Context.

impl StreamHandler<Message, ProtocolError> for Websocket

fn handle(&mut self, msg: Message, 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 error(&mut self, err: E, ctx: &mut Self::Context) -> Running

Method is called when stream emits error.

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
    E: 'static,
    I: 'static,
    S: Stream<Item = I, Error = E> + '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.