This repository has been archived by the owner on Aug 23, 2020. It is now read-only.
Document zmq-messageQ #1141
Merged
Document zmq-messageQ #1141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@karimodm did you also go over zmq/README.md to see it's up to date? that would be great! |
|
I had verified it was up to date, but I have now amended it with some extra information, and removed the WIP comment. |
alon-e
reviewed
Nov 12, 2018
| * `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 |
There was a problem hiding this comment.
missing tx_trytes: ZmqPublishProvider
| * a short lowercase string. | ||
| * Some example topics: | ||
| * <ol> | ||
| * <li>tx: transactions events</li> |
| * Creates and starts a ZMQ publisher. | ||
| * | ||
| * @param port port the publisher will be bound to | ||
| * @param ipc IPC socket to bind the publisher to |
There was a problem hiding this comment.
Suggested change
| * @param ipc IPC socket to bind the publisher to | |
| * @param ipc IPC socket the publisher will be bound to |
or swap the port doc to this
| * @param port port the publisher will be bound to | ||
| * @param ipc IPC socket to bind the publisher to | ||
| * @param nthreads number of threads used by the ZMQ publisher | ||
| * @param enabled boolean enable flag; defaults to "false" |
There was a problem hiding this comment.
if set to default, ZMQ will not run - won't bind etc.
| * Publishes an event to the queue | ||
| * | ||
| * @param message message body, prepended by topic string | ||
| * @param objects objects to be rendered as part of the message |
There was a problem hiding this comment.
not sure "to be rendered" is the best term, but I don't have a better one now.
from String.format:
args - Arguments referenced by the format specifiers in the format string
Co-Authored-By: karimodm <andreakarimodm@gmail.com>
alon-e
approved these changes
Nov 12, 2018
jakubcech
approved these changes
Nov 13, 2018
DyrellC
pushed a commit
to DyrellC/iri
that referenced
this pull request
Nov 17, 2018
* Document zmq-messageQ * Amend zmq README * Update src/main/java/com/iota/iri/zmq/MessageQ.java Co-Authored-By: karimodm <andreakarimodm@gmail.com> * Document zmq-messageQ: review comments
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documents zmq/MessageQ
Fixes #1109