Skip to content
This repository was archived by the owner on Aug 23, 2020. It is now read-only.

Commit

Permalink
Amend zmq README
Browse files Browse the repository at this point in the history
  • Loading branch information
karimodm committed Nov 12, 2018
1 parent 8c4b9f8 commit 4709edd
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
8 changes: 4 additions & 4 deletions src/main/java/com/iota/iri/zmq/MessageQ.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@
* allows the code to publish operational facts to a ZMQ stream.
* </p>
* <p>
* Usually, IRI events are published to this queue prepending the topic of the event to the body
* IRI events are published to this queue prepending the topic of the event to the body
* of the message. The topic describes the type or the source of the event and is represented by
* a short lowercase string.
* Some example topics:
* <ol>
* <li>tx: transactions events</li>
* <li>lm: milestones events</li>
* <li>dns: DNS-workers events</li>
* <li>dns: neighbors' DNS events</li>
* </ol>
* To monitor for activity on a specific address, the topic is instead the Address to watch.
* For a complete list and detaile topic speification please refer to the README.md.
* </p>
*
*
*/
public class MessageQ {
private final static Logger LOG = LoggerFactory.getLogger(MessageQ.class);
Expand Down
14 changes: 8 additions & 6 deletions src/main/java/com/iota/iri/zmq/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
## IRI MessageQ

This is a **work in progress**. Things will change.

MessageQ is a small wrapper for ZeroMQ inside IRI to allow streaming
of topics from within a running full node. The goal of this is to allow
for targeted event streams from subscribing clients to the node process.
Expand All @@ -22,19 +20,23 @@ A client interested in tip selection metrics may subscribe to `mctn`, short for
were traversed in a random walk simulation. It may subscribe to `rts`, for
"reason to stop", to see information about walk terminations.

Other topics currently found in the latest code are
* `dns` for information related to neighbors
Topics currently found in the latest code are
* `mctn` transactions traversed during random walk
* `rts` information about walk terminations
* `dnscv` neighbor DNS validations
* `dnscc` neighbor DNS confirmations
* `dnscu` neighbor DNS updates
* `hmr` for the hit to miss ratio
* `antn` for added non-tethered neighbors ( testnet only )
* `rntn` for refused non-tethered neighbors
* `rstat` for information about the tips requester
* `rtl` for transactions randomly removed from the request list
* `lmi` for the latest milestone index
* `lmsi` for the latest solid milestone index
* `lmhs` for the latest solid milestone hash
* `sn` for newly confirmed transactions ( by solid milestone children measurement )
* `tx` for newly seen transactions

* `<Address>` to watch for an address to be confirmed
* `<Address>` to watch activity on an address

All topic must be lowercase (to not clash with `<Address>` containing the topic title - like `TXCR9...` & `TX`)
All of these topics are subject to change, and more may be added; this is experimental code.

0 comments on commit 4709edd

Please sign in to comment.