com.apple.foundationdb.record

Class ByteScanLimiter

java.lang.Object

com.apple.foundationdb.record.ByteScanLimiter

@API(value=INTERNAL)
public class ByteScanLimiter
extends Object

Track the number of bytes scanned up to some limit, after which record scans should not be allowed.

See Also:

ExecuteState.getByteScanLimiter()

Constructor Summary

Constructors

Constructor and Description
ByteScanLimiter(long limit)

Method Summary

Modifier and Type	Method and Description
long	getLimit() Get the byte scan limit.
boolean	hasBytesRemaining() Atomically check whether the number of remaining bytes is at least 0.
void	registerScannedBytes(long bytes) Atomically decrement the number of remaining bytes by the given number of bytes.
ByteScanLimiter	reset() Create a new ByteScanLimiter with this limiter's original limit, ignoring any calls to hasBytesRemaining() and registerScannedBytes(long).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteScanLimiter

public ByteScanLimiter(long limit)

Method Detail

reset

@Nonnull
public ByteScanLimiter reset()

Create a new ByteScanLimiter with this limiter's original limit, ignoring any calls to hasBytesRemaining() and registerScannedBytes(long).

Returns:

a new ByteScanLimiter with this limiter's original limit

hasBytesRemaining

public boolean hasBytesRemaining()

Atomically check whether the number of remaining bytes is at least 0.

Returns:

true if the remaining count is at least 0 and false if it is less than 0

registerScannedBytes

public void registerScannedBytes(long bytes)

Atomically decrement the number of remaining bytes by the given number of bytes.

Parameters:

bytes - the number of bytes to register

getLimit

public long getLimit()

Get the byte scan limit. In particular, this will return the target number of bytes that this limiter is being used to enforce.

Returns:

the byte scan limit being enforced

toString

public String toString()

Overrides:

toString in class Object