net.morimekta.providence.mio

Interface MessageWriter

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

FileMessageWriter, IOMessageWriter, QueuedMessageWriter, RollingFileMessageWriter

public interface MessageWriter
extends Closeable

An interface for writing messages and service calls.

Method Summary

Modifier and Type	Method and Description
int	separator() Write an entry separator to the writer.
<Message extends PMessage<Message,Field>,Field extends PField> int	write(Message message) Write a providence message to the writer.
<Message extends PMessage<Message,Field>,Field extends PField> int	write(PServiceCall<Message,Field> call) Write a providence service call to the writer.

Methods inherited from interface java.io.Closeable

close

Method Detail

write

<Message extends PMessage<Message,Field>,Field extends PField> int write(Message message)
                                                                  throws IOException

Write a providence message to the writer.

Type Parameters:

Message - The message type.

Field - The field type.

Parameters:

message - The message to write.

Returns:

The number of bytes written.

Throws:

IOException - If write failed.

write

<Message extends PMessage<Message,Field>,Field extends PField> int write(PServiceCall<Message,Field> call)
                                                                  throws IOException

Write a providence service call to the writer.

Type Parameters:

Message - The message type embedded in the call.

Field - The field type embedded in the call.

Parameters:

call - The service call to write.

Returns:

The number of bytes written.

Throws:

IOException - If write failed.

separator

int separator()
       throws IOException

Write an entry separator to the writer.

Returns:

The number of bytes written.

Throws:

IOException - If write failed.