io.atomix.storage.journal

Interface JournalWriter<E>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DelegatingJournalWriter, JournalSegmentWriter, SegmentedJournalWriter

public interface JournalWriter<E>
extends AutoCloseable

Log writer.

Author:

Method Summary

Modifier and Type	Method and Description
void	append(Indexed<E> entry) Appends an indexed entry to the log.
<T extends E> Indexed<T>	append(T entry) Appends an entry to the journal.
void	close()
void	flush() Flushes written entries to disk.
Indexed<E>	getLastEntry() Returns the last entry written.
long	getLastIndex() Returns the last written index.
long	getNextIndex() Returns the next index to be written.
void	truncate(long index) Truncates the log to the given index.

Method Detail

getLastIndex

long getLastIndex()

Returns the last written index.

Returns:

The last written index.

getLastEntry

Indexed<E> getLastEntry()

Returns the last entry written.

Returns:

The last entry written.

getNextIndex

long getNextIndex()

Returns the next index to be written.

Returns:

The next index to be written.

append

<T extends E> Indexed<T> append(T entry)

Appends an entry to the journal.

Parameters:

entry - The entry to append.

Returns:

The appended indexed entry.

append

void append(Indexed<E> entry)

Appends an indexed entry to the log.

Parameters:

entry - The indexed entry to append.

truncate

void truncate(long index)

Truncates the log to the given index.

Parameters:

index - The index to which to truncate the log.

flush

void flush()

Flushes written entries to disk.

close

void close()

Specified by:

close in interface AutoCloseable