Package org.apache.bookkeeper.bookie.storage.directentrylogger

Class DirectEntryLogger

java.lang.Object

org.apache.bookkeeper.bookie.storage.directentrylogger.DirectEntryLogger

All Implemented Interfaces:

AutoCloseable, EntryLogger

public class DirectEntryLogger
extends Object
implements EntryLogger

DirectEntryLogger.

Field Summary

Fields inherited from interface org.apache.bookkeeper.bookie.storage.EntryLogger

LOG_FILE_SUFFIX, UNASSIGNED_LEDGERID

Constructor Summary

Constructors

Constructor	Description
DirectEntryLogger(File ledgerDir, EntryLogIds ids, NativeIO nativeIO, io.netty.buffer.ByteBufAllocator allocator, ExecutorService writeExecutor, ExecutorService flushExecutor, long maxFileSize, int maxSaneEntrySize, long totalWriteBufferSize, long totalReadBufferSize, int readBufferSize, int numReadThreads, int maxFdCacheTimeSeconds, Slogger slogParent, StatsLogger stats)

Method Summary

Modifier and Type	Method	Description
long	addEntry(long ledgerId, io.netty.buffer.ByteBuf buf)	Add an entry for ledger ```ledgerId``` to the entrylog.
void	close()
void	flush()	Flush any outstanding writes to disk.
EntryLogMetadata	getEntryLogMetadata(long entryLogId, AbstractLogCompactor.Throttler throttler)	Retrieve metadata for the given entrylog ID.
Collection<Long>	getFlushedLogIds()	Get the log ids for the set of logs which have been completely flushed to disk.
Collection<CompactionEntryLog>	incompleteCompactionLogs()	Return a collection of all the compaction entry logs which have been compacted, but have not been cleaned up.
boolean	logExists(long logId)	Check whether an entrylog with the given ID exists.
static File	logFile(File directory, int logId)
static String	logFilename(File directory, int logId)
CompactionEntryLog	newCompactionLog(long srcLogId)	Create a new entrylog into which compacted entries can be added.
(package private) LogReader	newDirectReader(int logId)
io.netty.buffer.ByteBuf	readEntry(long entryLocation)	Read an entry from an entrylog location.
io.netty.buffer.ByteBuf	readEntry(long ledgerId, long entryId, long entryLocation)	Read an entry from an entrylog location, and verify that is matches the expected ledger and entry ID.
(package private) EntryLogMetadata	readEntryLogIndex(long logId)
boolean	removeEntryLog(long entryLogId)	Delete the entrylog with the given ID.
void	scanEntryLog(long entryLogId, EntryLogScanner scanner)	Scan the given entrylog, returning all entries contained therein.
(package private) EntryLogMetadata	scanEntryLogMetadata(long logId, AbstractLogCompactor.Throttler throttler)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.bookkeeper.bookie.storage.EntryLogger

getEntryLogMetadata

Constructor Details

DirectEntryLogger

public DirectEntryLogger(File ledgerDir,
 EntryLogIds ids,
 NativeIO nativeIO,
 io.netty.buffer.ByteBufAllocator allocator,
 ExecutorService writeExecutor,
 ExecutorService flushExecutor,
 long maxFileSize,
 int maxSaneEntrySize,
 long totalWriteBufferSize,
 long totalReadBufferSize,
 int readBufferSize,
 int numReadThreads,
 int maxFdCacheTimeSeconds,
 Slogger slogParent,
 StatsLogger stats)
                  throws IOException

Throws:

IOException

Method Details

addEntry

public long addEntry(long ledgerId,
 io.netty.buffer.ByteBuf buf)
              throws IOException

Description copied from interface: EntryLogger

Add an entry for ledger ```ledgerId``` to the entrylog.

Specified by:

addEntry in interface EntryLogger

Parameters:

ledgerId - the ledger for which the entry is being added

buf - the contents of the entry (this method does not take ownership of the refcount)

Returns:

the location in the entry log of the added entry

Throws:

IOException

readEntry

public io.netty.buffer.ByteBuf readEntry(long entryLocation)
                                  throws IOException,
Bookie.NoEntryException

Description copied from interface: EntryLogger

Read an entry from an entrylog location.

Specified by:

readEntry in interface EntryLogger

Parameters:

entryLocation - the location from which to read the entry

Returns:

the entry

Throws:

IOException

Bookie.NoEntryException

readEntry

public io.netty.buffer.ByteBuf readEntry(long ledgerId,
 long entryId,
 long entryLocation)
                                  throws IOException,
Bookie.NoEntryException

Description copied from interface: EntryLogger

Read an entry from an entrylog location, and verify that is matches the expected ledger and entry ID.

Specified by:

readEntry in interface EntryLogger

Parameters:

ledgerId - the ledgerID to match

entryId - the entryID to match

entryLocation - the location from which to read the entry

Returns:

the entry

Throws:

IOException

Bookie.NoEntryException

flush

public void flush()
           throws IOException

Description copied from interface: EntryLogger

Flush any outstanding writes to disk.

Specified by:

flush in interface EntryLogger

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EntryLogger

Throws:

IOException

getFlushedLogIds

public Collection<Long> getFlushedLogIds()

Description copied from interface: EntryLogger

Get the log ids for the set of logs which have been completely flushed to disk. Only log ids in this set are considered for either compaction or garbage collection.

Specified by:

getFlushedLogIds in interface EntryLogger

removeEntryLog

public boolean removeEntryLog(long entryLogId)

Description copied from interface: EntryLogger

Delete the entrylog with the given ID.

Specified by:

removeEntryLog in interface EntryLogger

Returns:

false if the entrylog doesn't exist.

scanEntryLog

public void scanEntryLog(long entryLogId,
 EntryLogScanner scanner)
                  throws IOException

Description copied from interface: EntryLogger

Scan the given entrylog, returning all entries contained therein.

Specified by:

scanEntryLog in interface EntryLogger

Throws:

IOException

logExists

public boolean logExists(long logId)

Description copied from interface: EntryLogger

Check whether an entrylog with the given ID exists.

Specified by:

logExists in interface EntryLogger

getEntryLogMetadata

public EntryLogMetadata getEntryLogMetadata(long entryLogId,
 AbstractLogCompactor.Throttler throttler)
                                     throws IOException

Description copied from interface: EntryLogger

Retrieve metadata for the given entrylog ID. The metadata contains the size of the log, the size of the data in the log which is still active, and a list of all the ledgers contained in the log and the size of the data stored for each ledger.

Specified by:

getEntryLogMetadata in interface EntryLogger

Throws:

IOException

readEntryLogIndex

EntryLogMetadata readEntryLogIndex(long logId)
                            throws IOException

Throws:

IOException

scanEntryLogMetadata

EntryLogMetadata scanEntryLogMetadata(long logId,
 AbstractLogCompactor.Throttler throttler)
                               throws IOException

Throws:

IOException

newDirectReader

LogReader newDirectReader(int logId)
                   throws IOException

Throws:

IOException

logFile

public static File logFile(File directory,
 int logId)

logFilename

public static String logFilename(File directory,
 int logId)

newCompactionLog

public CompactionEntryLog newCompactionLog(long srcLogId)
                                    throws IOException

Description copied from interface: EntryLogger

Create a new entrylog into which compacted entries can be added. There is a 1-1 mapping between logs that are being compacted and the log the compacted entries are written to.

Specified by:

newCompactionLog in interface EntryLogger

Throws:

IOException

incompleteCompactionLogs

public Collection<CompactionEntryLog> incompleteCompactionLogs()

Description copied from interface: EntryLogger

Return a collection of all the compaction entry logs which have been compacted, but have not been cleaned up.

Specified by:

incompleteCompactionLogs in interface EntryLogger