xdas.processing.ZMQPublisher

class xdas.processing.ZMQPublisher(address, encoding=None)

A class for publishing DataArray chunks over ZeroMQ.

Parameters:

• address (str) – The address to bind the publisher to.

• encoding (dict) – The encoding to use when dumping the DataArrays to bytes.

Examples

>>> import xdas as xd
>>> from xdas.processing import ZMQPublisher, ZMQSubscriber

First we generate some data and split it into packets

>>> packets = xd.split(xd.synthetics.dummy(), 10)

We initialize the publisher at a given address

>>> address = f"tcp://localhost:{xd.io.get_free_port()}"
>>> publisher = ZMQPublisher(address)

We can then publish the packets

>>> for da in packets:
...     publisher.submit(da)

To reduce the size of the packets, we can also specify an encoding

>>> import hdf5plugin

>>> address = f"tcp://localhost:{xd.io.get_free_port()}"
>>> encoding = {"chunks": (10, 10), **hdf5plugin.Zfp(accuracy=1e-6)}
>>> publisher = ZMQPublisher(address, encoding)
>>> for da in packets:
...     publisher.submit(da)

__init__(address, encoding=None)

Methods

__init__(address[, encoding])
result()	Return None — ZMQPublisher has no aggregated result.
submit(da)	Send a DataArray over ZeroMQ.
write(da)	Alias for submit().