org.msgpack.core

Class MessagePacker

java.lang.Object

org.msgpack.core.MessagePacker

All Implemented Interfaces:

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

Direct Known Subclasses:

MessageBufferPacker

public class MessagePacker
extends java.lang.Object
implements java.io.Closeable, java.io.Flushable

Writer of message packed data.

MessagePacker provides packXXX methods for writing values in the message pack format. To write raw string or binary data, first use packRawStringHeader or packBinaryHeader to specify the data length, then call writePayload(...) method.

MessagePacker class has no guarantee to produce the correct message-pack format data if it is not used correctly: packXXX methods of primitive values always produce the correct format, but packXXXHeader (e.g. array, map, ext) must be followed by correct number of array/map/ext type values. packRawStringHeader(length) and packBinaryHeader(length) must be followed by writePayload( ... length) to supply the binary data of the specified length in the header.

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageBufferOutput	out

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessagePacker(MessageBufferOutput out, MessagePack.PackerConfig config) Create an MessagePacker that outputs the packed data to the given MessageBufferOutput.

Method Summary

Modifier and Type	Method and Description
MessagePacker	addPayload(byte[] src) Writes buffer to the output.
MessagePacker	addPayload(byte[] src, int off, int len) Writes buffer to the output.
void	close()
void	flush()
long	getTotalWrittenBytes()
MessagePacker	packArrayHeader(int arraySize)
MessagePacker	packBigInteger(java.math.BigInteger bi)
MessagePacker	packBinaryHeader(int len)
MessagePacker	packBoolean(boolean b)
MessagePacker	packByte(byte b)
MessagePacker	packDouble(double v)
MessagePacker	packExtensionTypeHeader(byte extType, int payloadLen)
MessagePacker	packFloat(float v)
MessagePacker	packInt(int r)
MessagePacker	packLong(long v)
MessagePacker	packMapHeader(int mapSize)
MessagePacker	packNil()
MessagePacker	packRawStringHeader(int len)
MessagePacker	packShort(short v)
MessagePacker	packString(java.lang.String s) Pack the input String in UTF-8 encoding
MessagePacker	packValue(Value v)
MessageBufferOutput	reset(MessageBufferOutput out) Reset output.
MessagePacker	writePayload(byte[] src) Writes buffer to the output.
MessagePacker	writePayload(byte[] src, int off, int len) Writes buffer to the output.

Methods inherited from class java.lang.Object

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

Field Detail

out

protected MessageBufferOutput out

Constructor Detail

MessagePacker

protected MessagePacker(MessageBufferOutput out,
                        MessagePack.PackerConfig config)

Create an MessagePacker that outputs the packed data to the given MessageBufferOutput. This method is available for subclasses to override. Use MessagePack.PackerConfig.newPacker method to instanciate this implementation.

Parameters:

out - MessageBufferOutput. Use OutputStreamBufferOutput, ChannelBufferOutput or your own implementation of MessageBufferOutput interface.

Method Detail

reset

public MessageBufferOutput reset(MessageBufferOutput out)
                          throws java.io.IOException

Reset output. This method doesn't close the old resource.

Parameters:

out - new output

Returns:

the old resource

Throws:

java.io.IOException

getTotalWrittenBytes

public long getTotalWrittenBytes()

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

packNil

public MessagePacker packNil()
                      throws java.io.IOException

Throws:

java.io.IOException

packBoolean

public MessagePacker packBoolean(boolean b)
                          throws java.io.IOException

Throws:

java.io.IOException

packByte

public MessagePacker packByte(byte b)
                       throws java.io.IOException

Throws:

java.io.IOException

packShort

public MessagePacker packShort(short v)
                        throws java.io.IOException

Throws:

java.io.IOException

packInt

public MessagePacker packInt(int r)
                      throws java.io.IOException

Throws:

java.io.IOException

packLong

public MessagePacker packLong(long v)
                       throws java.io.IOException

Throws:

java.io.IOException

packBigInteger

public MessagePacker packBigInteger(java.math.BigInteger bi)
                             throws java.io.IOException

Throws:

java.io.IOException

packFloat

public MessagePacker packFloat(float v)
                        throws java.io.IOException

Throws:

java.io.IOException

packDouble

public MessagePacker packDouble(double v)
                         throws java.io.IOException

Throws:

java.io.IOException

packString

public MessagePacker packString(java.lang.String s)
                         throws java.io.IOException

Pack the input String in UTF-8 encoding

Parameters:

s -

Returns:

Throws:

java.io.IOException

packArrayHeader

public MessagePacker packArrayHeader(int arraySize)
                              throws java.io.IOException

Throws:

java.io.IOException

packMapHeader

public MessagePacker packMapHeader(int mapSize)
                            throws java.io.IOException

Throws:

java.io.IOException

packValue

public MessagePacker packValue(Value v)
                        throws java.io.IOException

Throws:

java.io.IOException

packExtensionTypeHeader

public MessagePacker packExtensionTypeHeader(byte extType,
                                             int payloadLen)
                                      throws java.io.IOException

Throws:

java.io.IOException

packBinaryHeader

public MessagePacker packBinaryHeader(int len)
                               throws java.io.IOException

Throws:

java.io.IOException

packRawStringHeader

public MessagePacker packRawStringHeader(int len)
                                  throws java.io.IOException

Throws:

java.io.IOException

writePayload

public MessagePacker writePayload(byte[] src)
                           throws java.io.IOException

Writes buffer to the output. This method is used with packRawStringHeader or packBinaryHeader.

Parameters:

src - the data to add

Returns:

this

Throws:

java.io.IOException

writePayload

public MessagePacker writePayload(byte[] src,
                                  int off,
                                  int len)
                           throws java.io.IOException

Writes buffer to the output. This method is used with packRawStringHeader or packBinaryHeader.

Parameters:

src - the data to add

off - the start offset in the data

len - the number of bytes to add

Returns:

this

Throws:

java.io.IOException

addPayload

public MessagePacker addPayload(byte[] src)
                         throws java.io.IOException

Writes buffer to the output. Unlike writePayload method, addPayload method doesn't copy the source data. It means that the caller must not modify the data after calling this method.

Parameters:

src - the data to add

Returns:

this

Throws:

java.io.IOException

addPayload

public MessagePacker addPayload(byte[] src,
                                int off,
                                int len)
                         throws java.io.IOException

Writes buffer to the output. Unlike writePayload method, addPayload method doesn't copy the source data. It means that the caller must not modify the data after calling this method.

Parameters:

src - the data to add

off - the start offset in the data

len - the number of bytes to add

Returns:

this

Throws:

java.io.IOException