com.neeve.rog

Interface IRogMessageLogger

All Known Implementing Classes:

RogLog

public interface IRogMessageLogger

Represents a message logger.

This interface defines a message logger. Message loggers are used to persist messages to a log.

Threading:

A logger is not safe for concurrent access by multiple threads.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close a message logger.
void	flush(boolean sync) Flush cached message to the log.
String	getName() Get the name of a logger.
void	log(IRogMessage message) Log a message.
void	log(IRogMessage message, boolean commitEnd) Log a message.
void	open() Open a message logger.

Method Detail

getName

String getName()

Get the name of a logger.

open

void open()
          throws Exception

Open a message logger.

Throws:

Exception

log

void log(IRogMessage message,
       boolean commitEnd)

Log a message.

Parameters:

message - The message to log.

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

Threading:

This method is not safe for concurrent access with itself or any other methods in this class

Note: The logger can be configured to log a message is a detached manner i.e. upon return from this call, the message may still be in flight for logging. Therefore, a message being logged CANNOT be modified after return from this call.

log

void log(IRogMessage message)

Log a message.

Parameters:

message - The message to log.

Threading:

This method is not safe for concurrent access with itself or any other methods in this class

Invoking this method is equivalent to invoking log(message, false)

flush

void flush(boolean sync)

Flush cached message to the log.

Parameters:

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

Threading:

This method is not safe for concurrent access with itself or any other methods in this class

close

void close()

Close a message logger.