[rocketmq] branch develop updated: [ISSUE #3604] Some important interface methods add comment

[jinrongtong]

This is an automated email from the ASF dual-hosted git repository.

jinrongtong pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/rocketmq.git


The following commit(s) were added to refs/heads/develop by this push:
     new b5a8334  [ISSUE #3604] Some important interface methods add comment
b5a8334 is described below

commit b5a8334e8ac003c62a5e44fd26e9d764f8d2b284
Author: tianliuliu <643422...@qq.com>
AuthorDate: Wed Dec 8 16:21:39 2021 +0800

    [ISSUE #3604] Some important interface methods add comment
---
 .../java/org/apache/rocketmq/store/CommitLogDispatcher.java   |  4 ++++
 .../org/apache/rocketmq/store/MessageArrivingListener.java    | 11 +++++++++++
 2 files changed, 15 insertions(+)

diff --git 
a/store/src/main/java/org/apache/rocketmq/store/CommitLogDispatcher.java 
b/store/src/main/java/org/apache/rocketmq/store/CommitLogDispatcher.java
index e1564a9..9d6fa6a 100644
--- a/store/src/main/java/org/apache/rocketmq/store/CommitLogDispatcher.java
+++ b/store/src/main/java/org/apache/rocketmq/store/CommitLogDispatcher.java
@@ -22,5 +22,9 @@ package org.apache.rocketmq.store;
  */
 public interface CommitLogDispatcher {
 
+    /**
+     *  Dispatch messages from store to build consume queues, indexes, and 
filter data
+     * @param request dispatch message request
+     */
     void dispatch(final DispatchRequest request);
 }
diff --git 
a/store/src/main/java/org/apache/rocketmq/store/MessageArrivingListener.java 
b/store/src/main/java/org/apache/rocketmq/store/MessageArrivingListener.java
index bae7a16..ceca98f 100644
--- a/store/src/main/java/org/apache/rocketmq/store/MessageArrivingListener.java
+++ b/store/src/main/java/org/apache/rocketmq/store/MessageArrivingListener.java
@@ -20,6 +20,17 @@ package org.apache.rocketmq.store;
 import java.util.Map;
 
 public interface MessageArrivingListener {
+
+    /**
+     * Notify that a new message arrives in a consume queue
+     * @param topic topic name
+     * @param queueId consume queue id
+     * @param logicOffset consume queue offset
+     * @param tagsCode message tags hash code
+     * @param msgStoreTime message store time
+     * @param filterBitMap message bloom filter
+     * @param properties message properties
+     */
     void arriving(String topic, int queueId, long logicOffset, long tagsCode,
         long msgStoreTime, byte[] filterBitMap, Map<String, String> 
properties);
 }