org.elasticsearch.index.translog.fs

Class FsChannelSnapshot

java.lang.Object

org.elasticsearch.index.translog.fs.FsChannelSnapshot

All Implemented Interfaces:

AutoCloseable, Releasable, Translog.Snapshot

public class FsChannelSnapshot
extends Object
implements Translog.Snapshot

Constructor Summary

Constructors

Constructor and Description
FsChannelSnapshot(long id, RafReference raf, long length, int totalOperations) Create a snapshot of translog file channel.

Method Summary

Modifier and Type	Method and Description
void	close()
int	estimatedTotalOperations() The total number of operations in the translog.
long	length() Returns the internal length (*not* number of operations) of this snapshot.
long	lengthInBytes() The length in bytes of this stream.
Translog.Operation	next() Returns the next operation, or null when no more operations are found
long	position() Returns the current position in the translog stream
void	seekTo(long position) Seek to the specified position in the translog stream
long	translogId() The id of the translog the snapshot was taken with.

Methods inherited from class java.lang.Object

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

Constructor Detail

FsChannelSnapshot

public FsChannelSnapshot(long id,
                         RafReference raf,
                         long length,
                         int totalOperations)
                  throws FileNotFoundException

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.

Throws:

FileNotFoundException

Method Detail

translogId

public long translogId()

Description copied from interface: Translog.Snapshot

The id of the translog the snapshot was taken with.

Specified by:

translogId in interface Translog.Snapshot

position

public long position()

Description copied from interface: Translog.Snapshot

Returns the current position in the translog stream

Specified by:

position in interface Translog.Snapshot

length

public long length()

Description copied from interface: Translog.Snapshot

Returns the internal length (*not* number of operations) of this snapshot.

Specified by:

length in interface Translog.Snapshot

estimatedTotalOperations

public int estimatedTotalOperations()

Description copied from interface: Translog.Snapshot

The total number of operations in the translog.

Specified by:

estimatedTotalOperations in interface Translog.Snapshot

lengthInBytes

public long lengthInBytes()

Description copied from interface: Translog.Snapshot

The length in bytes of this stream.

Specified by:

lengthInBytes in interface Translog.Snapshot

next

public Translog.Operation next()

Description copied from interface: Translog.Snapshot

Returns the next operation, or null when no more operations are found

Specified by:

next in interface Translog.Snapshot

seekTo

public void seekTo(long position)

Description copied from interface: Translog.Snapshot

Seek to the specified position in the translog stream

Specified by:

seekTo in interface Translog.Snapshot

close

public void close()
           throws ElasticsearchException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Releasable

Throws:

ElasticsearchException