Add javadoc about reset timeout being expensive
Project: http://git-wip-us.apache.org/repos/asf/storm/repo Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/94a93d7e Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/94a93d7e Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/94a93d7e Branch: refs/heads/1.x-branch Commit: 94a93d7e6f7d7e1ed3eac4b367c5378c95e3ca2c Parents: 406052c Author: Stig Døssing <[email protected]> Authored: Wed Mar 2 17:58:52 2016 +0100 Committer: Stig Døssing <[email protected]> Committed: Wed Mar 2 17:58:52 2016 +0100 ---------------------------------------------------------------------- storm-core/src/jvm/org/apache/storm/task/OutputCollector.java | 1 + .../jvm/org/apache/storm/topology/BasicOutputCollector.java | 6 ++++++ 2 files changed, 7 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/storm/blob/94a93d7e/storm-core/src/jvm/org/apache/storm/task/OutputCollector.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/org/apache/storm/task/OutputCollector.java b/storm-core/src/jvm/org/apache/storm/task/OutputCollector.java index 071d8aa..4db87f0 100644 --- a/storm-core/src/jvm/org/apache/storm/task/OutputCollector.java +++ b/storm-core/src/jvm/org/apache/storm/task/OutputCollector.java @@ -221,6 +221,7 @@ public class OutputCollector implements IOutputCollector { /** * Resets the message timeout for any tuple trees to which the given tuple belongs. * The timeout is reset to Config.TOPOLOGY_MESSAGE_TIMEOUT_SECS. + * Note that this is an expensive operation, and should be used sparingly. * @param input the tuple to reset timeout for */ @Override http://git-wip-us.apache.org/repos/asf/storm/blob/94a93d7e/storm-core/src/jvm/org/apache/storm/topology/BasicOutputCollector.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/org/apache/storm/topology/BasicOutputCollector.java b/storm-core/src/jvm/org/apache/storm/topology/BasicOutputCollector.java index 343c349..1d1e5ff 100644 --- a/storm-core/src/jvm/org/apache/storm/topology/BasicOutputCollector.java +++ b/storm-core/src/jvm/org/apache/storm/topology/BasicOutputCollector.java @@ -52,6 +52,12 @@ public class BasicOutputCollector implements IBasicOutputCollector { emitDirect(taskId, Utils.DEFAULT_STREAM_ID, tuple); } + /** + * Resets the message timeout for any tuple trees to which the given tuple belongs. + * The timeout is reset to Config.TOPOLOGY_MESSAGE_TIMEOUT_SECS. + * Note that this is an expensive operation, and should be used sparingly. + * @param input the tuple to reset timeout for + */ public void resetTimeout(Tuple tuple){ out.resetTimeout(tuple); }
