Struct async_graphql_warp::GraphQLWebSocket [−][src]
pub struct GraphQLWebSocket<Query, Mutation, Subscription, OnInit> { /* fields omitted */ }
Expand description
A Websocket connection for GraphQL subscription.
Examples
use async_graphql::*;
use async_graphql_warp::*;
use warp::{Filter, ws};
use futures_util::stream::{Stream, StreamExt};
use std::time::Duration;
struct QueryRoot;
#[Object]
impl QueryRoot {
async fn value(&self) -> i32 {
// A GraphQL Object type must define one or more fields.
100
}
}
struct SubscriptionRoot;
#[Subscription]
impl SubscriptionRoot {
async fn tick(&self) -> impl Stream<Item = String> {
async_stream::stream! {
let mut interval = tokio::time::interval(Duration::from_secs(1));
loop {
let n = interval.tick().await;
yield format!("{}", n.elapsed().as_secs_f32());
}
}
}
}
tokio::runtime::Runtime::new().unwrap().block_on(async {
let schema = Schema::new(QueryRoot, EmptyMutation, SubscriptionRoot);
let filter = warp::ws()
.and(graphql_protocol())
.map(move |ws: ws::Ws, protocol| {
let schema = schema.clone();
let reply = ws.on_upgrade(move |socket| {
GraphQLWebSocket::new(socket, schema, protocol).serve()
});
warp::reply::with_header(
reply,
"Sec-WebSocket-Protocol",
protocol.sec_websocket_protocol(),
)
});
warp::serve(filter).run(([0, 0, 0, 0], 8000)).await;
});
Implementations
impl<Query, Mutation, Subscription> GraphQLWebSocket<Query, Mutation, Subscription, fn(_: Value) -> Ready<Result<Data>>> where
Query: ObjectType + 'static,
Mutation: ObjectType + 'static,
Subscription: SubscriptionType + 'static,
impl<Query, Mutation, Subscription> GraphQLWebSocket<Query, Mutation, Subscription, fn(_: Value) -> Ready<Result<Data>>> where
Query: ObjectType + 'static,
Mutation: ObjectType + 'static,
Subscription: SubscriptionType + 'static,
pub fn new(
socket: WebSocket,
schema: Schema<Query, Mutation, Subscription>,
protocol: WebSocketProtocols
) -> Self
pub fn new(
socket: WebSocket,
schema: Schema<Query, Mutation, Subscription>,
protocol: WebSocketProtocols
) -> Self
Create a GraphQLWebSocket
object.
impl<Query, Mutation, Subscription, OnConnInit, OnConnInitFut> GraphQLWebSocket<Query, Mutation, Subscription, OnConnInit> where
Query: ObjectType + 'static,
Mutation: ObjectType + 'static,
Subscription: SubscriptionType + 'static,
OnConnInit: Fn(Value) -> OnConnInitFut + Send + Sync + 'static,
OnConnInitFut: Future<Output = Result<Data>> + Send + 'static,
impl<Query, Mutation, Subscription, OnConnInit, OnConnInitFut> GraphQLWebSocket<Query, Mutation, Subscription, OnConnInit> where
Query: ObjectType + 'static,
Mutation: ObjectType + 'static,
Subscription: SubscriptionType + 'static,
OnConnInit: Fn(Value) -> OnConnInitFut + Send + Sync + 'static,
OnConnInitFut: Future<Output = Result<Data>> + Send + 'static,
Specify the initial subscription context data, usually you can get something from the incoming request to create it.
Specify a callback function to be called when the connection is initialized.
You can get something from the payload of GQL_CONNECTION_INIT
message to create Data
.
The data returned by this callback function will be merged with the data specified by [with_data
].
Auto Trait Implementations
impl<Query, Mutation, Subscription, OnInit> !RefUnwindSafe for GraphQLWebSocket<Query, Mutation, Subscription, OnInit>
impl<Query, Mutation, Subscription, OnInit> Send for GraphQLWebSocket<Query, Mutation, Subscription, OnInit> where
Mutation: Send + Sync,
OnInit: Send,
Query: Send + Sync,
Subscription: Send + Sync,
impl<Query, Mutation, Subscription, OnInit> !Sync for GraphQLWebSocket<Query, Mutation, Subscription, OnInit>
impl<Query, Mutation, Subscription, OnInit> Unpin for GraphQLWebSocket<Query, Mutation, Subscription, OnInit> where
OnInit: Unpin,
impl<Query, Mutation, Subscription, OnInit> !UnwindSafe for GraphQLWebSocket<Query, Mutation, Subscription, OnInit>
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more