Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.store.service; |
| 17 | |
| 18 | import java.util.concurrent.CompletableFuture; |
| 19 | |
| 20 | /** |
| 21 | * An async atomic counter dispenses monotonically increasing values. |
| 22 | */ |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 23 | public interface AsyncAtomicCounter extends DistributedPrimitive { |
| 24 | |
| 25 | @Override |
| 26 | default DistributedPrimitive.Type type() { |
| 27 | return DistributedPrimitive.Type.COUNTER; |
| 28 | } |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 29 | |
| 30 | /** |
| 31 | * Atomically increment by one the current value. |
| 32 | * |
| 33 | * @return updated value |
| 34 | */ |
| 35 | CompletableFuture<Long> incrementAndGet(); |
| 36 | |
| 37 | /** |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 38 | * Atomically increment by one the current value. |
| 39 | * |
| 40 | * @return previous value |
| 41 | */ |
| 42 | CompletableFuture<Long> getAndIncrement(); |
| 43 | |
| 44 | /** |
| 45 | * Atomically adds the given value to the current value. |
| 46 | * |
| 47 | * @param delta the value to add |
| 48 | * @return previous value |
| 49 | */ |
| 50 | CompletableFuture<Long> getAndAdd(long delta); |
| 51 | |
| 52 | /** |
| 53 | * Atomically adds the given value to the current value. |
| 54 | * |
| 55 | * @param delta the value to add |
| 56 | * @return updated value |
| 57 | */ |
| 58 | CompletableFuture<Long> addAndGet(long delta); |
| 59 | |
| 60 | /** |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 61 | * Returns the current value of the counter without modifying it. |
| 62 | * |
| 63 | * @return current value |
| 64 | */ |
| 65 | CompletableFuture<Long> get(); |
andrea | fd912ac | 2015-10-02 14:58:35 -0700 | [diff] [blame] | 66 | |
| 67 | |
| 68 | /** |
| 69 | * Atomically sets the given value to the current value. |
| 70 | * |
Brian O'Connor | 5251562 | 2015-10-09 17:03:44 -0700 | [diff] [blame] | 71 | * @param value new value |
andrea | fd912ac | 2015-10-02 14:58:35 -0700 | [diff] [blame] | 72 | * @return future void |
| 73 | */ |
| 74 | CompletableFuture<Void> set(long value); |
Aaron Kruglikov | 82fd632 | 2015-10-06 12:02:46 -0700 | [diff] [blame] | 75 | |
| 76 | /** |
| 77 | * Atomically sets the given counter to the updated value if the current value is the expected value, otherwise |
| 78 | * no change occurs. |
| 79 | * @param expectedValue the expected current value of the counter |
| 80 | * @param updateValue the new value to be set |
| 81 | * @return true if the update occurred and the expected value was equal to the current value, false otherwise |
| 82 | */ |
| 83 | CompletableFuture<Boolean> compareAndSet(long expectedValue, long updateValue); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 84 | } |