net.morimekta.providence.logging

Class QueuedMessageWriter

java.lang.Object

net.morimekta.providence.logging.QueuedMessageWriter

All Implemented Interfaces:

Closeable, AutoCloseable, MessageWriter

public class QueuedMessageWriter
extends Object
implements MessageWriter

A queued message writer that takes in messages onto a queue, and let a single thread handle all the writes to the contained writer. This writer is thread safe, and should be much faster than having multiple threads fight over the file IO.

Note that the writer will continue to accept messages after it has been closed.

Constructor Summary

Constructors

Constructor and Description
QueuedMessageWriter(MessageWriter writer) Create a queued message writer.
QueuedMessageWriter(MessageWriter writer, ExecutorService executor) Create a queued message writer using the given executor service.
QueuedMessageWriter(MessageWriter writer, ExecutorService executor, int maxQueueLength) Create a queued message writer using the given executor service.

Method Summary

Modifier and Type	Method and Description
void	close()
int	separator() Write an entry separator to the writer.
int	size()
protected void	sleep(long ms)
<Message extends net.morimekta.providence.PMessage<Message>> int	write(net.morimekta.providence.PMessageOrBuilder<Message> message) Write a providence message to the writer.
<Message extends net.morimekta.providence.PMessage<Message>> int	write(net.morimekta.providence.PServiceCall<Message> call) Write a providence service call to the writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueuedMessageWriter

public QueuedMessageWriter(MessageWriter writer)

Create a queued message writer.

Parameters:

writer - The message writer to write to.

QueuedMessageWriter

public QueuedMessageWriter(MessageWriter writer,
                           ExecutorService executor)

Create a queued message writer using the given executor service. Note that the executor service will be shut down with the message queue.

Parameters:

writer - The message writer to write to.

executor - The executor service running the write loop thread.

QueuedMessageWriter

public QueuedMessageWriter(MessageWriter writer,
                           ExecutorService executor,
                           int maxQueueLength)

Create a queued message writer using the given executor service. Note that the executor service will be shut down with the message queue.

Parameters:

writer - The message writer to write to.

executor - The executor service running the write loop thread.

maxQueueLength - The max queue length. If 0 or less, no limit is enforced. Default is 65536 (64k).

Method Detail

size

public int size()

Returns:

The current size of the in-memory queue.

write

public <Message extends net.morimekta.providence.PMessage<Message>> int write(net.morimekta.providence.PMessageOrBuilder<Message> message)
                                                                       throws IOException

Description copied from interface: MessageWriter

Write a providence message to the writer.

Specified by:

write in interface MessageWriter

Type Parameters:

Message - The message type.

Parameters:

message - The message to write.

Returns:

The number of bytes written.

Throws:

IOException - If write failed.

write

public <Message extends net.morimekta.providence.PMessage<Message>> int write(net.morimekta.providence.PServiceCall<Message> call)
                                                                       throws IOException

Description copied from interface: MessageWriter

Write a providence service call to the writer.

Specified by:

write in interface MessageWriter

Type Parameters:

Message - The message type embedded in the call.

Parameters:

call - The service call to write.

Returns:

The number of bytes written.

Throws:

IOException - If write failed.

separator

public int separator()

Description copied from interface: MessageWriter

Write an entry separator to the writer.

Specified by:

separator in interface MessageWriter

Returns:

The number of bytes written.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

sleep

protected void sleep(long ms)
              throws InterruptedException

Throws:

InterruptedException