zhouxinyu commented on a change in pull request #3987: URL: https://github.com/apache/rocketmq/pull/3987#discussion_r828802965
########## File path: apis/src/main/java/org/apache/rocketmq/apis/producer/Producer.java ########## @@ -0,0 +1,102 @@ +/* + * 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.rocketmq.apis.producer; + +import com.google.common.util.concurrent.Service; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.io.Closeable; +import org.apache.rocketmq.apis.exception.ClientException; +import org.apache.rocketmq.apis.message.Message; + +/** + * Producer is a thread-safe rocketmq client which is used to publish messages. + * + * <p>On account of network timeout or other reasons, rocketmq producer only promised the at-least-once semantics. + * For producer, at-least-once semantics means potentially attempts are made at sending it, messages may be + * duplicated but not lost. + */ +public interface Producer extends Closeable { + /** + * Sends a message synchronously. + * + * <p>This method does not return until it gets the definitive result. + * + * @param message message to send. + */ + SendReceipt send(Message message) throws ClientException; + + /** + * Sends a transactional message synchronously. + * + * @param message message to send. + * @param transaction transaction to bind. + * @return the message id assigned to the appointed message. + */ + SendReceipt send(Message message, Transaction transaction) throws ClientException; + + /** + * Sends a message asynchronously. + * + * <p>This method returns immediately, the result is included in the {@link CompletableFuture}; + * + * @param message message to send. + * @return a future that indicates the result. + */ + CompletableFuture<SendReceipt> sendAsync(Message message); + + /** + * Sends batch messages synchronously. + * + * <p>This method does not return until it gets the definitive result. + * + * <p>All messages to send should have the same topic. + * + * @param messages batch messages to send. + * @return collection indicates the message id assigned to the appointed message, which keep the same order + * messages collection. + */ + List<SendReceipt> send(List<Message> messages) throws ClientException; + + /** + * Begins a transaction. + * + * <p>For example: + * + * <pre>{@code + * Transaction transaction = producer.beginTransaction(); + * MessageView messageView1 = producer.send(message1, transaction); + * MessageView messageView2 = producer.send(message2, transaction); Review comment: Return SendReceipt -- 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. To unsubscribe, e-mail: dev-unsubscr...@rocketmq.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
