org.msgpack.core

Class MessagePack

java.lang.Object

org.msgpack.core.MessagePack

public class MessagePack
extends java.lang.Object

This class has MessagePack prefix code definitions and packer/unpacker factory methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessagePack.Code The prefix code set of MessagePack.
static class	MessagePack.Config Message packer/unpacker configuration object
static class	MessagePack.ConfigBuilder Builder of the configuration object

Field Summary

Fields

Modifier and Type	Field and Description
static MessagePack	DEFAULT Default MessagePack packer/unpacker factory
static java.nio.charset.Charset	UTF8

Constructor Summary

Constructors

Constructor and Description
MessagePack()
MessagePack(MessagePack.Config config)

Method Summary

Modifier and Type	Method and Description
static MessagePacker	newDefaultPacker(java.io.OutputStream out) Create a MessagePacker that outputs the packed data to the specified stream, using the default configuration
static MessagePacker	newDefaultPacker(java.nio.channels.WritableByteChannel channel) Create a MessagePacker that outputs the packed data to the specified channel, using the default configuration
static MessageUnpacker	newDefaultUnpacker(byte[] arr) Create a MessageUnpacker that reads data from the given byte array, using the default configuration
static MessageUnpacker	newDefaultUnpacker(byte[] arr, int offset, int length) Create a MessageUnpacker that reads data form the given byte array [offset, ..
static MessageUnpacker	newDefaultUnpacker(java.io.InputStream in) Create a MessageUnpacker that reads data from then given InputStream, using the default configuration
static MessageUnpacker	newDefaultUnpacker(java.nio.channels.ReadableByteChannel channel) Create a MessageUnpacker that reads data from the given channel, using the default configuration
MessagePacker	newPacker(java.io.OutputStream out) Create a MessagePacker that outputs the packed data to the specified stream
MessagePacker	newPacker(java.nio.channels.WritableByteChannel channel) Create a MessagePacker that outputs the packed data to the specified channel
MessageUnpacker	newUnpacker(byte[] arr) Create a MessageUnpacker that reads data from the given byte array.
MessageUnpacker	newUnpacker(byte[] arr, int offset, int length) Create a MessageUnpacker that reads data from the given byte array [offset, offset+length)
MessageUnpacker	newUnpacker(java.io.InputStream in) Create a MessageUnpacker that reads data from the given InputStream.
MessageUnpacker	newUnpacker(java.nio.channels.ReadableByteChannel in) Create a MessageUnpacker that reads data from the given ReadableByteChannel.

Methods inherited from class java.lang.Object

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

Field Detail

UTF8

public static final java.nio.charset.Charset UTF8

DEFAULT

public static final MessagePack DEFAULT

Default MessagePack packer/unpacker factory

Constructor Detail

MessagePack

public MessagePack()

MessagePack

public MessagePack(MessagePack.Config config)

Method Detail

newDefaultPacker

public static MessagePacker newDefaultPacker(java.io.OutputStream out)

Create a MessagePacker that outputs the packed data to the specified stream, using the default configuration

Parameters:

out -

Returns:

newDefaultPacker

public static MessagePacker newDefaultPacker(java.nio.channels.WritableByteChannel channel)

Create a MessagePacker that outputs the packed data to the specified channel, using the default configuration

Parameters:

channel -

Returns:

newDefaultUnpacker

public static MessageUnpacker newDefaultUnpacker(java.io.InputStream in)

Create a MessageUnpacker that reads data from then given InputStream, using the default configuration

Parameters:

in -

Returns:

newDefaultUnpacker

public static MessageUnpacker newDefaultUnpacker(java.nio.channels.ReadableByteChannel channel)

Create a MessageUnpacker that reads data from the given channel, using the default configuration

Parameters:

channel -

Returns:

newDefaultUnpacker

public static MessageUnpacker newDefaultUnpacker(byte[] arr)

Create a MessageUnpacker that reads data from the given byte array, using the default configuration

Parameters:

arr -

Returns:

newDefaultUnpacker

public static MessageUnpacker newDefaultUnpacker(byte[] arr,
                                                 int offset,
                                                 int length)

Create a MessageUnpacker that reads data form the given byte array [offset, .. offset+length), using the default configuration.

Parameters:

arr -

offset -

length -

Returns:

newPacker

public MessagePacker newPacker(java.io.OutputStream out)

Create a MessagePacker that outputs the packed data to the specified stream

Parameters:

out -

newPacker

public MessagePacker newPacker(java.nio.channels.WritableByteChannel channel)

Create a MessagePacker that outputs the packed data to the specified channel

Parameters:

channel -

newUnpacker

public MessageUnpacker newUnpacker(java.io.InputStream in)

Create a MessageUnpacker that reads data from the given InputStream. For reading data efficiently from byte[], use MessageUnpacker(byte[]) or MessageUnpacker(byte[], int, int) instead of this constructor.

Parameters:

in -

newUnpacker

public MessageUnpacker newUnpacker(java.nio.channels.ReadableByteChannel in)

Create a MessageUnpacker that reads data from the given ReadableByteChannel.

Parameters:

in -

newUnpacker

public MessageUnpacker newUnpacker(byte[] arr)

Create a MessageUnpacker that reads data from the given byte array.

Parameters:

arr -

newUnpacker

public MessageUnpacker newUnpacker(byte[] arr,
                                   int offset,
                                   int length)

Create a MessageUnpacker that reads data from the given byte array [offset, offset+length)

Parameters:

arr -

offset -

length -