Struct ws_actix_web::WSClient

pub struct WSClient<T>(pub SinkWrite<Message, SplitSink<Framed<T, Codec>, Message>>)
 where
    T: AsyncRead + AsyncWrite;

Methods

impl<T: 'static> WSClient<T> where
    T: AsyncRead + AsyncWrite, 

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

Trait Implementations

impl<T: 'static> Actor for WSClient<T> where
    T: AsyncRead + AsyncWrite, 

type Context = Context<Self>

Actor execution context type

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

Called when an actor gets polled the first time.

fn stopped(&mut self, _: &mut Context<Self>)

Called after an actor is stopped.

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

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

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<T: 'static> Handler<ClientCommand> for WSClient<T> where
    T: AsyncRead + AsyncWrite, 

Handle stdin commands

type Result = ()

The type of value that this handler will return.

fn handle(&mut self, msg: ClientCommand, _ctx: &mut Context<Self>)

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

impl<T: 'static> StreamHandler<Result<Frame, ProtocolError>> for WSClient<T> where
    T: AsyncRead + AsyncWrite, 

Handle server websocket messages

fn handle(&mut self, msg: Result<Frame, WsProtocolError>, _: &mut Context<Self>)

Method is called for every message received by this Actor

fn started(&mut self, _ctx: &mut Context<Self>)

Method is called when stream get polled first time.

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

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.

impl<T: 'static> WriteHandler<ProtocolError> for WSClient<T> where
    T: AsyncRead + AsyncWrite, 

fn error(&mut self, err: E, ctx: &mut Self::Context) -> Running

Called when the writer emits error.

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

Called when the writer finishes.