AtomixAtomicCounterMapState (onos-apps-fwd)

java.lang.Object
- io.atomix.copycat.server.StateMachine
- - io.atomix.resource.ResourceStateMachine
  - - org.onosproject.store.primitives.resources.impl.AtomixAtomicCounterMapState

All Implemented Interfaces:

io.atomix.copycat.server.session.SessionListener, io.atomix.copycat.server.Snapshottable, AutoCloseable
```
public class AtomixAtomicCounterMapState
extends io.atomix.resource.ResourceStateMachine
implements io.atomix.copycat.server.Snapshottable
```
Atomic counter map state for Atomix.
The counter map state is implemented as a snapshottable state machine. Snapshots are necessary since incremental compaction is impractical for counters where the value of a counter is the sum of all its increments. Note that this snapshotting large state machines may risk blocking of the Raft cluster with the current implementation of snapshotting in Copycat.

Field Summary
- Fields inherited from class io.atomix.resource.ResourceStateMachine
  config
- Fields inherited from class io.atomix.copycat.server.StateMachine
  clock, context, executor, sessions

Constructor Summary

Constructors
Constructor and Description

AtomixAtomicCounterMapState(Properties config)

Constructors
Constructor and Description
`AtomixAtomicCounterMapState(Properties config)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected long`	`addAndGet(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.AddAndGet> commit)` Handles a `AtomixAtomicCounterMapCommands.AddAndGet` command which implements `AtomixAtomicCounterMap.addAndGet(String, long)`.
`protected void`	`clear(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Clear> commit)` Handles a `AtomixAtomicCounterMapCommands.Clear` command which implements `AtomixAtomicCounterMap.clear()`.
`protected void`	`configure(io.atomix.copycat.server.StateMachineExecutor executor)`
`protected long`	`decrementAndGet(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.DecrementAndGet> commit)` Handles a `AtomixAtomicCounterMapCommands.DecrementAndGet` command which implements `AtomixAtomicCounterMap.decrementAndGet(String)`.
`protected long`	`get(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Get> commit)` Handles a `AtomixAtomicCounterMapCommands.Get` query which implements `AtomixAtomicCounterMap.get(String)`}.
`protected long`	`getAndAdd(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.GetAndAdd> commit)` Handles a `AtomixAtomicCounterMapCommands.GetAndAdd` command which implements `AtomixAtomicCounterMap.getAndAdd(String, long)`.
`protected long`	`getAndDecrement(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.GetAndDecrement> commit)` Handles a `AtomixAtomicCounterMapCommands.GetAndDecrement` command which implements `AtomixAtomicCounterMap.getAndDecrement(String)`.
`protected long`	`getAndIncrement(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.GetAndIncrement> commit)` Handles a `AtomixAtomicCounterMapCommands.GetAndIncrement` command which implements `AtomixAtomicCounterMap.getAndIncrement(String)`.
`protected long`	`incrementAndGet(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.IncrementAndGet> commit)` Handles a `AtomixAtomicCounterMapCommands.IncrementAndGet` command which implements `AtomixAtomicCounterMap.incrementAndGet(String)`.
`void`	`install(io.atomix.copycat.server.storage.snapshot.SnapshotReader reader)`
`protected boolean`	`isEmpty(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.IsEmpty> commit)` Handles an `AtomixAtomicCounterMapCommands.IsEmpty` query which implements `AtomixAtomicCounterMap.isEmpty()`.
`protected long`	`put(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Put> commit)` Handles a `AtomixAtomicCounterMapCommands.Put` command which implements `AtomixAtomicCounterMap.put(String, long)`.
`protected long`	`putIfAbsent(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.PutIfAbsent> commit)` Handles a `AtomixAtomicCounterMapCommands.PutIfAbsent` command which implements `AtomixAtomicCounterMap.putIfAbsent(String, long)`.
`protected long`	`remove(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Remove> commit)` Handles a `AtomixAtomicCounterMapCommands.Remove` command which implements `AtomixAtomicCounterMap.remove(String)`.
`protected boolean`	`removeValue(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.RemoveValue> commit)` Handles a `AtomixAtomicCounterMapCommands.RemoveValue` command which implements `AtomixAtomicCounterMap.remove(String, long)`.
`protected boolean`	`replace(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Replace> commit)` Handles a `AtomixAtomicCounterMapCommands.Replace` command which implements `AtomixAtomicCounterMap.replace(String, long, long)`.
`protected int`	`size(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Size> commit)` Handles a `AtomixAtomicCounterMapCommands.Size` query which implements `AtomixAtomicCounterMap.size()`.
`void`	`snapshot(io.atomix.copycat.server.storage.snapshot.SnapshotWriter writer)`

Methods inherited from class io.atomix.resource.ResourceStateMachine
close, delete, expire, init, notify, register, unregister

Methods inherited from class io.atomix.copycat.server.StateMachine
close

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AtomixAtomicCounterMapState
```
public AtomixAtomicCounterMapState(Properties config)
```
- Method Detail
  - configure
```
protected void configure(io.atomix.copycat.server.StateMachineExecutor executor)
```
    Overrides:
    
    configure in class io.atomix.copycat.server.StateMachine
  - snapshot
```
public void snapshot(io.atomix.copycat.server.storage.snapshot.SnapshotWriter writer)
```
    Specified by:
    
    snapshot in interface io.atomix.copycat.server.Snapshottable
  - install
```
public void install(io.atomix.copycat.server.storage.snapshot.SnapshotReader reader)
```
    Specified by:
    
    install in interface io.atomix.copycat.server.Snapshottable
  - put
```
protected long put(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Put> commit)
```
    Handles a AtomixAtomicCounterMapCommands.Put command which implements AtomixAtomicCounterMap.put(String, long).
    
    Parameters:
    
    commit - put commit
    
    Returns:
    
    put result
  - putIfAbsent
```
protected long putIfAbsent(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.PutIfAbsent> commit)
```
    Handles a AtomixAtomicCounterMapCommands.PutIfAbsent command which implements AtomixAtomicCounterMap.putIfAbsent(String, long).
    
    Parameters:
    
    commit - putIfAbsent commit
    
    Returns:
    
    putIfAbsent result
  - get
```
protected long get(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Get> commit)
```
    Handles a AtomixAtomicCounterMapCommands.Get query which implements AtomixAtomicCounterMap.get(String)}.
    
    Parameters:
    
    commit - get commit
    
    Returns:
    
    get result
  - replace
```
protected boolean replace(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Replace> commit)
```
    Handles a AtomixAtomicCounterMapCommands.Replace command which implements AtomixAtomicCounterMap.replace(String, long, long).
    
    Parameters:
    
    commit - replace commit
    
    Returns:
    
    replace result
  - remove
```
protected long remove(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Remove> commit)
```
    Handles a AtomixAtomicCounterMapCommands.Remove command which implements AtomixAtomicCounterMap.remove(String).
    
    Parameters:
    
    commit - remove commit
    
    Returns:
    
    remove result
  - removeValue
```
protected boolean removeValue(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.RemoveValue> commit)
```
    Handles a AtomixAtomicCounterMapCommands.RemoveValue command which implements AtomixAtomicCounterMap.remove(String, long).
    
    Parameters:
    
    commit - removeValue commit
    
    Returns:
    
    removeValue result
  - getAndIncrement
```
protected long getAndIncrement(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.GetAndIncrement> commit)
```
    Handles a AtomixAtomicCounterMapCommands.GetAndIncrement command which implements AtomixAtomicCounterMap.getAndIncrement(String).
    
    Parameters:
    
    commit - getAndIncrement commit
    
    Returns:
    
    getAndIncrement result
  - getAndDecrement
```
protected long getAndDecrement(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.GetAndDecrement> commit)
```
    Handles a AtomixAtomicCounterMapCommands.GetAndDecrement command which implements AtomixAtomicCounterMap.getAndDecrement(String).
    
    Parameters:
    
    commit - getAndDecrement commit
    
    Returns:
    
    getAndDecrement result
  - incrementAndGet
```
protected long incrementAndGet(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.IncrementAndGet> commit)
```
    Handles a AtomixAtomicCounterMapCommands.IncrementAndGet command which implements AtomixAtomicCounterMap.incrementAndGet(String).
    
    Parameters:
    
    commit - incrementAndGet commit
    
    Returns:
    
    incrementAndGet result
  - decrementAndGet
```
protected long decrementAndGet(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.DecrementAndGet> commit)
```
    Handles a AtomixAtomicCounterMapCommands.DecrementAndGet command which implements AtomixAtomicCounterMap.decrementAndGet(String).
    
    Parameters:
    
    commit - decrementAndGet commit
    
    Returns:
    
    decrementAndGet result
  - addAndGet
```
protected long addAndGet(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.AddAndGet> commit)
```
    Handles a AtomixAtomicCounterMapCommands.AddAndGet command which implements AtomixAtomicCounterMap.addAndGet(String, long).
    
    Parameters:
    
    commit - addAndGet commit
    
    Returns:
    
    addAndGet result
  - getAndAdd
```
protected long getAndAdd(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.GetAndAdd> commit)
```
    Handles a AtomixAtomicCounterMapCommands.GetAndAdd command which implements AtomixAtomicCounterMap.getAndAdd(String, long).
    
    Parameters:
    
    commit - getAndAdd commit
    
    Returns:
    
    getAndAdd result
  - size
```
protected int size(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Size> commit)
```
    Handles a AtomixAtomicCounterMapCommands.Size query which implements AtomixAtomicCounterMap.size().
    
    Parameters:
    
    commit - size commit
    
    Returns:
    
    size result
  - isEmpty
```
protected boolean isEmpty(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.IsEmpty> commit)
```
    Handles an AtomixAtomicCounterMapCommands.IsEmpty query which implements AtomixAtomicCounterMap.isEmpty().
    
    Parameters:
    
    commit - isEmpty commit
    
    Returns:
    
    isEmpty result
  - clear
```
protected void clear(io.atomix.copycat.server.Commit<AtomixAtomicCounterMapCommands.Clear> commit)
```
    Handles a AtomixAtomicCounterMapCommands.Clear command which implements AtomixAtomicCounterMap.clear().
    
    Parameters:
    
    commit - clear commit

Class AtomixAtomicCounterMapState

Field Summary

Fields inherited from class io.atomix.resource.ResourceStateMachine

Fields inherited from class io.atomix.copycat.server.StateMachine

Constructor Summary

Method Summary

Methods inherited from class io.atomix.resource.ResourceStateMachine

Methods inherited from class io.atomix.copycat.server.StateMachine

Methods inherited from class java.lang.Object

Constructor Detail

AtomixAtomicCounterMapState

Method Detail

configure

snapshot

install

put

putIfAbsent

get

replace

remove

removeValue

getAndIncrement

getAndDecrement

incrementAndGet

decrementAndGet

addAndGet

getAndAdd

size

isEmpty

clear