com.hazelcast.client.impl.protocol.template

Interface PNCounterGeneratorCodecTemplate

public interface PNCounterGeneratorCodecTemplate

Method Summary

Modifier and Type	Method and Description
Object	add(String name, long delta, boolean getBeforeUpdate, List<Map.Entry<String,Long>> replicaTimestamps, Address targetReplica) Adds a delta to the PNCounter value.
Object	get(String name, List<Map.Entry<String,Long>> replicaTimestamps, Address targetReplica) Query operation to retrieve the current value of the PNCounter.
Object	getConfiguredReplicaCount(String name) Returns the configured number of CRDT replicas for the PN counter with the given name.

Method Detail

get

@Since(value="1.6")
Object get(String name,
                               List<Map.Entry<String,Long>> replicaTimestamps,
                               Address targetReplica)

Query operation to retrieve the current value of the PNCounter.

The invocation will return the replica timestamps (vector clock) which can then be sent with the next invocation to keep session consistency guarantees. The target replica is determined by the targetReplica parameter. If smart routing is disabled, the actual member processing the client message may act as a proxy.

Parameters:

name - the name of the PNCounter

replicaTimestamps - last observed replica timestamps (vector clock)

targetReplica - the target replica

Returns:

the current value of the counter

add

@Since(value="1.6")
Object add(String name,
                               long delta,
                               boolean getBeforeUpdate,
                               List<Map.Entry<String,Long>> replicaTimestamps,
                               Address targetReplica)

Adds a delta to the PNCounter value. The delta may be negative for a subtraction.

The invocation will return the replica timestamps (vector clock) which can then be sent with the next invocation to keep session consistency guarantees. The target replica is determined by the targetReplica parameter. If smart routing is disabled, the actual member processing the client message may act as a proxy.

Parameters:

name - the name of the PNCounter

delta - the delta to add to the counter value, can be negative

getBeforeUpdate - true if the operation should return the counter value before the addition, false if it should return the value after the addition

replicaTimestamps - last observed replica timestamps (vector clock)

targetReplica - the target replica

Returns:

the value before the update if getBeforeUpdate is true, otherwise the value after the update

getConfiguredReplicaCount

@Since(value="1.6")
Object getConfiguredReplicaCount(String name)

Returns the configured number of CRDT replicas for the PN counter with the given name. The actual replica count may be less, depending on the number of data members in the cluster (members that own data).

Parameters:

name - the name of the PNCounter

Returns:

the configured replica count