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.Monitorable, 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, net.openhft.chronicle.core.io.Monitorable

TimeProvider implementation producing timestamps that remain unique across JVMs by embedding a host identifier in the lower bits. A memory mapped file coordinates monotonicity between processes. currentTimeMillis() simply delegates to the underlying provider and is therefore not unique.

Field Summary

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

INIT, TMP

Method Summary

Modifier and Type	Method and Description
long	currentTimeMicros() Generates a unique microsecond-resolution timestamp embedding the configured host id.
long	currentTimeMillis() NOTE: Calls to this method do not produce unique timestamps, rather just calls the underlying provider.
long	currentTimeNanos() Generates a unique nanosecond-resolution timestamp embedding the host id.
static DistributedUniqueTimeProvider	forHostId(int hostId) Creates a new instance of DistributedUniqueTimeProvider for a specified hostId.
DistributedUniqueTimeProvider	hostId(int hostId) Configures the host identifier used in generated timestamps.
static long	hostIdFor(long timestampWithHostId) Extract the hostId from the timestampWithHostId
static DistributedUniqueTimeProvider	instance() Provides a singleton instance of DistributedUniqueTimeProvider using the default hostId.
protected void	performClose()
DistributedUniqueTimeProvider	provider(net.openhft.chronicle.core.time.TimeProvider provider) Replaces the underlying time source used for wall-clock time.
static long	timestampFor(long timestampWithHostId) Extract the timestamp in nanoseconds from the timestampWithHostId
void	unmonitor()

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.io.Monitorable

unmonitor

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()

Provides a singleton instance of DistributedUniqueTimeProvider using the default hostId. This method is thread-safe and uses lazy initialization.

Returns:

the single, shared instance of DistributedUniqueTimeProvider

forHostId

public static DistributedUniqueTimeProvider forHostId(int hostId)

Creates a new instance of DistributedUniqueTimeProvider for a specified hostId. This is useful in scenarios where multiple instances are required, each with a different hostId.

Parameters:

hostId - the host identifier for which the time provider is to be created, must be non-negative

Returns:

a new instance of DistributedUniqueTimeProvider configured with the given 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)

Configures the host identifier used in generated timestamps.

provider

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

Replaces the underlying time source used for wall-clock time.

currentTimeMillis

public long currentTimeMillis()

NOTE: Calls to this method do not produce unique timestamps, rather just calls the underlying provider.

Use currentTimeMicros() or currentTimeNanos() to generate unique timestamps, or use UniqueMicroTimeProvider.currentTimeMillis() to generate unique timestamps.

Specified by:

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

Returns:

Ordinary millisecond timestamp

currentTimeMicros

public long currentTimeMicros()
                       throws IllegalStateException

Generates a unique microsecond-resolution timestamp embedding the configured host id.

Specified by:

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

Throws:

IllegalStateException

currentTimeNanos

public long currentTimeNanos()
                      throws IllegalStateException

Generates a unique nanosecond-resolution timestamp embedding the host id.

Specified by:

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

Throws:

IllegalStateException

unmonitor

public void unmonitor()

Specified by:

unmonitor in interface net.openhft.chronicle.core.io.Monitorable