org.apache.lucene.index

Class MergeRateLimiter

java.lang.Object

org.apache.lucene.store.RateLimiter

org.apache.lucene.index.MergeRateLimiter

public class MergeRateLimiter
extends RateLimiter

This is the RateLimiter that IndexWriter assigns to each running merge, to give MergeSchedulers ionice like control. This is similar to RateLimiter.SimpleRateLimiter, except it's merge-private, it will wake up if its rate changes while it's paused, it tracks how much time it spent stopped and paused, and it supports aborting.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.store.RateLimiter

RateLimiter.SimpleRateLimiter

Constructor Summary

Constructors

Constructor and Description
MergeRateLimiter(MergePolicy.OneMerge merge) Sole constructor.

Method Summary

Modifier and Type	Method and Description
void	checkAbort() Throws MergePolicy.MergeAbortedException if this merge was aborted.
boolean	getAbort() Returns true if this merge was aborted.
double	getMBPerSec() The current MB per second rate limit.
long	getMinPauseCheckBytes() How many bytes caller should add up itself before invoking RateLimiter.pause(long).
long	getTotalBytesWritten() Returns total bytes written by this merge.
long	getTotalPausedNS() Total NS merge was paused to rate limit IO.
long	getTotalStoppedNS() Total NS merge was stopped.
long	pause(long bytes) Pauses, if necessary, to keep the instantaneous IO rate at or below the target.
void	setAbort() Mark this merge aborted.
void	setMBPerSec(double mbPerSec) Sets an updated MB per second rate limit.

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeRateLimiter

public MergeRateLimiter(MergePolicy.OneMerge merge)

Sole constructor.

Method Detail

setMBPerSec

public void setMBPerSec(double mbPerSec)

Description copied from class: RateLimiter

Sets an updated MB per second rate limit.

Specified by:

setMBPerSec in class RateLimiter

getMBPerSec

public double getMBPerSec()

Description copied from class: RateLimiter

The current MB per second rate limit.

Specified by:

getMBPerSec in class RateLimiter

getTotalBytesWritten

public long getTotalBytesWritten()

Returns total bytes written by this merge.

pause

public long pause(long bytes)
           throws MergePolicy.MergeAbortedException

Description copied from class: RateLimiter

Pauses, if necessary, to keep the instantaneous IO rate at or below the target.

Note: the implementation is thread-safe

Specified by:

pause in class RateLimiter

Returns:

the pause time in nano seconds

Throws:

MergePolicy.MergeAbortedException

getTotalStoppedNS

public long getTotalStoppedNS()

Total NS merge was stopped.

getTotalPausedNS

public long getTotalPausedNS()

Total NS merge was paused to rate limit IO.

checkAbort

public void checkAbort()
                throws MergePolicy.MergeAbortedException

Throws MergePolicy.MergeAbortedException if this merge was aborted.

Throws:

MergePolicy.MergeAbortedException

setAbort

public void setAbort()

Mark this merge aborted.

getAbort

public boolean getAbort()

Returns true if this merge was aborted.

getMinPauseCheckBytes

public long getMinPauseCheckBytes()

Description copied from class: RateLimiter

How many bytes caller should add up itself before invoking RateLimiter.pause(long).

Specified by:

getMinPauseCheckBytes in class RateLimiter