net.openhft.chronicle.bytes

Class DistributedUniqueTimeProvider

java.lang.Object

net.openhft.chronicle.core.io.SimpleCloseable

net.openhft.chronicle.bytes.DistributedUniqueTimeProvider

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.time.TimeProvider

public class DistributedUniqueTimeProvider
extends net.openhft.chronicle.core.io.SimpleCloseable
implements net.openhft.chronicle.core.time.TimeProvider

A TimeProvider implementation that ensures unique timestamps across multiple systems using a predefined hostId. It extends SimpleCloseable and implements TimeProvider to provide functionality for managing the timestamps. This class manages unique timestamp distribution across different hosts/systems.

Field Summary

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Method Summary

Modifier and Type	Method and Description
long	currentTimeMicros() This method returns a unique, monotonically increasing microsecond timestamp where the lowest two digits of the microseconds is the hostId, ensuring uniqueness across different hosts.
long	currentTimeMillis()
long	currentTimeNanos() This method returns a unique, monotonically increasing nanosecond timestamp.
DistributedUniqueTimeDeduplicator	deduplicator() Deprecated.
static DistributedUniqueTimeProvider	forHostId(int hostId)
DistributedUniqueTimeProvider	hostId(int hostId) Sets the hostId of the DistributedUniqueTimeProvider.
static long	hostIdFor(long timestampWithHostId) Extract the hostId from the timestampWithHostId
static DistributedUniqueTimeProvider	instance() Returns an instance of DistributedUniqueTimeProvider.
protected void	performClose()
DistributedUniqueTimeProvider	provider(net.openhft.chronicle.core.time.TimeProvider provider) Sets the TimeProvider of the DistributedUniqueTimeProvider.
static long	timestampFor(long timestampWithHostId) Extract the timestamp in nanoseconds from the timestampWithHostId

Methods inherited from class net.openhft.chronicle.core.io.SimpleCloseable

close, isClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.time.TimeProvider

currentTime

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Methods inherited from interface net.openhft.chronicle.core.io.ManagedCloseable

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosing

Method Detail

instance

public static DistributedUniqueTimeProvider instance()

Returns an instance of DistributedUniqueTimeProvider.

Returns:

the single instance of DistributedUniqueTimeProvider

forHostId

public static DistributedUniqueTimeProvider forHostId(int hostId)

timestampFor

public static long timestampFor(long timestampWithHostId)

Extract the timestamp in nanoseconds from the timestampWithHostId

Parameters:

timestampWithHostId - to extract from

Returns:

the timestamp

hostIdFor

public static long hostIdFor(long timestampWithHostId)

Extract the hostId from the timestampWithHostId

Parameters:

timestampWithHostId - to extract from

Returns:

the hostId

performClose

protected void performClose()

Overrides:

performClose in class net.openhft.chronicle.core.io.SimpleCloseable

hostId

public DistributedUniqueTimeProvider hostId(int hostId)

Sets the hostId of the DistributedUniqueTimeProvider. The hostId is used to create unique timestamps across different hosts.

Parameters:

hostId - The host identifier, must be non-negative.

Returns:

A reference to the current DistributedUniqueTimeProvider instance with the updated hostId.

Throws:

IllegalArgumentException - if the provided hostId is negative.

provider

public DistributedUniqueTimeProvider provider(net.openhft.chronicle.core.time.TimeProvider provider)

Sets the TimeProvider of the DistributedUniqueTimeProvider. The TimeProvider is responsible for providing the current time in nanoseconds.

Parameters:

provider - The TimeProvider instance to be used for fetching the current time.

Returns:

A reference to the current DistributedUniqueTimeProvider instance with the updated TimeProvider.

currentTimeMillis

public long currentTimeMillis()

Specified by:

currentTimeMillis in interface net.openhft.chronicle.core.time.TimeProvider

Returns:

Ordinary millisecond timestamp

currentTimeMicros

public long currentTimeMicros()
                       throws IllegalStateException

This method returns a unique, monotonically increasing microsecond timestamp where the lowest two digits of the microseconds is the hostId, ensuring uniqueness across different hosts.

Specified by:

currentTimeMicros in interface net.openhft.chronicle.core.time.TimeProvider

Returns:

the timestamps with hostId as a long

Throws:

IllegalStateException - if the underlying resources have been released/closed

currentTimeNanos

public long currentTimeNanos()
                      throws IllegalStateException

This method returns a unique, monotonically increasing nanosecond timestamp. The lowest two digits of the nanoseconds is the hostId, providing uniqueness across different hosts.

Specified by:

currentTimeNanos in interface net.openhft.chronicle.core.time.TimeProvider

Returns:

the timestamps with hostId as a long

Throws:

IllegalStateException - if the underlying resources have been released/closed

deduplicator

@Deprecated
public DistributedUniqueTimeDeduplicator deduplicator()

Deprecated.

A deduplicator to help recognise duplicate timestamps for a hostId