You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by pt...@apache.org on 2016/05/24 20:38:26 UTC

[05/10] storm git commit: STORM-1848: Add comment to SpoutOutputCollector javadoc mentioning that message ids should be serializable to work with event logging

STORM-1848: Add comment to SpoutOutputCollector javadoc mentioning that message ids should be serializable to work with event logging

Signed-off-by: P. Taylor Goetz <pt...@gmail.com>


Project: http://git-wip-us.apache.org/repos/asf/storm/repo
Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/bce3036d
Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/bce3036d
Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/bce3036d

Branch: refs/heads/1.x-branch
Commit: bce3036d475b835fec9eb37988c77ba1c6b532a7
Parents: b70f36d
Author: Stig Rohde D�ssing <sd...@it-minds.dk>
Authored: Wed May 18 21:13:06 2016 +0200
Committer: P. Taylor Goetz <pt...@gmail.com>
Committed: Tue May 24 16:33:46 2016 -0400

----------------------------------------------------------------------
 .../storm/spout/SpoutOutputCollector.java       | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/storm/blob/bce3036d/storm-core/src/jvm/org/apache/storm/spout/SpoutOutputCollector.java
----------------------------------------------------------------------
diff --git a/storm-core/src/jvm/org/apache/storm/spout/SpoutOutputCollector.java b/storm-core/src/jvm/org/apache/storm/spout/SpoutOutputCollector.java
index 13482ba..4b47575 100644
--- a/storm-core/src/jvm/org/apache/storm/spout/SpoutOutputCollector.java
+++ b/storm-core/src/jvm/org/apache/storm/spout/SpoutOutputCollector.java
@@ -40,8 +40,9 @@ public class SpoutOutputCollector implements ISpoutOutputCollector {
      * When Storm detects that this tuple has been fully processed, or has failed
      * to be fully processed, the spout will receive an ack or fail callback respectively
      * with the messageId as long as the messageId was not null. If the messageId was null,
-     * Storm will not track the tuple and no callback will be received. The emitted values must be 
-     * immutable.
+     * Storm will not track the tuple and no callback will be received. 
+     * Note that Storm's event logging functionality will only work if the messageId
+     * is serializable via Kryo or the Serializable interface. The emitted values must be immutable.
      *
      * @return the list of task ids that this tuple was sent to
      */
@@ -54,8 +55,9 @@ public class SpoutOutputCollector implements ISpoutOutputCollector {
      * When Storm detects that this tuple has been fully processed, or has failed
      * to be fully processed, the spout will receive an ack or fail callback respectively
      * with the messageId as long as the messageId was not null. If the messageId was null,
-     * Storm will not track the tuple and no callback will be received. The emitted values must be 
-     * immutable.
+     * Storm will not track the tuple and no callback will be received.
+     * Note that Storm's event logging functionality will only work if the messageId
+     * is serializable via Kryo or the Serializable interface. The emitted values must be immutable.
      *
      * @return the list of task ids that this tuple was sent to
      */
@@ -84,8 +86,9 @@ public class SpoutOutputCollector implements ISpoutOutputCollector {
     /**
      * Emits a tuple to the specified task on the specified output stream. This output
      * stream must have been declared as a direct stream, and the specified task must
-     * use a direct grouping on this stream to receive the message. The emitted values must be 
-     * immutable.
+     * use a direct grouping on this stream to receive the message. Note that Storm's event
+     * logging functionality will only work if the messageId is serializable via Kryo
+     * or the Serializable interface. The emitted values must be immutable.
      */
     public void emitDirect(int taskId, String streamId, List<Object> tuple, Object messageId) {
         _delegate.emitDirect(taskId, streamId, tuple, messageId);
@@ -94,8 +97,9 @@ public class SpoutOutputCollector implements ISpoutOutputCollector {
     /**
      * Emits a tuple to the specified task on the default output stream. This output
      * stream must have been declared as a direct stream, and the specified task must
-     * use a direct grouping on this stream to receive the message. The emitted values must be 
-     * immutable.
+     * use a direct grouping on this stream to receive the message. Note that Storm's event
+     * logging functionality will only work if the messageId is serializable via Kryo
+     * or the Serializable interface. The emitted values must be immutable.
      */
     public void emitDirect(int taskId, List<Object> tuple, Object messageId) {
         emitDirect(taskId, Utils.DEFAULT_STREAM_ID, tuple, messageId);