org.msgpack.core.buffer

Interface MessageBufferOutput

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, java.io.Flushable

All Known Implementing Classes:

ArrayBufferOutput, ChannelBufferOutput, OutputStreamBufferOutput

public interface MessageBufferOutput
extends java.io.Closeable, java.io.Flushable

Provides a buffered output stream for packing objects

Method Summary

Modifier and Type	Method and Description
void	add(byte[] buffer, int offset, int length) Writes an external payload data.
MessageBuffer	next(int minimumSize) Allocates the next buffer for writing message packed data.
void	write(byte[] buffer, int offset, int length) Writes an external payload data.
void	writeBuffer(int length) Flushes the previously allocated buffer.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Method Detail

next

MessageBuffer next(int minimumSize)
            throws java.io.IOException

Allocates the next buffer for writing message packed data. If the previously allocated buffer is not flushed yet, this next method should discard it without writing it.

Parameters:

minimumSize - the mimium required buffer size to allocate

Returns:

Throws:

java.io.IOException

writeBuffer

void writeBuffer(int length)
          throws java.io.IOException

Flushes the previously allocated buffer. This method is not always called because next method also flushes previously allocated buffer. This method is called when write method is called or application wants to control the timing of flush.

Parameters:

length - the size of buffer to flush

Throws:

java.io.IOException

write

void write(byte[] buffer,
           int offset,
           int length)
    throws java.io.IOException

Writes an external payload data. This method should follow semantics of OutputStream.

Parameters:

buffer - the data to write

offset - the start offset in the data

length - the number of bytes to write

Throws:

java.io.IOException

add

void add(byte[] buffer,
         int offset,
         int length)
  throws java.io.IOException

Writes an external payload data. This buffer is given - this MessageBufferOutput owns the buffer and may modify contents of the buffer. Contents of this buffer won't be modified by the caller.

Parameters:

buffer - the data to add

offset - the start offset in the data

length - the number of bytes to add

Throws:

java.io.IOException