Package 

Class MessagePack

  • 
public class MessagePack

    Convenience class to build packer and unpacker classes.

    You can select an appropriate factory method as following.

    Deserializing objects from binary:

    Serializing objects into binary:

    • Method Detail

      • newDefaultPacker

         static MessagePacker newDefaultPacker(OutputStream out)

        Creates a packer that serializes objects into the specified output stream.

        Note that you don't have to wrap OutputStream in BufferedOutputStream because MessagePacker has bufferinginternally.

        This method is equivalent to DEFAULT_PACKER_CONFIG.newPacker(out).

        Parameters:
        out - The output stream that receives sequence of bytes

      • newDefaultPacker

         static MessagePacker newDefaultPacker(WritableByteChannel channel)

        Creates a packer that serializes objects into the specified writable channel.

        This method is equivalent to DEFAULT_PACKER_CONFIG.newPacker(channel).

        Parameters:
        channel - The output channel that receives sequence of bytes

      • newDefaultBufferPacker

         static MessageBufferPacker newDefaultBufferPacker()

        Creates a packer that serializes objects into byte arrays.

        This method provides an optimized implementation of newDefaultBufferPacker(new ByteArrayOutputStream()).

        This method is equivalent to DEFAULT_PACKER_CONFIG.newBufferPacker().

      • newDefaultUnpacker

         static MessageUnpacker newDefaultUnpacker(InputStream in)

        Creates an unpacker that deserializes objects from a specified input stream.

        Note that you don't have to wrap InputStream in BufferedInputStream because MessageUnpacker has bufferinginternally.

        This method is equivalent to DEFAULT_UNPACKER_CONFIG.newDefaultUnpacker(in).

        Parameters:
        in - The input stream that provides sequence of bytes

      • newDefaultUnpacker

         static MessageUnpacker newDefaultUnpacker(ReadableByteChannel channel)

        Creates an unpacker that deserializes objects from a specified readable channel.

        This method is equivalent to DEFAULT_UNPACKER_CONFIG.newDefaultUnpacker(in).

        Parameters:
        channel - The input channel that provides sequence of bytes

      • newDefaultUnpacker

         static MessageUnpacker newDefaultUnpacker(Array<byte> contents)

        Creates an unpacker that deserializes objects from a specified byte array.

        This method provides an optimized implementation of newDefaultUnpacker(new ByteArrayInputStream(contents)).

        This method is equivalent to DEFAULT_UNPACKER_CONFIG.newDefaultUnpacker(contents).

        Parameters:
        contents - The byte array that contains packed objects in MessagePack format

      • newDefaultUnpacker

         static MessageUnpacker newDefaultUnpacker(Array<byte> contents, int offset, int length)

        Creates an unpacker that deserializes objects from subarray of a specified byte array.

        This method provides an optimized implementation of newDefaultUnpacker(new ByteArrayInputStream(contents, offset, length)).

        This method is equivalent to DEFAULT_UNPACKER_CONFIG.newDefaultUnpacker(contents).

        Parameters:
        contents - The byte array that contains packed objects
        offset - The index of the first byte
        length - The number of bytes

      • newDefaultUnpacker

         static MessageUnpacker newDefaultUnpacker(ByteBuffer contents)

        Creates an unpacker that deserializes objects from a specified ByteBuffer.

        Note that the returned unpacker reads data from the current position of the ByteBuffer until its limit.However, its position does not change when unpacker reads data. You may use getTotalReadBytes to get actual amount of bytes used in ByteBuffer.

        This method supports both non-direct buffer and direct buffer.

        Parameters:
        contents - The byte buffer that contains packed objects