Struct GraphQLWebSocket 

pub struct GraphQLWebSocket<SinkT, StreamT, E, OnConnInit, OnPing>
where
    E: Executor,
{ /* private fields */ }

Available on crate feature async-graphql only.

A generic GraphQL WebSocket driver using an arbitrary Sink/Stream of tungstenite Messages.

This is a generic API so you can integrate custom websocket transports while reusing Tako’s mapping to async-graphql’s WebSocket state machine.

Implementations

impl<S, E> GraphQLWebSocket<SplitSink<S, Message>, SplitStream<S>, E, DefaultOnConnInitType, DefaultOnPingType>

where S: Stream<Item = Result<Message, Error>> + Sink<Message>, E: Executor,

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

Create a GraphQLWebSocket from a combined websocket stream implementing Sink+Stream.

impl<SinkT, StreamT, E> GraphQLWebSocket<SinkT, StreamT, E, DefaultOnConnInitType, DefaultOnPingType>

where SinkT: Sink<Message>, StreamT: Stream<Item = Result<Message, Error>>, E: Executor,

pub fn new_with_pair( sink: SinkT, stream: StreamT, executor: E, protocol: WebSocketProtocols, ) -> Self

Create a GraphQLWebSocket from separate sink and stream.

impl<SinkT, StreamT, E, OnConnInit, OnPing> GraphQLWebSocket<SinkT, StreamT, E, OnConnInit, OnPing>

where SinkT: Sink<Message>, StreamT: Stream<Item = Result<Message, Error>>, E: Executor,

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

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

impl<SinkT, StreamT, E, OnConnInit, OnConnInitFut, OnPing, OnPingFut> GraphQLWebSocket<SinkT, StreamT, E, OnConnInit, OnPing>

where SinkT: Sink<Message> + Unpin, StreamT: Stream<Item = Result<Message, Error>> + Unpin, E: Executor, OnConnInit: FnOnce(Value) -> OnConnInitFut + Send + 'static, OnConnInitFut: Future<Output = Result<Data>> + Send + 'static, OnPing: FnOnce(Option<&Data>, Option<Value>) -> OnPingFut + Clone + Send + 'static, OnPingFut: Future<Output = Result<Option<Value>>> + Send + 'static,

pub fn on_connection_init<F, Fut>( self, callback: F, ) -> GraphQLWebSocket<SinkT, StreamT, E, F, OnPing>

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

pub fn on_ping<F, Fut>( self, callback: F, ) -> GraphQLWebSocket<SinkT, StreamT, E, OnConnInit, F>

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

pub async fn serve(self)

Run the GraphQL over WebSocket protocol loop until the connection ends.