org.apache.pulsar.client.impl.transaction.TransactionBufferHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulsar-client-all
There is a newer version: 4.0.0-preview.1
/*
 * 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.impl.transaction;

import java.util.concurrent.CompletableFuture;
import org.apache.pulsar.client.api.transaction.TxnID;
import org.apache.pulsar.common.api.proto.CommandEndTxnOnPartitionResponse;
import org.apache.pulsar.common.api.proto.CommandEndTxnOnSubscriptionResponse;
import org.apache.pulsar.common.api.proto.TxnAction;

/**
 * Interface of transaction buffer handler.
 */
public interface TransactionBufferHandler {

    /**
     * End transaction on topic.
     * @param topic topic name
     * @param txnIdMostBits txnIdMostBits
     * @param txnIdLeastBits txnIdLeastBits
     * @param action transaction action type
     * @param lowWaterMark low water mark of this transaction
     * @return TxnId
     */
    CompletableFuture endTxnOnTopic(
            String topic, long txnIdMostBits, long txnIdLeastBits, TxnAction action, long lowWaterMark);

    /**
     * End transaction on subscription.
     * @param topic topic name
     * @param subscription subscription name
     * @param txnIdMostBits txnIdMostBits
     * @param txnIdLeastBits txnIdLeastBits
     * @param lowWaterMark low water mark of this transaction
     * @param action transaction action type
     * @return TxnId
     */
    CompletableFuture endTxnOnSubscription(String topic, String subscription, long txnIdMostBits,
        long txnIdLeastBits, TxnAction action, long lowWaterMark);

    /**
     * Handle response of end transaction on topic.
     * @param requestId request ID
     * @param response response
     */
    void handleEndTxnOnTopicResponse(long requestId, CommandEndTxnOnPartitionResponse response);

    /**
     * Handle response of tend transaction on subscription.
     * @param requestId request ID
     * @param response response
     */
    void handleEndTxnOnSubscriptionResponse(long requestId, CommandEndTxnOnSubscriptionResponse response);

    /**
     * Release resources.
     */
    void close();

    int getAvailableRequestCredits();

    int getPendingRequestsCount();
}