Struct bitcoin_zmq::ZMQSubscriber

pub struct ZMQSubscriber(_);

Factory object allowing constuction of single stream channels and broadcast channels.

Cloning to receive additional factories does not increase overhead when compared to using the subscribe method.

Methods

impl ZMQSubscriber

pub fn new(
    addr: &str,
    capacity: usize
) -> (Self, impl Future<Item = (), Error = SubscriptionError> + Send)

Constructs a new factory paired with a future representing the connection/broker.

pub fn single_stream(
    addr: &str,
    topic: Topic,
    capacity: usize
) -> (Box<dyn Stream<Item = Vec<u8>, Error = ()> + Send>, impl Future<Item = (), Error = SubscriptionError> + Send)

Construct a single stream filtered by topic.

The stream is paired with a future representing the connection.

pub fn subscribe(
    &self,
    filter_topic: Topic
) -> impl Stream<Item = Bytes, Error = ()> + Send + Sized

Subscribe to one-of-many streams filtered by topic.

The stream is paired with a future representing the connection and the broker coordinating the broadcast channel.

The return type is Bytes which prevents unecessary clones while streams are being handled by the broker.

This does not consume the factory.

Trait Implementations

impl Clone for ZMQSubscriber

fn clone(&self) -> ZMQSubscriber

Returns a copy of the value.

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

Performs copy-assignment from source.