Constructor Detail

• Log

  Log(LogConfig config)

Method Detail

• getCreated

   final Long getCreated()

• getIsClosing

   final Boolean getIsClosing()

• setIsClosing

   final Unit setIsClosing(Boolean isClosing)

• getIdentity

   final Integer getIdentity()

• setIdentity

   final Unit setIdentity(Integer identity)

• getTip

   final LogTip getTip()

• getCachePageSize

   final Integer getCachePageSize()

  Size of single page in log cache.

• getFileLengthBound

   final Long getFileLengthBound()

  Size of a single file of the log in bytes.

• getLocation

   final String getLocation()

• getNumberOfFiles

   final Long getNumberOfFiles()

• getAllFileAddresses

   final LongArray getAllFileAddresses()

• getHighAddress

   final Long getHighAddress()

• getWrittenHighAddress

   final Long getWrittenHighAddress()

• getLowAddress

   final Long getLowAddress()

• getHighFileAddress

   final Long getHighFileAddress()

• getDiskUsage

   final Long getDiskUsage()

• getCacheHitRate

   final Float getCacheHitRate()

• getConfig

   final LogConfig getConfig()

• setHighAddress

   final LogTip setHighAddress(LogTip logTip, Long highAddress)

• setHighAddress

   final LogTip setHighAddress(LogTip logTip, Long highAddress, BlockSet.Mutable blockSet)

• beginWrite

   final LogTip beginWrite()

• abortWrite

   final Unit abortWrite()

• revertWrite

   final Unit revertWrite(LogTip logTip)

• endWrite

   final LogTip endWrite()

• compareAndSetTip

   final LogTip compareAndSetTip(LogTip logTip, LogTip updatedTip)

• getFileAddress

   final Long getFileAddress(Long address)

• getNextFileAddress

   final Long getNextFileAddress(Long fileAddress)

• isLastFileAddress

   final Boolean isLastFileAddress(Long address, LogTip logTip)

• isLastWrittenFileAddress

   final Boolean isLastWrittenFileAddress(Long address)

• hasAddress

   final Boolean hasAddress(Long address)

• hasAddressRange

   final Boolean hasAddressRange(Long from, Long to)

• getFileSize

  @JvmOverloads() final Long getFileSize(Long fileAddress, LogTip logTip)

• getFileSize

  @JvmOverloads() final Long getFileSize(Long fileAddress)

• getHighPage

   final ByteArray getHighPage(Long alignedAddress)

• getCachedPage

   final ByteArray getCachedPage(Long pageAddress)

• addBlockListener

   final Unit addBlockListener(BlockListener listener)

• addReadBytesListener

   final Unit addReadBytesListener(ReadBytesListener listener)

• read

   final RandomAccessLoggable read(Long address)

  Reads a random access loggable by specified address in the log.

  Parameters:

  address -

  • location of a loggable in the log.

• read

  @JvmOverloads() final RandomAccessLoggable read(ByteIteratorWithAddress it, Long address)

• read

  @JvmOverloads() final RandomAccessLoggable read(ByteIteratorWithAddress it)

• getWrittenLoggableType

   final Byte getWrittenLoggableType(Long address, Byte max)

• readNotNull

   final RandomAccessLoggable readNotNull(ByteIteratorWithAddress it, Long address)

  Just like .read reads loggable which never can be a NullLoggable.

• getLoggableIterator

   final LoggableIterator getLoggableIterator(Long startAddress)

• tryWrite

   final Long tryWrite(Byte type, Integer structureId, ByteIterable data)

• write

   final Long write(Loggable loggable)

  Writes a loggable to the end of the log padding the log with nulls if necessary. So auto-alignment guarantees the loggable to be placed in a single file.

  Parameters:

  loggable -

  • loggable to write.

• write

   final Long write(Byte type, Integer structureId, ByteIterable data)

• getFirstLoggableOfType

   final Loggable getFirstLoggableOfType(Integer type)

  Returns the first loggable in the log of specified type.

  Parameters:

  type - type of loggable.

• getLastLoggableOfType

   final Loggable getLastLoggableOfType(Integer type)

  Returns the last loggable in the log of specified type.

  Parameters:

  type - type of loggable.

• getLastLoggableOfTypeBefore

   final Loggable getLastLoggableOfTypeBefore(Integer type, Long beforeAddress, LogTip logTip)

  Returns the last loggable in the log of specified type which address is less than beforeAddress.

  Parameters:

  type - type of loggable.

• isImmutableFile

   final Boolean isImmutableFile(Long fileAddress)

• flush

  @JvmOverloads() final Unit flush(Boolean forceSync)

• flush

  @JvmOverloads() final Unit flush()

• sync

   final Unit sync()

• close

   Unit close()

• release

   final Unit release()

• clear

   final LogTip clear()

• forgetFile

  @Deprecated(message = for tests only) final Unit forgetFile(Long address)

• forgetFiles

   final Unit forgetFiles(LongArray files)

• removeFile

  @JvmOverloads() final Unit removeFile(Long address, RemoveBlockType rbt, BlockSet.Mutable blockSetMutable)

• removeFile

  @JvmOverloads() final Unit removeFile(Long address, RemoveBlockType rbt)

• removeFile

  @JvmOverloads() final Unit removeFile(Long address)

• ensureWriter

   final BufferedDataWriter ensureWriter()

• clearFileFromLogCache

   final Unit clearFileFromLogCache(Long address, Long offset)

• padWithNulls

   final Unit padWithNulls()

  Pad current file with null loggables. Null loggable takes only one byte in the log, so each file of the log with arbitrary alignment can be padded with nulls. Padding with nulls is automatically performed when a loggable to be written can't be placed within the appendable file without overcome of the value of fileLengthBound. This feature allows to guarantee that each file starts with a new loggable, no loggable can begin in one file and end in another. Also, this simplifies reading algorithm: if we started reading by address it definitely should finish within current file.

• doPadWithNulls

   final Unit doPadWithNulls()

• readBytes

   final Integer readBytes(ByteArray output, Long address)

• readIteratorFrom

   final DataIterator readIteratorFrom(Long address)

  Returns iterator which reads raw bytes of the log starting from specified address.

• getHighPageAddress

   final Long getHighPageAddress(Long highAddress)

• writeContinuously

   final Long writeContinuously(Loggable loggable)

  Writes specified loggable continuously in a single file.

  Parameters:

  loggable - the loggable to write.

• writeContinuously

   final Long writeContinuously(Byte type, Integer structureId, ByteIterable data)

• writeContinuously

   final Long writeContinuously(ByteArray data, Integer count)

• setLogTestConfig

  @Deprecated(message = for tests only) final Unit setLogTestConfig(LogTestConfig testConfig)

  Sets LogTestConfig. Is destined for tests only, please don't set a not-null value in application code.