Struct sc_rpc_api::Subscriptions

pub struct Subscriptions { /* fields omitted */ }

Subscriptions manager.

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

Methods

impl Subscriptions

pub fn new(executor: TaskExecutor) -> Self

Creates new Subscriptions object.

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 or will be cancelled in case #cancel is invoked.

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

Cancel subscription.

Returns true if subscription existed or false otherwise.

Trait Implementations

impl Clone for Subscriptions

fn clone(&self) -> Subscriptions

Returns a copy of the value.

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

Performs copy-assignment from source.