Struct WebSocket

pub struct WebSocket<S, E, OnInit, OnPing> { /* private fields */ }

A GraphQL connection over websocket.

References

• subscriptions-transport-ws
• graphql-ws

Implementations

impl<S, E> WebSocket<S, E, DefaultOnConnInitType, DefaultOnPingType>

where E: Executor, S: Stream<Item = Result<ClientMessage>>,

pub fn from_message_stream(executor: E, stream: S, protocol: Protocols) -> Self

Create a new websocket from ClientMessage stream.

impl<S, E> WebSocket<Map<S, fn(_: <S as Stream>::Item) -> Result<ClientMessage>>, E, DefaultOnConnInitType, DefaultOnPingType>

where E: Executor, S: Stream, S::Item: AsRef<[u8]>,

pub fn new(executor: E, stream: S, protocol: Protocols) -> Self

Create a new websocket from bytes stream.

impl<S, E, OnInit, OnPing> WebSocket<S, E, OnInit, OnPing>

where E: Executor, S: Stream<Item = Result<ClientMessage>>,

pub fn connection_data(self, data: Data) -> Self

Specify a connection data.

This data usually comes from HTTP requests. When the GQL_CONNECTION_INIT message is received, this data will be merged with the data returned by the closure specified by with_initializer into the final subscription context data.

pub fn on_connection_init<F, R>(self, callback: F) -> WebSocket<S, E, F, OnPing>

where F: FnOnce(Value) -> R + Send + 'static, R: Future<Output = Result<Data>> + Send + 'static,

Specify a connection initialize callback function.

This function if present, will be called with the data sent by the client in the GQL_CONNECTION_INIT message. From that point on the returned data will be accessible to all requests.

pub fn on_ping<F, R>(self, callback: F) -> WebSocket<S, E, OnInit, F>

where F: FnOnce(Option<&Data>, Option<Value>) -> R + Send + Clone + 'static, R: Future<Output = Result<Option<Value>>> + Send + 'static,

Specify a ping callback function.

This function if present, will be called with the data sent by the client in the Ping message.

The function should return the data to be sent in the Pong message.

NOTE: Only used for the graphql-ws protocol.

pub fn keepalive_timeout(self, timeout: impl Into<Option<Duration>>) -> Self

Sets a timeout for receiving an acknowledgement of the keep-alive ping.

If the ping is not acknowledged within the timeout, the connection will be closed.

NOTE: Only used for the graphql-ws protocol.

Trait Implementations

impl<S, E, OnInit, InitFut, OnPing, PingFut> Stream for WebSocket<S, E, OnInit, OnPing>

where E: Executor, S: Stream<Item = Result<ClientMessage>>, OnInit: FnOnce(Value) -> InitFut + Send + 'static, InitFut: Future<Output = Result<Data>> + Send + 'static, OnPing: FnOnce(Option<&Data>, Option<Value>) -> PingFut + Clone + Send + 'static, PingFut: Future<Output = Result<Option<Value>>> + Send + 'static,

type Item = WsMessage

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, S, E, OnInit, OnPing> Unpin for WebSocket<S, E, OnInit, OnPing>

where __Origin<'__pin, S, E, OnInit, OnPing>: Unpin,