From c217b982bde53a75ff54ca84615bce9bb04f6e96 Mon Sep 17 00:00:00 2001
From: tianliuliu <643422162@qq.com>
Date: Wed, 8 Dec 2021 16:00:48 +0800
Subject: [PATCH] Some important interface methods add comment

---
 .../apache/rocketmq/store/CommitLogDispatcher.java    |  4 ++++
 .../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 e1564a9ef58..9d6fa6ad98b 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 @@
  */
 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 bae7a161689..ceca98f042e 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 @@
 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);
 }