[ISSUE #3604] Some important interface methods add comment

apache · Dec 8, 2021 · b5a8334 · b5a8334
1 parent a47f1ef
commit b5a8334
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git 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
@@ -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);
 }