Struct jsonrpc_pubsub::manager::SubscriptionManager

pub struct SubscriptionManager<I: IdProvider = RandomStringIdProvider> { /* fields omitted */ }

Subscriptions manager.

Takes care of assigning unique subscription ids and driving the sinks into completion.

Implementations

impl SubscriptionManager

pub fn new(executor: TaskExecutor) -> Self

Creates a new SubscriptionManager.

Uses RandomStringIdProvider as the ID provider.

impl<I: IdProvider> SubscriptionManager<I>

pub fn with_id_provider(id_provider: I, executor: TaskExecutor) -> Self

Creates a new SubscriptionManager with the specified ID provider.

pub fn executor(&self) -> &TaskExecutor

Borrows the internal task executor.

This can be used to spawn additional tasks on the underlying event loop.

pub fn add<T, E, G, R, F>(
    &self,
    subscriber: Subscriber<T, E>,
    into_future: G
) -> SubscriptionId where
    G: FnOnce(Sink<T, E>) -> R,
    R: IntoFuture<Future = F, Item = (), Error = ()>,
    F: Future<Item = (), Error = ()> + Send + 'static, 

Creates new subscription for given subscriber.

Second parameter is a function that converts Subscriber Sink into a Future. This future will be driven to completion by the underlying event loop

pub fn cancel(&self, id: SubscriptionId) -> bool

Cancel subscription.

Returns true if subscription existed or false otherwise.

impl<I: Default + IdProvider> SubscriptionManager<I>

pub fn with_executor(executor: TaskExecutor) -> Self

Creates a new SubscriptionManager.

Trait Implementations

impl<I: Clone + IdProvider> Clone for SubscriptionManager<I>

fn clone(&self) -> SubscriptionManager<I>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.