com.hazelcast.cp.IAtomicLong Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
*
* Licensed 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 com.hazelcast.cp;
import com.hazelcast.config.cp.CPSubsystemConfig;
import com.hazelcast.core.DistributedObject;
import com.hazelcast.core.IFunction;
import java.util.concurrent.CompletionStage;
/**
* IAtomicLong is a redundant and highly available distributed alternative to
* the {@link java.util.concurrent.atomic.AtomicLong}.
*
* Asynchronous variants of all methods have been introduced in version 3.7.
* Async methods immediately return a {@link CompletionStage} which can be used to
* chain further computation stages or can be converted to a {@code CompletableFuture}
* from which the operation's result can be obtained in a blocking manner. For example:
*
* CompletionStage<Long> stage = atomicLong.addAndGetAsync(13);
* stage.whenCompleteAsync((response, t) -> {
* if (t == null) {
* // do something with the result
* } else {
* // handle failure
* }
* });
*
*
* Actions supplied for dependent completions of default non-async methods and async methods
* without an explicit {@link java.util.concurrent.Executor} argument are performed
* by the {@link java.util.concurrent.ForkJoinPool#commonPool()} (unless it does not
* support a parallelism level of at least 2, in which case a new {@code Thread} is
* created per task).
*
* IAtomicLong is accessed via {@link CPSubsystem#getAtomicLong(String)}.
* It works on top of the Raft consensus algorithm. It offers linearizability during crash
* failures and network partitions. It is CP with respect to the CAP principle.
* If a network partition occurs, it remains available on at most one side
* of the partition.
*
* IAtomicLong impl does not offer exactly-once / effectively-once
* execution semantics. It goes with at-least-once execution semantics
* by default and can cause an API call to be committed multiple times
* in case of CP member failures. It can be tuned to offer at-most-once
* execution semantics. Please see
* {@link CPSubsystemConfig#setFailOnIndeterminateOperationState(boolean)}
*
* @see IAtomicReference
*/
public interface IAtomicLong extends DistributedObject {
/**
* Returns the name of this IAtomicLong instance.
*
* @return the name of this IAtomicLong instance
*/
String getName();
/**
* Atomically adds the given value to the current value.
*
* @param delta the value to add to the current value
* @return the updated value, the given value added to the current value
*/
long addAndGet(long delta);
/**
* Atomically sets the value to the given updated value
* only if the current value {@code ==} the expected value.
*
* @param expect the expected value
* @param update the new value
* @return {@code true} if successful; or {@code false} if the actual value
* was not equal to the expected value.
*/
boolean compareAndSet(long expect, long update);
/**
* Atomically decrements the current value by one.
*
* @return the updated value, the current value decremented by one
*/
long decrementAndGet();
/**
* Atomically decrements the current value by one.
*
* @return the old value
*/
long getAndDecrement();
/**
* Gets the current value.
*
* @return the current value
*/
long get();
/**
* Atomically adds the given value to the current value.
*
* @param delta the value to add to the current value
* @return the old value before the add
*/
long getAndAdd(long delta);
/**
* Atomically sets the given value and returns the old value.
*
* @param newValue the new value
* @return the old value
*/
long getAndSet(long newValue);
/**
* Atomically increments the current value by one.
*
* @return the updated value, the current value incremented by one
*/
long incrementAndGet();
/**
* Atomically increments the current value by one.
*
* @return the old value
*/
long getAndIncrement();
/**
* Atomically sets the given value.
*
* @param newValue the new value
*/
void set(long newValue);
/**
* Alters the currently stored value by applying a function on it.
*
* @param function the function applied to the currently stored value
* @throws IllegalArgumentException if function is {@code null}
* @since 3.2
*/
void alter(IFunction function);
/**
* Alters the currently stored value by applying a function on it and
* gets the result.
*
* @param function the function applied to the currently stored value
* @return the new value
* @throws IllegalArgumentException if function is {@code null}
* @since 3.2
*/
long alterAndGet(IFunction function);
/**
* Alters the currently stored value by applying a function on it on and
* gets the old value.
*
* @param function the function applied to the currently stored value
* @return the old value
* @throws IllegalArgumentException if function is {@code null}
* @since 3.2
*/
long getAndAlter(IFunction function);
/**
* Applies a function on the value, the actual stored value will not change.
*
* @param function the function applied to the value, the value is not changed
* @param the result type of the function
* @return the result of the function application
* @throws IllegalArgumentException if function is {@code null}
* @since 3.2
*/
R apply(IFunction function);
/**
* Atomically adds the given value to the current value.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* The operations result can be obtained in a blocking way, or a callback
* can be provided for execution upon completion, as demonstrated in the
* following examples:
*
* CompletionStage<Long> stage = atomicLong.addAndGetAsync(13);
* // do something else, then read the result
*
* // this method will block until the result is available
* Long result = stage.toCompletableFuture().get();
*
*
* CompletionStage<Long> stage = atomicLong.addAndGetAsync(13);
* stage.whenCompleteAsync((response, t) -> {
* if (t == null) {
* // do something with the result
* } else {
* // handle failure
* }
* });
*
*
* @param delta the value to add
* @return a {@link CompletionStage} bearing the response
* @since 3.7
*/
CompletionStage addAndGetAsync(long delta);
/**
* Atomically sets the value to the given updated value
* only if the current value {@code ==} the expected value.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @param expect the expected value
* @param update the new value
* @return an {@link CompletionStage} with value {@code true} if successful;
* or {@code false} if the actual value was not equal to the expected value
* @since 3.7
*/
CompletionStage compareAndSetAsync(long expect, long update);
/**
* Atomically decrements the current value by one.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @return a {@link CompletionStage} with the updated value
* @since 3.7
*/
CompletionStage decrementAndGetAsync();
/**
* Atomically decrements the current value by one.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @return a {@link CompletionStage} with the old value
* @since 4.1
*/
CompletionStage getAndDecrementAsync();
/**
* Gets the current value. This method will dispatch a request and return
* immediately a {@link CompletionStage}.
*
* @return a {@link CompletionStage} with the current value
* @since 3.7
*/
CompletionStage getAsync();
/**
* Atomically adds the given value to the current value.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @param delta the value to add
* @return a {@link CompletionStage} with the old value before the addition
* @since 3.7
*/
CompletionStage getAndAddAsync(long delta);
/**
* Atomically sets the given value and returns the old value.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @param newValue the new value
* @return a {@link CompletionStage} with the old value
* @since 3.7
*/
CompletionStage getAndSetAsync(long newValue);
/**
* Atomically increments the current value by one.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @return a {@link CompletionStage} with the updated value
* @since 3.7
*/
CompletionStage incrementAndGetAsync();
/**
* Atomically increments the current value by one.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @return a {@link CompletionStage} with the old value
* @since 3.7
*/
CompletionStage getAndIncrementAsync();
/**
* Atomically sets the given value.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @param newValue the new value
* @return a {@link CompletionStage}
* @since 3.7
*/
CompletionStage setAsync(long newValue);
/**
* Alters the currently stored value by applying a function on it.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @param function the function
* @return a {@link CompletionStage} with the new value
* @throws IllegalArgumentException if function is {@code null}
* @since 3.7
*/
CompletionStage alterAsync(IFunction function);
/**
* Alters the currently stored value by applying a function on it and gets
* the result.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @param function the function
* @return a {@link CompletionStage} with the new value
* @throws IllegalArgumentException if function is {@code null}
* @since 3.7
*/
CompletionStage alterAndGetAsync(IFunction function);
/**
* Alters the currently stored value by applying a function on it on and
* gets the old value.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}.
*
* @param function the function
* @return a {@link CompletionStage} with the old value
* @throws IllegalArgumentException if function is {@code null}
* @since 3.7
*/
CompletionStage getAndAlterAsync(IFunction function);
/**
* Applies a function on the value, the actual stored value will not
* change.
*
* This method will dispatch a request and return immediately a
* {@link CompletionStage}. For example:
*
* class IsOneFunction implements IFunction<Long, Boolean> {
* @Override
* public Boolean apply(Long input) {
* return input.equals(1L);
* }
* }
*
* CompletionStage<Boolean> stage = atomicLong.applyAsync(new IsOneFunction());
* stage.whenCompleteAsync((response, t) -> {
* if (t == null) {
* // do something with the response
* } else {
* // handle failure
* }
* });
*
*
* @param function the function
* @param the result type of the function
* @return a {@link CompletionStage} with the result of the function application
* @throws IllegalArgumentException if function is {@code null}
* @since 3.7
*/
CompletionStage applyAsync(IFunction function);
}