Struct PubSubHandler

pub struct PubSubHandler<T, S = Noop>
where
    T: PubSubMetadata,
    S: Middleware<T>,
{ /* private fields */ }

Publish-Subscribe extension of IoHandler.

Implementations

impl<T, S> PubSubHandler<T, S>

where T: PubSubMetadata, S: Middleware<T>,

pub fn new(handler: MetaIoHandler<T, S>) -> PubSubHandler<T, S>

Creates new PubSubHandler

pub fn add_subscription<F, G>( &mut self, notification: &str, subscribe: (&str, F), unsubscribe: (&str, G), )

where F: SubscribeRpcMethod<T>, G: UnsubscribeRpcMethod<T>,

Adds new subscription.

Methods from Deref<Target = MetaIoHandler<T, S>>

pub fn add_alias(&mut self, alias: &str, other: &str)

Adds an alias to a method.

pub fn add_sync_method<F>(&mut self, name: &str, method: F)

where F: RpcMethodSync,

Adds new supported synchronous method.

A backward-compatible wrapper.

pub fn add_method<F>(&mut self, name: &str, method: F)

where F: RpcMethodSimple,

Adds new supported asynchronous method.

pub fn add_notification<F>(&mut self, name: &str, notification: F)

where F: RpcNotificationSimple,

Adds new supported notification

pub fn add_method_with_meta<F>(&mut self, name: &str, method: F)

where F: RpcMethod<T>,

Adds new supported asynchronous method with metadata support.

pub fn add_notification_with_meta<F>(&mut self, name: &str, notification: F)

where F: RpcNotification<T>,

Adds new supported notification with metadata support.

pub fn extend_with<F>(&mut self, methods: F)

where F: IntoIterator<Item = (String, RemoteProcedure<T>)>,

Extend this MetaIoHandler with methods defined elsewhere.

pub fn handle_request_sync(&self, request: &str, meta: T) -> Option<String>

Handle given request synchronously - will block until response is available. If you have any asynchronous methods in your RPC it is much wiser to use handle_request instead and deal with asynchronous requests in a non-blocking fashion.

pub fn handle_request( &self, request: &str, meta: T, ) -> Map<Either<Ready<Option<Response>>, Either<<S as Middleware<T>>::Future, Either<Map<Either<<S as Middleware<T>>::CallFuture, Either<Pin<Box<dyn Future<Output = Option<Output>> + Send>>, Ready<Option<Output>>>>, fn(Option<Output>) -> Option<Response>>, Map<JoinAll<Either<<S as Middleware<T>>::CallFuture, Either<Pin<Box<dyn Future<Output = Option<Output>> + Send>>, Ready<Option<Output>>>>>, fn(Vec<Option<Output>>) -> Option<Response>>>>>, fn(Option<Response>) -> Option<String>>

Handle given request asynchronously.

pub fn handle_rpc_request( &self, request: Request, meta: T, ) -> Either<<S as Middleware<T>>::Future, Either<Map<Either<<S as Middleware<T>>::CallFuture, Either<Pin<Box<dyn Future<Output = Option<Output>> + Send>>, Ready<Option<Output>>>>, fn(Option<Output>) -> Option<Response>>, Map<JoinAll<Either<<S as Middleware<T>>::CallFuture, Either<Pin<Box<dyn Future<Output = Option<Output>> + Send>>, Ready<Option<Output>>>>>, fn(Vec<Option<Output>>) -> Option<Response>>>>

Handle deserialized RPC request.

pub fn handle_call( &self, call: Call, meta: T, ) -> Either<<S as Middleware<T>>::CallFuture, Either<Pin<Box<dyn Future<Output = Option<Output>> + Send>>, Ready<Option<Output>>>>

Handle single call asynchronously.

pub fn iter(&self) -> impl Iterator<Item = (&String, &RemoteProcedure<T>)>

Returns an iterator visiting all methods in arbitrary order.

Trait Implementations

impl<T> Default for PubSubHandler<T>

where T: PubSubMetadata,

fn default() -> PubSubHandler<T>

Returns the “default value” for a type.

impl<T, S> Deref for PubSubHandler<T, S>

where T: PubSubMetadata, S: Middleware<T>,

type Target = MetaIoHandler<T, S>

The resulting type after dereferencing.

fn deref(&self) -> &<PubSubHandler<T, S> as Deref>::Target

Dereferences the value.

impl<T, S> DerefMut for PubSubHandler<T, S>

where T: PubSubMetadata, S: Middleware<T>,

fn deref_mut(&mut self) -> &mut <PubSubHandler<T, S> as Deref>::Target

Mutably dereferences the value.

impl<M> Handler for PubSubHandler<M>

where M: PubSubMetadata + Unpin + Debug + From<Arc<Session>>,

type Metadata = M

The type to use as the metadata for the IO handler. Especially relevant for PubSub.

fn add_method<F>(&mut self, name: &str, method: F)

where F: RpcMethodSimple,

Add a JSON-RPC method.

fn add_subscription<F, G>( &mut self, notification: &str, subscribe: (&str, F), unsubscribe: (&str, G), )

where F: SubscribeRpcMethod<M>, G: UnsubscribeRpcMethod<M>,

Add a JSON-RPC subscription.

fn as_meta_io_handler(&self) -> MetaIoHandler<Self::Metadata>

Cast this down to an instance of MetaIoHandler.

fn describe_api(&self) -> Vec<String>

Get a list of all the supported JSON-RPC methods.

fn handle_request_sync( &self, request: &str, meta: Self::Metadata, ) -> Option<String>

Programmatically trigger the handling of a JSON-RPC message. TODO: support async

fn metadata_from_sender(sender: UnboundedSender<String>) -> Self::Metadata

Derive an instance of the Self::Metadata associated type from an UnboundedSender.

fn new() -> Self

Create a new instance of a Handler implementation.

impl<T, S> Into<MetaIoHandler<T, S>> for PubSubHandler<T, S>

where T: PubSubMetadata, S: Middleware<T>,

fn into(self) -> MetaIoHandler<T, S>

Converts this type into the (usually inferred) input type.