You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2019/06/05 06:42:14 UTC

[GitHub] [pulsar] sijie commented on a change in pull request #4435: Introduce batch message container framework and support key based batching container

sijie commented on a change in pull request #4435: Introduce batch message container framework and support key based batching container
URL: https://github.com/apache/pulsar/pull/4435#discussion_r290444736
 
 

 ##########
 File path: pulsar-client-api/src/main/java/org/apache/pulsar/client/api/BatchMessageContainer.java
 ##########
 @@ -0,0 +1,58 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.api;
+
+/**
+ * Batch message container for individual messages being published until they are batched and sent to broker
+ */
+public interface BatchMessageContainer {
+
+    /**
+     * Clear the message batch container.
+     */
+    void clear();
+
+    /**
+     * Check the message batch container is empty.
+     *
+     * @return return true if empty, otherwise return false.
+     */
+    boolean isEmpty();
+
+    /**
+     * Get count of messages in the message batch container.
+     *
+     * @return messages count
+     */
+    int getNumMessagesInBatch();
+
+    /**
+     * Get current message batch size of the message batch container in bytes.
+     *
+     * @return message batch size in bytes
+     */
+    long getCurrentBatchSizeBytes();
 
 Review comment:
   nit: `getCurrentBatchSize` is probably good enough. because `size` is typically in bytes.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services