com.kdgregory.log4j.aws.internal.shared

Interface LogWriter

All Superinterfaces:

Runnable

All Known Implementing Classes:

AbstractLogWriter, CloudWatchLogWriter, KinesisLogWriter, SNSLogWriter

public interface LogWriter
extends Runnable

Defines the contract between appenders and writers.

Writers run on a background thread, building batches of messages and attempting to send them to the destination.

Method Summary

Modifier and Type	Method and Description
void	addMessage(LogMessage message) Adds a message to the writer waiting for batch.
void	setBatchDelay(long value) Sets the batch delay for the writer.
void	setDiscardAction(MessageQueue.DiscardAction value) Updates the writer's discard action: how it discards messages once the threshold has been reached.
void	setDiscardThreshold(int value) Updates the writer's discard threshold: the maximum number of message stored in its queue.
void	stop() Signals the writer that it will no longer receive batches.

Methods inherited from interface java.lang.Runnable

run

Method Detail

addMessage

void addMessage(LogMessage message)

Adds a message to the writer waiting for batch.

Implementations should assume that they are invoked within a synchronized block, and therefore should not perform excessive amounts of work.

stop

void stop()

Signals the writer that it will no longer receive batches. It should, however, make a best effort to send any batches that it already has before exiting its run() method.

setBatchDelay

void setBatchDelay(long value)

Sets the batch delay for the writer. The appender is assumed to expose a delay parameter, and this method allows it to change the writer's delay at runtime. Changes may or may not take place immediately.

If the writer doesn't support batching, this will be a no-op.

setDiscardThreshold

void setDiscardThreshold(int value)

Updates the writer's discard threshold: the maximum number of message stored in its queue.

setDiscardAction

void setDiscardAction(MessageQueue.DiscardAction value)

Updates the writer's discard action: how it discards messages once the threshold has been reached.