org.elasticsearch.index.translog

Class TranslogSnapshot

java.lang.Object

org.elasticsearch.index.translog.BaseTranslogReader

org.elasticsearch.index.translog.TranslogSnapshot

All Implemented Interfaces:

java.lang.Comparable<BaseTranslogReader>, Translog.Snapshot

public class TranslogSnapshot
extends BaseTranslogReader
implements Translog.Snapshot

Field Summary

Fields

Modifier and Type	Field and Description
protected long	length

Fields inherited from class org.elasticsearch.index.translog.BaseTranslogReader

channel, firstOperationOffset, generation, path

Constructor Summary

Constructors

Constructor and Description
TranslogSnapshot(long generation, java.nio.channels.FileChannel channel, java.nio.file.Path path, long firstOperationOffset, long length, int totalOperations) Create a snapshot of translog file channel.

Method Summary

Modifier and Type	Method and Description
Translog.Operation	next() Returns the next operation in the snapshot or null if we reached the end.
protected void	readBytes(java.nio.ByteBuffer buffer, long position) reads an operation at the given position into the given buffer.
protected Translog.Operation	readOperation()
long	sizeInBytes()
java.lang.String	toString()
int	totalOperations() The total number of operations in the translog.

Methods inherited from class org.elasticsearch.index.translog.BaseTranslogReader

checksummedStream, compareTo, getFirstOperationOffset, getGeneration, newSnapshot, path, read, read, readSize

Methods inherited from class java.lang.Object

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

Field Detail

length

protected final long length

Constructor Detail

TranslogSnapshot

public TranslogSnapshot(long generation,
                        java.nio.channels.FileChannel channel,
                        java.nio.file.Path path,
                        long firstOperationOffset,
                        long length,
                        int totalOperations)

Create a snapshot of translog file channel. The length parameter should be consistent with totalOperations and point at the end of the last operation in this snapshot.

Method Detail

totalOperations

public final int totalOperations()

Description copied from interface: Translog.Snapshot

The total number of operations in the translog.

Specified by:

totalOperations in interface Translog.Snapshot

Specified by:

totalOperations in class BaseTranslogReader

next

public Translog.Operation next()
                        throws java.io.IOException

Description copied from interface: Translog.Snapshot

Returns the next operation in the snapshot or null if we reached the end.

Specified by:

next in interface Translog.Snapshot

Throws:

java.io.IOException

readOperation

protected final Translog.Operation readOperation()
                                          throws java.io.IOException

Throws:

java.io.IOException

sizeInBytes

public long sizeInBytes()

Specified by:

sizeInBytes in class BaseTranslogReader

readBytes

protected void readBytes(java.nio.ByteBuffer buffer,
                         long position)
                  throws java.io.IOException

reads an operation at the given position into the given buffer.

Specified by:

readBytes in class BaseTranslogReader

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class BaseTranslogReader