Struct tk_http::websocket::Loop

pub struct Loop<S, T, D: Dispatcher> { /* fields omitted */ }

This is a helper for running websockets

The Loop object is a future which polls both: (1) input stream, calling dispatcher on each message and a (2) channel where you can send output messages to from external futures.

Also Loop object answers pings by itself and pings idle connections.

Methods

impl<S, T, D, E> Loop<S, T, D> where
    T: Stream<Item = Packet, Error = E>,
    D: Dispatcher, 

pub fn server(
    outp: WriteFramed<S, ServerCodec>,
    inp: ReadFramed<S, ServerCodec>,
    stream: T,
    dispatcher: D,
    config: &Arc<Config>,
    handle: &Handle
) -> Loop<S, T, D>

Create a new websocket Loop (server-side)

This method should be called in hijack method of server::Codec

pub fn client(
    outp: WriteFramed<S, ClientCodec>,
    inp: ReadFramed<S, ClientCodec>,
    stream: T,
    dispatcher: D,
    config: &Arc<Config>,
    handle: &Handle
) -> Loop<S, T, D>

Create a new websocket Loop (client-side)

This method should be called after HandshakeProto finishes

impl<S> Loop<S, Empty<Packet, VoidError>, BlackHole>

pub fn closing(
    outp: WriteFramed<S, ServerCodec>,
    inp: ReadFramed<S, ServerCodec>,
    reason: u16,
    text: &str,
    config: &Arc<Config>,
    handle: &Handle
) -> Loop<S, Empty<Packet, VoidError>, BlackHole>

A websocket loop that sends failure and waits for closing handshake

This method should be called instead of new if something wrong happened with handshake.

The motivation of such constructor is: browsers do not propagate http error codes when websocket is established. This is presumed as a security feature (so you can't attack server that doesn't support websockets).

So to show useful failure to websocket code we return 101 Switching Protocol response code (which is success). I.e. establish a websocket connection, then immediately close it with a reason code and text. Javascript client can fetch the failure reason from onclose callback.

Trait Implementations

impl<S, T, D, E> Future for Loop<S, T, D> where
    T: Stream<Item = Packet, Error = E>,
    D: Dispatcher,
    E: Display,
    S: AsyncRead + AsyncWrite, 

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = Error

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Result<Async<()>, Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Map this future's error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    B: IntoFuture<Item = Self::Item>,
    F: FnOnce(Self::Error) -> B, 

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where
    B: IntoFuture, 

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>, 

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item), 

Do something with the item of a future, passing it on.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.