[][src]Struct actix_web_actors::ws::WebsocketContext

pub struct WebsocketContext<A> where
    A: Actor<Context = WebsocketContext<A>>, 
{ /* fields omitted */ }

Execution context for WebSockets actors

Methods

impl<A> WebsocketContext<A> where
    A: Actor<Context = Self>, 
[src]

pub fn create<S>(
    actor: A,
    stream: S
) -> impl Stream<Item = Result<Bytes, Error>> where
    A: StreamHandler<Result<Message, ProtocolError>>,
    S: Stream<Item = Result<Bytes, PayloadError>> + 'static, 
[src]

Create a new Websocket context from a request and an actor

pub fn create_with_addr<S>(
    actor: A,
    stream: S
) -> (Addr<A>, impl Stream<Item = Result<Bytes, Error>>) where
    A: StreamHandler<Result<Message, ProtocolError>>,
    S: Stream<Item = Result<Bytes, PayloadError>> + 'static, 
[src]

Create a new Websocket context from a request and an actor.

Returns a pair, where the first item is an addr for the created actor, and the second item is a stream intended to be set as part of the response via HttpResponseBuilder::streaming().

pub fn with_codec<S>(
    actor: A,
    stream: S,
    codec: Codec
) -> impl Stream<Item = Result<Bytes, Error>> where
    A: StreamHandler<Result<Message, ProtocolError>>,
    S: Stream<Item = Result<Bytes, PayloadError>> + 'static, 
[src]

Create a new Websocket context from a request, an actor, and a codec

pub fn with_factory<S, F>(
    stream: S,
    f: F
) -> impl Stream<Item = Result<Bytes, Error>> where
    F: FnOnce(&mut Self) -> A + 'static,
    A: StreamHandler<Result<Message, ProtocolError>>,
    S: Stream<Item = Result<Bytes, PayloadError>> + 'static, 
[src]

Create a new Websocket context

impl<A> WebsocketContext<A> where
    A: Actor<Context = Self>, 
[src]

pub fn write_raw(&mut self, msg: Message)[src]

Write payload

This is a low-level function that accepts framed messages that should be created using Frame::message(). If you want to send text or binary data you should prefer the text() or binary() convenience functions that handle the framing for you.

pub fn text<T: Into<String>>(&mut self, text: T)[src]

Send text frame

pub fn binary<B: Into<Bytes>>(&mut self, data: B)[src]

Send binary frame

pub fn ping(&mut self, message: &[u8])[src]

Send ping frame

pub fn pong(&mut self, message: &[u8])[src]

Send pong frame

pub fn close(&mut self, reason: Option<CloseReason>)[src]

Send close frame

pub fn handle(&self) -> SpawnHandle[src]

Handle of the running future

SpawnHandle is the handle returned by AsyncContext::spawn() method.

pub fn set_mailbox_capacity(&mut self, cap: usize)[src]

Set mailbox capacity

By default mailbox capacity is 16 messages.

Trait Implementations

impl<A> ActorContext for WebsocketContext<A> where
    A: Actor<Context = Self>, 
[src]

impl<A> AsyncContext<A> for WebsocketContext<A> where
    A: Actor<Context = Self>, 
[src]

impl<A> AsyncContextParts<A> for WebsocketContext<A> where
    A: Actor<Context = Self>, 
[src]

impl<A, M> ToEnvelope<A, M> for WebsocketContext<A> where
    A: Actor<Context = WebsocketContext<A>> + Handler<M>,
    M: ActixMessage + Send + 'static,
    M::Result: Send
[src]

Auto Trait Implementations

impl<A> !RefUnwindSafe for WebsocketContext<A>

impl<A> !Send for WebsocketContext<A>

impl<A> !Sync for WebsocketContext<A>

impl<A> Unpin for WebsocketContext<A>

impl<A> !UnwindSafe for WebsocketContext<A>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,