You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by dj...@apache.org on 2016/03/10 21:30:28 UTC
[2/2] incubator-quarks git commit: Add info on topic style
Add info on topic style
Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks/commit/2c365956
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks/tree/2c365956
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks/diff/2c365956
Branch: refs/heads/quarks-4-djd-2
Commit: 2c365956caf49b54d0b3ecf0d81a573bd7b0cc7f
Parents: 171df51
Author: Dan Debrunner <dj...@apache.org>
Authored: Thu Mar 10 12:27:30 2016 -0800
Committer: Dan Debrunner <dj...@apache.org>
Committed: Thu Mar 10 12:27:30 2016 -0800
----------------------------------------------------------------------
.../java/quarks/connectors/pubsub/PublishSubscribe.java | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/2c365956/connectors/pubsub/src/main/java/quarks/connectors/pubsub/PublishSubscribe.java
----------------------------------------------------------------------
diff --git a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/PublishSubscribe.java b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/PublishSubscribe.java
index 5654891..a82d69c 100644
--- a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/PublishSubscribe.java
+++ b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/PublishSubscribe.java
@@ -37,11 +37,18 @@ import quarks.topology.TopologyElement;
* If no {@link PublishSubscribeService} is registered then published
* tuples are discarded and subscribers see no tuples.
* </P>
+ * <P>
+ * The recommended style for topics is MQTT topics, where {@code /}
+ * is used to provide a hierarchy into topics. For example {@code engine/sensors/temperature}
+ * might be a topic that represents temperature sensors in an engine.
+ * <BR>
+ * Topics that start with {@code quarks/} are reserved for use by Quarks.
+ * <BR>
+ * MQTT style wild-cards are not supported.
+ * </P>
*/
public class PublishSubscribe {
-
-
/**
* Publish this stream to a topic.
* This is a model that allows jobs to subscribe to