| /* |
| * Copyright 2015-present Open Networking Foundation |
| * |
| * 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 org.onosproject.store.service; |
| |
| import java.util.concurrent.CompletableFuture; |
| |
| import org.onosproject.store.primitives.DefaultAtomicCounter; |
| |
| /** |
| * An async atomic counter dispenses monotonically increasing values. |
| */ |
| public interface AsyncAtomicCounter extends DistributedPrimitive { |
| |
| @Override |
| default DistributedPrimitive.Type primitiveType() { |
| return DistributedPrimitive.Type.COUNTER; |
| } |
| |
| /** |
| * Atomically increment by one the current value. |
| * |
| * @return updated value |
| */ |
| CompletableFuture<Long> incrementAndGet(); |
| |
| /** |
| * Atomically increment by one the current value. |
| * |
| * @return previous value |
| */ |
| CompletableFuture<Long> getAndIncrement(); |
| |
| /** |
| * Atomically adds the given value to the current value. |
| * |
| * @param delta the value to add |
| * @return previous value |
| */ |
| CompletableFuture<Long> getAndAdd(long delta); |
| |
| /** |
| * Atomically adds the given value to the current value. |
| * |
| * @param delta the value to add |
| * @return updated value |
| */ |
| CompletableFuture<Long> addAndGet(long delta); |
| |
| /** |
| * Returns the current value of the counter without modifying it. |
| * |
| * @return current value |
| */ |
| CompletableFuture<Long> get(); |
| |
| |
| /** |
| * Atomically sets the given value to the current value. |
| * |
| * @param value new value |
| * @return future void |
| */ |
| CompletableFuture<Void> set(long value); |
| |
| /** |
| * Atomically sets the given counter to the updated value if the current value is the expected value, otherwise |
| * no change occurs. |
| * @param expectedValue the expected current value of the counter |
| * @param updateValue the new value to be set |
| * @return true if the update occurred and the expected value was equal to the current value, false otherwise |
| */ |
| CompletableFuture<Boolean> compareAndSet(long expectedValue, long updateValue); |
| |
| /** |
| * Returns a new {@link AtomicCounter} that is backed by this instance. |
| * |
| * @param timeoutMillis timeout duration for the returned ConsistentMap operations |
| * @return new {@code ConsistentMap} instance |
| */ |
| default AtomicCounter asAtomicCounter(long timeoutMillis) { |
| return new DefaultAtomicCounter(this, timeoutMillis); |
| } |
| |
| /** |
| * Returns a new {@link AtomicCounter} that is backed by this instance and with a default operation timeout. |
| * |
| * @return new {@code ConsistentMap} instance |
| */ |
| default AtomicCounter asAtomicCounter() { |
| return new DefaultAtomicCounter(this, DEFAULT_OPERATION_TIMEOUT_MILLIS); |
| } |
| } |