Package org.apache.lucene.store

Class RateLimitedIndexOutput

java.lang.Object

org.apache.lucene.store.DataOutput

org.apache.lucene.store.IndexOutput

org.apache.lucene.store.RateLimitedIndexOutput

All Implemented Interfaces:

Closeable, AutoCloseable

public final class RateLimitedIndexOutput
extends IndexOutput

A rate limiting IndexOutput

Field Summary

Fields

Modifier and Type	Field	Description
private long	bytesSinceLastPause	How many bytes we've written since we last called rateLimiter.pause.
private long	currentMinPauseCheckBytes	Cached here not not always have to call RateLimiter#getMinPauseCheckBytes() which does volatile read.
private final IndexOutput	delegate
private final RateLimiter	rateLimiter

Constructor Summary

Constructors

Constructor	Description
RateLimitedIndexOutput(RateLimiter rateLimiter, IndexOutput delegate)

Method Summary

Modifier and Type	Method	Description
private void	checkRate()
void	close()	Closes this stream to further operations.
long	getChecksum()	Returns the current checksum of bytes written so far
long	getFilePointer()	Returns the current position in this file, where the next write will occur.
void	writeByte(byte b)	Writes a single byte.
void	writeBytes(byte[] b, int offset, int length)	Writes an array of bytes.

Methods inherited from class org.apache.lucene.store.IndexOutput

getName, toString

Methods inherited from class org.apache.lucene.store.DataOutput

copyBytes, writeBytes, writeInt, writeLong, writeMapOfStrings, writeSetOfStrings, writeShort, writeString, writeVInt, writeVLong, writeZInt, writeZLong

Methods inherited from class java.lang.Object

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

Field Details

delegate

private final IndexOutput delegate

rateLimiter

private final RateLimiter rateLimiter

bytesSinceLastPause

private long bytesSinceLastPause

How many bytes we've written since we last called rateLimiter.pause.

currentMinPauseCheckBytes

private long currentMinPauseCheckBytes

Cached here not not always have to call RateLimiter#getMinPauseCheckBytes() which does volatile read.

Constructor Details

RateLimitedIndexOutput

public RateLimitedIndexOutput(RateLimiter rateLimiter,
 IndexOutput delegate)

Method Details

close

public void close()
           throws IOException

Description copied from class: IndexOutput

Closes this stream to further operations.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class IndexOutput

Throws:

IOException

getFilePointer

public long getFilePointer()

Description copied from class: IndexOutput

Returns the current position in this file, where the next write will occur.

Specified by:

getFilePointer in class IndexOutput

getChecksum

public long getChecksum()
                 throws IOException

Description copied from class: IndexOutput

Returns the current checksum of bytes written so far

Specified by:

getChecksum in class IndexOutput

Throws:

IOException

writeByte

public void writeByte(byte b)
               throws IOException

Description copied from class: DataOutput

Writes a single byte.

The most primitive data type is an eight-bit byte. Files are accessed as sequences of bytes. All other data types are defined as sequences of bytes, so file formats are byte-order independent.

Specified by:

writeByte in class DataOutput

Throws:

IOException

See Also:

• DataInput.readByte()

writeBytes

public void writeBytes(byte[] b,
 int offset,
 int length)
                throws IOException

Description copied from class: DataOutput

Writes an array of bytes.

Specified by:

writeBytes in class DataOutput

Parameters:

b - the bytes to write

offset - the offset in the byte array

length - the number of bytes to write

Throws:

IOException

See Also:

• DataInput.readBytes(byte[],int,int)

checkRate

private void checkRate()
                throws IOException

Throws:

IOException