Struct async_graphql_actix_web::WSSubscription

pub struct WSSubscription<Query, Mutation, Subscription, F> { /* fields omitted */ }

Actor for subscription via websocket

Implementations

impl<Query, Mutation, Subscription> WSSubscription<Query, Mutation, Subscription, fn(_: Value) -> Ready<Result<Data>>> where
    Query: ObjectType + 'static,
    Mutation: ObjectType + 'static,
    Subscription: SubscriptionType + 'static, 

pub fn start<T>(
    schema: Schema<Query, Mutation, Subscription>,
    request: &HttpRequest,
    stream: T
) -> Result<HttpResponse, Error> where
    T: Stream<Item = Result<Bytes, PayloadError>> + 'static, 

Start an actor for subscription connection via websocket.

impl<Query, Mutation, Subscription, F, R> WSSubscription<Query, Mutation, Subscription, F> where
    Query: ObjectType + 'static,
    Mutation: ObjectType + 'static,
    Subscription: SubscriptionType + 'static,
    F: FnOnce(Value) -> R + Unpin + Send + 'static,
    R: Future<Output = Result<Data>> + Send + 'static, 

pub fn start_with_initializer<T>(
    schema: Schema<Query, Mutation, Subscription>,
    request: &HttpRequest,
    stream: T,
    initializer: F
) -> Result<HttpResponse, Error> where
    T: Stream<Item = Result<Bytes, PayloadError>> + 'static,
    F: FnOnce(Value) -> R + Unpin + Send + 'static,
    R: Future<Output = Result<Data>> + Send + 'static, 

Start an actor for subscription connection via websocket with an initialization function.

Trait Implementations

impl<Query, Mutation, Subscription, F, R> Actor for WSSubscription<Query, Mutation, Subscription, F> where
    Query: ObjectType + 'static,
    Mutation: ObjectType + 'static,
    Subscription: SubscriptionType + 'static,
    F: FnOnce(Value) -> R + Unpin + Send + 'static,
    R: Future<Output = Result<Data>> + Send + 'static, 

type Context = WebsocketContext<Self>

Actor execution context type

fn started(&mut self, ctx: &mut Self::Context)

Called when an actor gets polled the first time.

pub fn stopping(&mut self, ctx: &mut Self::Context) -> Running

Called after an actor is in Actor::Stopping state.

pub fn stopped(&mut self, ctx: &mut Self::Context)

Called after an actor is stopped.

pub fn start(self) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>, 

Start a new asynchronous actor, returning its address.

pub fn start_default() -> Addr<Self> where
    Self: Actor<Context = Context<Self>> + Default, 

Construct and start a new asynchronous actor, returning its address.

pub fn start_in_arbiter<F>(arb: &Arbiter, f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self + Send + 'static, 

Start new actor in arbiter’s thread.

pub fn create<F>(f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self, 

Start a new asynchronous actor given a Context.

impl<Query, Mutation, Subscription, F, R> StreamHandler<Result<Message, ProtocolError>> for WSSubscription<Query, Mutation, Subscription, F> where
    Query: ObjectType + 'static,
    Mutation: ObjectType + 'static,
    Subscription: SubscriptionType + 'static,
    F: FnOnce(Value) -> R + Unpin + Send + 'static,
    R: Future<Output = Result<Data>> + Send + 'static, 

fn handle(
    &mut self,
    msg: Result<Message, ProtocolError>,
    ctx: &mut Self::Context
)

Method is called for every message received by this Actor

pub fn started(&mut self, ctx: &mut Self::Context)

Method is called when stream get polled first time.

pub fn finished(&mut self, ctx: &mut Self::Context)

Method is called when stream finishes.

pub fn add_stream<S>(fut: S, ctx: &mut Self::Context) -> SpawnHandle where
    S: Stream<Item = I> + 'static,
    I: 'static,
    Self::Context: AsyncContext<Self>, 

This method register stream to an actor context and allows to handle Stream in similar way as normal actor messages.