xapi.time.service

Interface TimeService

All Superinterfaces:

Comparable<Moment>, Moment, Serializable

All Known Implementing Classes:

AbstractTimeService, JreTimeServiceHighPrecision, TimeServiceDefault, TimeServiceGwt

public interface TimeService
extends Moment

Field Summary

Fields

Modifier and Type	Field and Description
static Double	milli_to_nano
static Double	second_to_nano

Method Summary

Modifier and Type	Method and Description
double	birth() the epoch in millis when this TimeService was instantiated
Moment	clone(Moment moment) creates an immutable copy of a moment
Moment	now()
Moment	nowPlusOne() Returns a new moment guaranteed to be one nano later than any other method.
void	runLater(Runnable runnable) Attempts to sleep if the current thread is not already interrupted.
void	tick() updates now() to current time
String	timestamp()

Methods inherited from interface xapi.time.api.Moment

millis

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

second_to_nano

static final Double second_to_nano

milli_to_nano

static final Double milli_to_nano

Method Detail

clone

Moment clone(Moment moment)

creates an immutable copy of a moment

Parameters:

moment - - The moment to copy

Returns:

an ImmutableMoment that == moment

tick

void tick()

updates now() to current time

birth

double birth()

the epoch in millis when this TimeService was instantiated

Returns:

- System startup time.

now

Moment now()

nowPlusOne

Moment nowPlusOne()

Returns a new moment guaranteed to be one nano later than any other method. We use a volatile delta float which we check-and-increment for each call to nowPlusOne(). This is useful if you want to have usable map keys which point to the same millis timeslow, but have atomic "pseudo nano precision" on systems with low resolution timers. This allows you to use a single ordered queue without resorting to buckets to hold items scheduled at the same time. High resolution time services will use correct nano precision, at the cost of synchronizing on calls to System.nanoTime(), to ensure unique timestamps across all calls to the time service.

Returns:

A guaranteed unique timestamp gauranteed later than now() until the next call to tick();

runLater

void runLater(Runnable runnable)

Attempts to sleep if the current thread is not already interrupted. This method will reset the interrupted flag if the thread is interrupted while sleeping.

Parameters:

millis - - Millis to wait, >= 0

nanos - - Nanos to wait, must be > 0 is millis == 0

timestamp

String timestamp()

Returns:

An ISO-8601 compliant timestamp: yyyy-MM-dd'T'HH:mm.sssZ