Module me.ahoo.cosid.core

Package me.ahoo.cosid.internal

Class ExpiringRangeCursor

java.lang.Object

me.ahoo.cosid.internal.RangeCursor

me.ahoo.cosid.internal.ExpiringRangeCursor

public final class ExpiringRangeCursor
extends RangeCursor

A cursor with a deadline, for BatchPolicy.rangeTtl (04-segment.md §2): past it the rest of the range is dropped. A separate class, so generators without a time to live pay nothing for it.

Field Summary

Fields inherited from class me.ahoo.cosid.internal.RangeCursor

HEADROOM

Constructor Summary

Constructors

Constructor	Description
ExpiringRangeCursor(long start, long end, long expiresAtMillis, TimeSource time)	A cursor on [start, end) until expiresAtMillis.

Method Summary

Modifier and Type	Method	Description
long	expiresAtMillis()
long	remaining(long nowMillis)	The values not taken yet.
long	take()	Takes the next value.

Methods inherited from class me.ahoo.cosid.internal.RangeCursor

cap, end, of, untaken, usable

Methods inherited from class java.lang.Object

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

Constructor Details

ExpiringRangeCursor

public ExpiringRangeCursor(long start,
 long end,
 long expiresAtMillis,
 TimeSource time)

A cursor on [start, end) until expiresAtMillis.

Parameters:

start - the first value

end - the end, exclusive, already capped

expiresAtMillis - from this time on nothing is issued

time - the time source

Method Details

expiresAtMillis

public long expiresAtMillis()

take

public long take()

Description copied from class: RangeCursor

Takes the next value.

Overrides:

take in class RangeCursor

Returns:

the value, or -1 if the cursor is used up (or expired)

remaining

public long remaining(long nowMillis)

Description copied from class: RangeCursor

The values not taken yet.

Overrides:

remaining in class RangeCursor

Parameters:

nowMillis - the current time

Returns:

the values left, 0 if none or expired