Package org.jgroups.protocols

Class COUNTER.CounterImpl

java.lang.Object

org.jgroups.protocols.COUNTER.CounterImpl

All Implemented Interfaces:

AsyncCounter, BaseCounter

Enclosing class:

COUNTER

protected class COUNTER.CounterImpl
extends Object
implements AsyncCounter

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name
(package private) final COUNTER.SyncCounterImpl	sync

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CounterImpl(String name)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Long>	addAndGet(long delta)	Atomically adds the given value to the current value.
CompletableFuture<Long>	compareAndSwap(long expect, long update)	Atomically updates the counter using a compare-and-swap operation.
String	getName()
CompletableFuture<Void>	set(long new_value)	Sets the counter to a new value.
SyncCounter	sync()	Returns a SyncCounter wrapper for this instance.
String	toString()
<T extends Streamable> CompletionStage<T>	update(CounterFunction<T> updateFunction)	Atomically updates the counter's value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgroups.blocks.atomic.AsyncCounter

async, compareAndSet, decrementAndGet, get, incrementAndGet

Field Details

name

protected final String name

sync

final COUNTER.SyncCounterImpl sync

Constructor Details

CounterImpl

protected CounterImpl(String name)

Method Details

getName

public String getName()

Specified by:

getName in interface BaseCounter

Returns:

The counter's name.

set

public CompletableFuture<Void> set(long new_value)

Description copied from interface: AsyncCounter

Sets the counter to a new value.

Specified by:

set in interface AsyncCounter

Returns:

A CompletionStage that is completed with the counter's value is updated.

compareAndSwap

public CompletableFuture<Long> compareAndSwap(long expect,
 long update)

Description copied from interface: AsyncCounter

Atomically updates the counter using a compare-and-swap operation.

Specified by:

compareAndSwap in interface AsyncCounter

Parameters:

expect - The expected value of the counter

update - The new value of the counter

Returns:

A CompletionStage that is completed with the current counter's value.

addAndGet

public CompletableFuture<Long> addAndGet(long delta)

Description copied from interface: AsyncCounter

Atomically adds the given value to the current value.

Specified by:

addAndGet in interface AsyncCounter

Parameters:

delta - the value to add

Returns:

A CompletionStage that is completed with the updated counter's value.

update

public <T extends Streamable> CompletionStage<T> update(CounterFunction<T> updateFunction)

Description copied from interface: AsyncCounter

Atomically updates the counter's value.

Both CounterFunction and return value must implement Streamable to be sent over the network. The function should not block thread since it can cause deadlocks neither invoke any operation over the AsyncCounter.

The CounterView is a copy of the counter's value and the last CounterView.set(long) will be applied to the counter.

Specified by:

update in interface AsyncCounter

Type Parameters:

T - The return value type.

Parameters:

updateFunction - The update CounterFunction.

Returns:

The CompletionStage which will be completed with the CounterFunction return value.

See Also:

• CounterFunction
• CounterView
• LongSizeStreamable

sync

public SyncCounter sync()

Description copied from interface: BaseCounter

Returns a SyncCounter wrapper for this instance. If this counter is already synchronous, then this counter instance is returned (no-op)

Specified by:

sync in interface BaseCounter

Returns:

The SyncCounter instance;

toString

public String toString()

Overrides:

toString in class Object