diff options
| author | Ross Nicoll <[email protected]> | 2018-01-20 18:35:31 +0000 |
|---|---|---|
| committer | Ross Nicoll <[email protected]> | 2019-03-25 05:36:12 +0000 |
| commit | 731b7a75c2bba4d4ba5a213ca5235ac334a998b0 (patch) | |
| tree | 99ab6f8e5a3bc0efa17b14fb6d69d623dd2edf12 /doc/zmq.md | |
| parent | Rename and update man pages (#1451) (diff) | |
| download | discoin-731b7a75c2bba4d4ba5a213ca5235ac334a998b0.tar.xz discoin-731b7a75c2bba4d4ba5a213ca5235ac334a998b0.zip | |
Update documentation to match 1.10 (#1436)
Diffstat (limited to 'doc/zmq.md')
| -rw-r--r-- | doc/zmq.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/zmq.md b/doc/zmq.md index 1019ff665..a35b8a76f 100644 --- a/doc/zmq.md +++ b/doc/zmq.md @@ -5,8 +5,8 @@ connections, inter-process communication, and shared-memory, providing various message-oriented semantics such as publish/subscribe, request/reply, and push/pull. -The Bitcoin Core daemon can be configured to act as a trusted "border -router", implementing the bitcoin wire protocol and relay, making +The Dogecoin Core daemon can be configured to act as a trusted "border +router", implementing the dogecoin wire protocol and relay, making consensus decisions, maintaining the local blockchain database, broadcasting locally generated transactions into the network, and providing a queryable RPC interface to interact on a polled basis for @@ -33,7 +33,7 @@ buffering or reassembly. ## Prerequisites -The ZeroMQ feature in Bitcoin Core requires ZeroMQ API version 4.x or +The ZeroMQ feature in Dogecoin Core requires ZeroMQ API version 4.x or newer. Typically, it is packaged by distributions as something like *libzmq3-dev*. The C++ wrapper for ZeroMQ is *not* needed. @@ -45,7 +45,7 @@ operation. By default, the ZeroMQ feature is automatically compiled in if the necessary prerequisites are found. To disable, use --disable-zmq -during the *configure* step of building bitcoind: +during the *configure* step of building dogecoind: $ ./configure --disable-zmq (other options) @@ -66,8 +66,8 @@ address. The same address can be used in more than one notification. For instance: - $ bitcoind -zmqpubhashtx=tcp://127.0.0.1:28332 \ - -zmqpubrawtx=ipc:///tmp/bitcoind.tx.raw + $ dogecoind -zmqpubhashtx=tcp://127.0.0.1:28332 \ + -zmqpubrawtx=ipc:///tmp/dogecoind.tx.raw Each PUB notification has a topic and body, where the header corresponds to the notification type. For instance, for the @@ -75,7 +75,7 @@ notification `-zmqpubhashtx` the topic is `hashtx` (no null terminator) and the body is the hexadecimal transaction hash (32 bytes). -These options can also be provided in bitcoin.conf. +These options can also be provided in dogecoin.conf. ZeroMQ endpoint specifiers for TCP (and others) are documented in the [ZeroMQ API](http://api.zeromq.org/4-0:_start). @@ -87,9 +87,9 @@ arriving. Please see `contrib/zmq/zmq_sub.py` for a working example. ## Remarks -From the perspective of bitcoind, the ZeroMQ socket is write-only; PUB +From the perspective of dogecoind, the ZeroMQ socket is write-only; PUB sockets don't even have a read function. Thus, there is no state -introduced into bitcoind directly. Furthermore, no information is +introduced into dogecoind directly. Furthermore, no information is broadcast that wasn't already received from the public P2P network. No authentication or authorization is done on connecting clients; it @@ -102,5 +102,5 @@ retrieve the chain from the last known block to the new tip. There are several possibilities that ZMQ notification can get lost during transmission depending on the communication type your are -using. Bitcoind appends an up-counting sequence number to each +using. Dogecoind appends an up-counting sequence number to each notification which allows listeners to detect lost notifications. |