Base class for ZMQ publisher notifiers that send multipart messages to subscribers.

Synopsis

Declared in <zmq/zmqpublishnotifier.h>

class CZMQAbstractPublishNotifier
    : public CZMQAbstractNotifier

Base Classes

Name

Description

CZMQAbstractNotifier

Base class for ZMQ notifiers that publish node events to a subscriber.

Member Functions

Name

Description

GetAddress

Get the ZMQ endpoint address this notifier publishes to.

GetOutboundMessageHighWaterMark

Get the configured outbound message high‐water mark.

GetType

Get the notifier type name.

Initialize [virtual]

Initialize the publisher, binding or connecting its socket.

NotifyBlock [virtual]

Notifies of ConnectTip result, i.e., new active tip only.

NotifyBlockConnect [virtual]

Notifies of every block connection.

NotifyBlockDisconnect [virtual]

Notifies of every block disconnection.

NotifyTransaction [virtual]

Notifies of transactions added to mempool or appearing in blocks.

NotifyTransactionAcceptance [virtual]

Notifies of every mempool acceptance.

NotifyTransactionRemoval [virtual]

Notifies of every mempool removal, except inclusion in blocks.

SendZmqMessage

Send a multipart ZMQ message (command, data, sequence number).

SetAddress

Set the ZMQ endpoint address this notifier publishes to.

SetOutboundMessageHighWaterMark

Set the outbound message high‐water mark, ignoring negative values.

SetType

Set the notifier type name.

Shutdown [virtual]

Shut down the publisher and close its socket.

Static Member Functions

Name

Description

Create

Factory helper that constructs a notifier of the concrete type T.

Static Data Members

Name

Description

DEFAULT_ZMQ_SNDHWM

Default ZMQ send high‐water mark (maximum queued outbound messages).

Protected Data Members

Name

Description

address

The ZMQ endpoint address published to.

outbound_message_high_water_mark

Outbound message high‐water mark (SNDHWM).

psocket

The ZMQ publisher socket, or nullptr before initialization.

type

The notifier type name.

Derived Classes

Name

Description

CZMQPublishHashBlockNotifier

Publishes the hash of each new active chain tip block.

CZMQPublishHashTransactionNotifier

Publishes the hash of each notified transaction.

CZMQPublishRawBlockNotifier

Publishes the serialized bytes of each new active chain tip block.

CZMQPublishRawTransactionNotifier

Publishes the serialized bytes of each notified transaction.

CZMQPublishSequenceNotifier

Publishes lightweight sequence messages for block and mempool events.

Created with MrDocs