Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Switch docs to Markdown reference-style links for readability

  • Loading branch information...
commit fa9dc6aca237b7eb3fd15b8404da677b37b61b28 1 parent 1d99acb
@samstokes samstokes authored
Showing with 26 additions and 16 deletions.
  1. +26 −16 README.markdown
View
42 README.markdown
@@ -4,16 +4,13 @@ storm-amqp-spout allows a [Storm](https://github.com/nathanmarz/storm) topology
to consume an AMQP exchange as an input source. It currently provides one
class:
- * [AMQPSpout](http://code.rapportive.com/storm-amqp-spout/doc/com/rapportive/storm/spout/AMQPSpout.html):
- an implementation of
- [`backtype.storm.topology.IRichSpout`](http://nathanmarz.github.com/storm/doc/backtype/storm/topology/IRichSpout.html)
- that connects to an AMQP broker, consumes the messages published to a
- specified AMQP exchange and emits them as Storm tuples.
-
-You'll need to provide a
-[Scheme](http://nathanmarz.github.com/storm/doc/backtype/storm/spout/Scheme.html)
-to tell AMQPSpout how to interpret the messages and turn them into Storm tuples.
-See e.g. [storm-json](https://github.com/rapportive-oss/storm-json) if your
+ * <tt>[AMQPSpout][]</tt>: an implementation of
+ [`backtype.storm.topology.IRichSpout`][IRichSpout] that connects to an AMQP
+ broker, consumes the messages published to a specified AMQP exchange and
+ emits them as Storm tuples.
+
+You'll need to provide a [Scheme][] to tell AMQPSpout how to interpret the
+messages and turn them into Storm tuples. See e.g. [storm-json][] if your
messages are JSON.
## Documentation ##
@@ -56,12 +53,11 @@ welcome.
This should not currently be used where guaranteed message processing is
required, because it binds to the exchange using a temporary queue when the
-topology calls
-[`open()`](http://nathanmarz.github.com/storm/doc/backtype/storm/spout/ISpout.html#open(java.util.Map,%20backtype.storm.task.TopologyContext,%20backtype.storm.spout.SpoutOutputCollector\))
-on the spout. This means it will only receive messages published to the
-exchange after the call to `open()`, and if the spout worker restarts or the
-topology is killed, it will not receive any messages published while the worker
-or topology is down.
+topology calls <tt>[open()][]</tt> on the spout. This means it will only
+receive messages published to the exchange after the call to
+<tt>[open()][]</tt>, and if the spout worker restarts or the topology is
+killed, it will not receive any messages published while the worker or topology
+is down.
For the same reason, this spout cannot currently be distributed among
multiple workers (each worker gets its own exclusive queue, so multiple
@@ -76,3 +72,17 @@ existing queue to consume, rather than an exchange to bind to).
AMQPSpout has been tested with RabbitMQ 2.3.1 and 2.6.1. It should probably work with other
versions and other AMQP brokers.
+
+
+[Storm]: <https://github.com/nathanmarz/storm>
+ "Storm project homepage"
+[IRichSpout]: <http://nathanmarz.github.com/storm/doc/backtype/storm/topology/IRichSpout.html>
+ "Javadoc for backtype.storm.topology.IRichSpout"
+[open()]: <http://nathanmarz.github.com/storm/doc/backtype/storm/spout/ISpout.html#open(java.util.Map,%20backtype.storm.task.TopologyContext,%20backtype.storm.spout.SpoutOutputCollector\)>
+ "Javadoc for backtype.storm.spout.ISpout.open()"
+[Scheme]: <http://nathanmarz.github.com/storm/doc/backtype/storm/spout/Scheme.html>
+ "Javadoc for backtype.storm.spout.Scheme"
+[AMQPSpout]: <http://code.rapportive.com/storm-amqp-spout/doc/com/rapportive/storm/spout/AMQPSpout.html>
+ "Javadoc for AMQPSpout"
+[storm-json]: <https://github.com/rapportive-oss/storm-json>
+ "JSON {,de}serialisation support for Storm"
Please sign in to comment.
Something went wrong with that request. Please try again.