aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authormruddy <6440430+mruddy@users.noreply.github.com>2018-08-24 20:42:03 -0400
committermruddy <6440430+mruddy@users.noreply.github.com>2018-10-19 07:36:13 -0400
commita4edb168b635b6f5c36324e44961cd42cf9bbbaa (patch)
treeb3d617db74c7b1f86ee79df156139627fb7cabfe /doc
parentd387507aeca652a5569825af65243536f2ce26ea (diff)
ZMQ: add options to configure outbound message high water mark, aka SNDHWM
Diffstat (limited to 'doc')
-rw-r--r--doc/zmq.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/zmq.md b/doc/zmq.md
index a1a506f2e7..7ffc5623b6 100644
--- a/doc/zmq.md
+++ b/doc/zmq.md
@@ -66,10 +66,21 @@ Currently, the following notifications are supported:
The socket type is PUB and the address must be a valid ZeroMQ socket
address. The same address can be used in more than one notification.
+The option to set the PUB socket's outbound message high water mark
+(SNDHWM) may be set individually for each notification:
+
+ -zmqpubhashtxhwm=n
+ -zmqpubhashblockhwm=n
+ -zmqpubrawblockhwm=n
+ -zmqpubrawtxhwm=n
+
+The high water mark value must be an integer greater than or equal to 0.
+
For instance:
$ bitcoind -zmqpubhashtx=tcp://127.0.0.1:28332 \
- -zmqpubrawtx=ipc:///tmp/bitcoind.tx.raw
+ -zmqpubrawtx=ipc:///tmp/bitcoind.tx.raw \
+ -zmqpubhashtxhwm=10000
Each PUB notification has a topic and body, where the header
corresponds to the notification type. For instance, for the