alluxio.master.journal.raft

Class RaftJournalWriter

java.lang.Object

alluxio.master.journal.raft.RaftJournalWriter

All Implemented Interfaces:

JournalWriter, Closeable, AutoCloseable

@NotThreadSafe
public class RaftJournalWriter
extends Object
implements JournalWriter

Class for writing entries to the Raft journal. Written entries are aggregated until flush is called, then they are submitted as a single unit.

Constructor Summary

Constructors

Constructor and Description
RaftJournalWriter(long nextSequenceNumberToWrite, LocalFirstRaftClient client)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush() Flushes all the entries written to the underlying storage.
long	getNextSequenceNumberToWrite()
void	write(Journal.JournalEntry entry) Writes an entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

RaftJournalWriter

public RaftJournalWriter(long nextSequenceNumberToWrite,
                         LocalFirstRaftClient client)

Parameters:

nextSequenceNumberToWrite - the sequence number for the writer to begin writing at

client - client for writing entries to the journal; the constructed journal writer owns this client and is responsible for closing it

Method Detail

write

public void write(Journal.JournalEntry entry)
           throws IOException,
                  JournalClosedException

Description copied from interface: JournalWriter

Writes an entry. JournalWriter.flush() should be called afterwards if we want to make sure the entry is persisted.

Specified by:

write in interface JournalWriter

Parameters:

entry - the journal entry to write

Throws:

IOException

JournalClosedException

flush

public void flush()
           throws IOException,
                  JournalClosedException

Description copied from interface: JournalWriter

Flushes all the entries written to the underlying storage.

Specified by:

flush in interface JournalWriter

Throws:

IOException

JournalClosedException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getNextSequenceNumberToWrite

public long getNextSequenceNumberToWrite()

Returns:

the next sequence number that will be written by this writer