aboutsummaryrefslogtreecommitdiff
path: root/doc/zmq.md
diff options
context:
space:
mode:
authormruddy <6440430+mruddy@users.noreply.github.com>2018-11-08 06:38:21 -0500
committermruddy <6440430+mruddy@users.noreply.github.com>2018-11-15 08:16:25 -0500
commitc276df775914e4e42993c76e172ef159e3b830d4 (patch)
tree8bba4fee9755974b946a1d95aac811aa1c8b61e0 /doc/zmq.md
parente74649e95122c9c61aadf607461cf701c3953f88 (diff)
zmq: enable tcp keepalive
Diffstat (limited to 'doc/zmq.md')
-rw-r--r--doc/zmq.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/zmq.md b/doc/zmq.md
index 7ffc5623b6..35bb0fc377 100644
--- a/doc/zmq.md
+++ b/doc/zmq.md
@@ -98,6 +98,20 @@ ZMQ_SUBSCRIBE option set to one or either of these prefixes (for
instance, just `hash`); without doing so will result in no messages
arriving. Please see `contrib/zmq/zmq_sub.py` for a working example.
+The ZMQ_PUB socket's ZMQ_TCP_KEEPALIVE option is enabled. This means that
+the underlying SO_KEEPALIVE option is enabled when using a TCP transport.
+The effective TCP keepalive values are managed through the underlying
+operating system configuration and must be configured prior to connection establishment.
+
+For example, when running on GNU/Linux, one might use the following
+to lower the keepalive setting to 10 minutes:
+
+sudo sysctl -w net.ipv4.tcp_keepalive_time=600
+
+Setting the keepalive values appropriately for your operating environment may
+improve connectivity in situations where long-lived connections are silently
+dropped by network middle boxes.
+
## Remarks
From the perspective of bitcoind, the ZeroMQ socket is write-only; PUB