com.neeve.rog.log

Class RogMessageLog

java.lang.Object

com.neeve.root.RootObject

com.neeve.rog.RogObject

com.neeve.rog.log.RogMessageLog

All Implemented Interfaces:

IRogMessageLogger

public final class RogMessageLog
extends RogObject
implements IRogMessageLogger

The ROG message log

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.rog.IRogMessageLogger

IRogMessageLogger.ErrorHandler, IRogMessageLogger.IMessageReceiver, IRogMessageLogger.Stats

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_AUTO_REPAIR
static String	PROP_DETACHED
static String	PROP_DETACHED_QUEUE_DEPTH
static String	PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK
static String	PROP_DETACHED_QUEUE_OFFER_STRATEGY
static String	PROP_DETACHED_QUEUE_WAIT_STRATEGY
static String	PROP_FLUSH_ON_COMMIT
static String	PROP_FLUSH_USING_MAPPED_MEMORY
static String	PROP_INITIAL_LOG_LENGTH
static String	PROP_INTEGRITY_CHECK
static String	PROP_LOG_EMPTINESS_EXPECTATION
static String	PROP_LOG_LOCATION
static String	PROP_LOG_MODE
static String	PROP_LOG_PRESENCE_EXPECTATION
static String	PROP_PAGE_SIZE
static String	PROP_READ_BUFFER_SIZE
static String	PROP_WRITE_BUFFER_SIZE
static String	PROP_ZERO_OUT_INITIAL

Method Summary

Modifier and Type	Method and Description
void	close() Implementation IRogMessageLogger.close()
static RogMessageLog	create(String name) Create a new log.
static RogMessageLog	create(String name, Properties props) Create a new message log
void	delete() Implementation of IRogMessageLogger.delete()
void	fail(Exception cause) Force fail the log.
void	flush(boolean sync) Implementation of IRogMessageLogger.flush(boolean)
IRogMessageLogger.ErrorHandler	getErrorHandler() Implementation of IRogMessageLogger.getErrorHandler()
String	getName() Implementation of IRogMessageLogger.getName()
long	getPositionInLog(IRogMessage message) Implementation of IRogMessageLogger.getPositionInLog(IRogMessage)
int	getSizeInLog(IRogMessage message) Implementation of IRogMessageLogger.getSizeInLog(IRogMessage)
IRogMessageLogger.Stats	getStats() Implementation of IRogMessageLogger.getStats()
boolean	isOpen() Implementation of IRogMessageLogger.isOpen()
boolean	isReadInProgress() Implementation of IRogMessageLogger.isReadInProgress()
void	log(IRogMessage message) Implementation of IRogMessageLogger.log(IRogMessage)
void	log(IRogMessage message, boolean commitStart, boolean commitEnd) Implementation of IRogMessageLogger.log(IRogMessage, boolean, boolean)
void	log(IRogMessage message, boolean commitStart, boolean commitEnd, boolean sync) Implementation of IRogMessageLogger.log(IRogMessage, boolean, boolean, boolean)
void	open() Implementation of IRogMessageLogger.open()
void	read(IRogMessageLogger.IMessageReceiver receiver) Implementation of IRogMessageLogger.read(IMessageReceiver)
IRogMessage	readAt(long pos) Implementation of IRogMessageLogger.readAt(long)
void	readFrom(long pos, IRogMessageLogger.IMessageReceiver receiver) Implementation of IRogMessageLogger.readFrom(long, IMessageReceiver)
IRogMessage	readOne() Implementation of IRogMessageLogger.readOne()
void	setErrorHandler(IRogMessageLogger.ErrorHandler errorHandler) Implementation of IRogMessageLogger.setErrorHandler(com.neeve.rog.IRogMessageLogger.ErrorHandler)
void	stopRead() Implementation of IRogMessageLogger.stopRead()
boolean	wasRepaired() Implementation of IRogMessageLogger.wasRepaired()

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer

Methods inherited from class java.lang.Object

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

Field Detail

PROP_LOG_LOCATION

public static final String PROP_LOG_LOCATION

See Also:

RogLog.PROP_STORE_ROOT, Constant Field Values

PROP_LOG_MODE

public static final String PROP_LOG_MODE

See Also:

RogLog.PROP_LOG_MODE, Constant Field Values

PROP_LOG_PRESENCE_EXPECTATION

public static final String PROP_LOG_PRESENCE_EXPECTATION

See Also:

RogLog.PROP_LOG_PRESENCE_EXPECTATION, Constant Field Values

PROP_LOG_EMPTINESS_EXPECTATION

public static final String PROP_LOG_EMPTINESS_EXPECTATION

See Also:

RogLog.PROP_LOG_EMPTINESS_EXPECTATION, Constant Field Values

PROP_INTEGRITY_CHECK

public static final String PROP_INTEGRITY_CHECK

See Also:

RogLog.PROP_INTEGRITY_CHECK, Constant Field Values

PROP_AUTO_REPAIR

public static final String PROP_AUTO_REPAIR

See Also:

RogLog.PROP_AUTO_REPAIR, Constant Field Values

PROP_INITIAL_LOG_LENGTH

public static final String PROP_INITIAL_LOG_LENGTH

See Also:

RogLog.PROP_INITIAL_LOG_LENGTH, Constant Field Values

PROP_ZERO_OUT_INITIAL

public static final String PROP_ZERO_OUT_INITIAL

See Also:

RogLog.PROP_ZERO_OUT_INITIAL, Constant Field Values

PROP_READ_BUFFER_SIZE

public static final String PROP_READ_BUFFER_SIZE

See Also:

RogLog.PROP_READ_BUFFER_SIZE, Constant Field Values

PROP_WRITE_BUFFER_SIZE

public static final String PROP_WRITE_BUFFER_SIZE

See Also:

RogLog.PROP_WRITE_BUFFER_SIZE, Constant Field Values

PROP_PAGE_SIZE

public static final String PROP_PAGE_SIZE

See Also:

RogLog.PROP_PAGE_SIZE, Constant Field Values

PROP_FLUSH_ON_COMMIT

public static final String PROP_FLUSH_ON_COMMIT

See Also:

RogLog.PROP_FLUSH_ON_COMMIT, Constant Field Values

PROP_FLUSH_USING_MAPPED_MEMORY

public static final String PROP_FLUSH_USING_MAPPED_MEMORY

See Also:

RogLog.PROP_FLUSH_USING_MAPPED_MEMORY, Constant Field Values

PROP_DETACHED

public static final String PROP_DETACHED

See Also:

RogLog.PROP_DETACHED, Constant Field Values

PROP_DETACHED_QUEUE_DEPTH

public static final String PROP_DETACHED_QUEUE_DEPTH

See Also:

RogLog.PROP_DETACHED_QUEUE_DEPTH, Constant Field Values

PROP_DETACHED_QUEUE_OFFER_STRATEGY

public static final String PROP_DETACHED_QUEUE_OFFER_STRATEGY

See Also:

RogLog.PROP_DETACHED_QUEUE_OFFER_STRATEGY, Constant Field Values

PROP_DETACHED_QUEUE_WAIT_STRATEGY

public static final String PROP_DETACHED_QUEUE_WAIT_STRATEGY

See Also:

RogLog.PROP_DETACHED_QUEUE_WAIT_STRATEGY, Constant Field Values

PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK

public static final String PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK

See Also:

RogLog.PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK, Constant Field Values

Method Detail

create

public static final RogMessageLog create(String name,
                                         Properties props)

Create a new message log

Parameters:

name - The name of the log

props - Properties to configure the log.

create

public static final RogMessageLog create(String name)

Create a new log.

This method calls create(name, (Properties)null)

getName

public final String getName()

Implementation of IRogMessageLogger.getName()

Specified by:

getName in interface IRogMessageLogger

setErrorHandler

public final void setErrorHandler(IRogMessageLogger.ErrorHandler errorHandler)

Implementation of IRogMessageLogger.setErrorHandler(com.neeve.rog.IRogMessageLogger.ErrorHandler)

Specified by:

setErrorHandler in interface IRogMessageLogger

getErrorHandler

public final IRogMessageLogger.ErrorHandler getErrorHandler()

Implementation of IRogMessageLogger.getErrorHandler()

Specified by:

getErrorHandler in interface IRogMessageLogger

open

public final void open()
                throws Exception

Implementation of IRogMessageLogger.open()

Specified by:

open in interface IRogMessageLogger

Throws:

Exception

isOpen

public final boolean isOpen()

Implementation of IRogMessageLogger.isOpen()

Specified by:

isOpen in interface IRogMessageLogger

wasRepaired

public final boolean wasRepaired()

Implementation of IRogMessageLogger.wasRepaired()

Specified by:

wasRepaired in interface IRogMessageLogger

getStats

public final IRogMessageLogger.Stats getStats()

Implementation of IRogMessageLogger.getStats()

Specified by:

getStats in interface IRogMessageLogger

isReadInProgress

public final boolean isReadInProgress()

Implementation of IRogMessageLogger.isReadInProgress()

Specified by:

isReadInProgress in interface IRogMessageLogger

readAt

public final IRogMessage readAt(long pos)

Implementation of IRogMessageLogger.readAt(long)

Specified by:

readAt in interface IRogMessageLogger

Parameters:

pos - The position in the log the message from

Returns:

The read message

readOne

public final IRogMessage readOne()

Implementation of IRogMessageLogger.readOne()

Specified by:

readOne in interface IRogMessageLogger

Returns:

The read message

readFrom

public final void readFrom(long pos,
                           IRogMessageLogger.IMessageReceiver receiver)

Implementation of IRogMessageLogger.readFrom(long, IMessageReceiver)

Specified by:

readFrom in interface IRogMessageLogger

Parameters:

pos - The position in the log to read from. A value of 0 will read the message from the beginning of the file.

read

public final void read(IRogMessageLogger.IMessageReceiver receiver)

Implementation of IRogMessageLogger.read(IMessageReceiver)

Specified by:

read in interface IRogMessageLogger

stopRead

public final void stopRead()

Implementation of IRogMessageLogger.stopRead()

Specified by:

stopRead in interface IRogMessageLogger

getPositionInLog

public final long getPositionInLog(IRogMessage message)

Implementation of IRogMessageLogger.getPositionInLog(IRogMessage)

Specified by:

getPositionInLog in interface IRogMessageLogger

getSizeInLog

public final int getSizeInLog(IRogMessage message)

Implementation of IRogMessageLogger.getSizeInLog(IRogMessage)

Specified by:

getSizeInLog in interface IRogMessageLogger

log

public final void log(IRogMessage message,
                      boolean commitStart,
                      boolean commitEnd,
                      boolean sync)

Implementation of IRogMessageLogger.log(IRogMessage, boolean, boolean, boolean)

Specified by:

log in interface IRogMessageLogger

Parameters:

message - The message to log.

commitStart - Indicates whether to mark this log entry as the start of an application commit leg.

commitEnd - Indicates whether to mark this log entry as the end of an application commit leg.

sync - Indicates whether this write should trigger a flush with a sync i.e. any data buffered in local memory by prior calls to this method should be synchornously flushed through to its destination i.e. cut through all intermediate caches and buffers such as OS caches, CPU caches and network buffers to it final destination.

log

public final void log(IRogMessage message,
                      boolean commitStart,
                      boolean commitEnd)

Implementation of IRogMessageLogger.log(IRogMessage, boolean, boolean)

Specified by:

log in interface IRogMessageLogger

log

public final void log(IRogMessage message)

Implementation of IRogMessageLogger.log(IRogMessage)

Specified by:

log in interface IRogMessageLogger

flush

public final void flush(boolean sync)

Implementation of IRogMessageLogger.flush(boolean)

Specified by:

flush in interface IRogMessageLogger

Parameters:

sync - Indicates if the flush should sync to the durable media

fail

public final void fail(Exception cause)

Force fail the log.

Parameters:

cause - The cause of the failure.

CAUTION: This method is only for testing purposes and should not be invoked outside of test frameworks.

This method invokes the error handler if installed and marks the log has failed. This will cause all subsequent commits or syncs to immediately fail with a runtime exception.

delete

public final void delete()
                  throws IOException

Implementation of IRogMessageLogger.delete()

Specified by:

delete in interface IRogMessageLogger

Throws:

IOException

close

public final void close()

Implementation IRogMessageLogger.close()

Specified by:

close in interface IRogMessageLogger