org.apache.pulsar.functions.api.state.CounterStateStore Maven / Gradle / Ivy
/**
* 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.functions.api.state;
import java.util.concurrent.CompletableFuture;
import org.apache.pulsar.functions.api.StateStore;
/**
* The state store supports counters.
*/
public interface CounterStateStore extends StateStore {
/**
* Increment the builtin distributed counter referred by key.
*
* @param key The name of the key
* @param amount The amount to be incremented
*/
void incrCounter(String key, long amount);
/**
* Increment the builtin distributed counter referred by key
* but dont wait for the completion of the increment operation.
*
* @param key The name of the key
* @param amount The amount to be incremented
*/
CompletableFuture incrCounterAsync(String key, long amount);
/**
* Retrieve the counter value for the key.
*
* @param key name of the key
* @return the amount of the counter value for this key
*/
long getCounter(String key);
/**
* Retrieve the counter value for the key, but don't wait
* for the operation to be completed.
*
* @param key name of the key
* @return the amount of the counter value for this key
*/
CompletableFuture getCounterAsync(String key);
}