com.hazelcast.flakeidgen.impl

Class FlakeIdGeneratorProxy

java.lang.Object

com.hazelcast.spi.AbstractDistributedObject<FlakeIdGeneratorService>

com.hazelcast.flakeidgen.impl.FlakeIdGeneratorProxy

All Implemented Interfaces:

DistributedObject, IdGenerator, FlakeIdGenerator

public class FlakeIdGeneratorProxy
extends AbstractDistributedObject<FlakeIdGeneratorService>
implements FlakeIdGenerator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlakeIdGeneratorProxy.IdBatchAndWaitTime

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITS_NODE_ID
static int	BITS_SEQUENCE
static int	BITS_TIMESTAMP
static long	INCREMENT The difference between two IDs from a sequence on single member

Fields inherited from class com.hazelcast.spi.AbstractDistributedObject

PARTITIONING_STRATEGY

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the unique name for this DistributedObject.
String	getServiceName() Returns the service name for this object.
boolean	init(long id) Tries to initialize this IdGenerator instance with the given ID.
long	newId() Generates and returns a cluster-wide unique ID.
FlakeIdGeneratorProxy.IdBatchAndWaitTime	newIdBatch(int batchSize)

Methods inherited from class com.hazelcast.spi.AbstractDistributedObject

destroy, equals, getDistributedObjectName, getNameAsPartitionAwareData, getNodeEngine, getOperationService, getPartitionId, getPartitionKey, getService, hashCode, invalidate, invokeOnPartition, postDestroy, preDestroy, throwNotActiveException, toData, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hazelcast.core.DistributedObject

destroy, getPartitionKey

Field Detail

BITS_TIMESTAMP

public static final int BITS_TIMESTAMP

See Also:

Constant Field Values

BITS_SEQUENCE

public static final int BITS_SEQUENCE

See Also:

Constant Field Values

BITS_NODE_ID

public static final int BITS_NODE_ID

See Also:

Constant Field Values

INCREMENT

public static final long INCREMENT

The difference between two IDs from a sequence on single member

See Also:

Constant Field Values

Method Detail

newId

public long newId()

Description copied from interface: FlakeIdGenerator

Generates and returns a cluster-wide unique ID.

Operation on member is always local, if the member has valid node ID, otherwise it's remote. On client, this method goes to a random member and gets a batch of IDs, which will then be returned locally for limited time. The pre-fetch size and the validity time can be configured for each client and member, see here for member config and see ClientConfig.addFlakeIdGeneratorConfig() for client config.

Note: Values returned from this method may be not strictly ordered.

Specified by:

newId in interface IdGenerator

Specified by:

newId in interface FlakeIdGenerator

Returns:

new cluster-wide unique ID

init

public boolean init(long id)

Description copied from interface: FlakeIdGenerator

Tries to initialize this IdGenerator instance with the given ID.

The next generated ID will be 1 greater than the supplied ID.

Note for Flake ID Generator: This method does nothing and will simply tell if the next ID will be larger than the given ID. You don't need to call this method on cluster restart - uniqueness is preserved thanks to the timestamp component of the ID.

Specified by:

init in interface IdGenerator

Specified by:

init in interface FlakeIdGenerator

Returns:

true, if the next ID will be larger than the supplied id

newIdBatch

public FlakeIdGeneratorProxy.IdBatchAndWaitTime newIdBatch(int batchSize)

getName

public String getName()

Description copied from interface: DistributedObject

Returns the unique name for this DistributedObject. The returned value will never be null. The suggested way for getting name is retrieving it through DistributedObjectUtil.getName(DistributedObject) because this might be also a PrefixedDistributedObject.

Specified by:

getName in interface DistributedObject

Returns:

the unique name for this object.

getServiceName

public String getServiceName()

Description copied from interface: DistributedObject

Returns the service name for this object.

Specified by:

getServiceName in interface DistributedObject

Specified by:

getServiceName in class AbstractDistributedObject<FlakeIdGeneratorService>

Returns:

the service name for this object.