Simple MsgPack is a simple Java library for handling MessagePack data. It doesn’t do any object mapping, but maps to special objects representing MessagePack types. For most cases you might be better off using the official library org.msgpack:msgpack. https://dissem.ch/msgpack/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Christian Basler 42a5f35726 Merge branch 'release/2.0.1' 4 years ago
buildSrc/src/main Migrated to Kotlin 4 years ago
gradle/wrapper fixed build. I'm embarassed that I didn't notice the empty JAR file. 4 years ago
src Migrated to Kotlin 4 years ago
.gitignore initial commit 4 years ago
.travis.yml Updated README.md and Travis config file 4 years ago
CHANGELOG.md Added changelog 4 years ago
LICENSE Added license (Apache 2.0) 4 years ago
README.md Migrated to Kotlin 4 years ago
build.gradle fixed build. I'm embarassed that I didn't notice the empty JAR file. 4 years ago
gradle.properties Add default gradle settings 4 years ago
gradlew fixed build. I'm embarassed that I didn't notice the empty JAR file. 4 years ago
gradlew.bat initial commit 4 years ago
settings.gradle initial commit 4 years ago

README.md

Simple MessagePack

Maven Central Javadoc Apache 2

This is a simple Kotlin/Java library for handling MessagePack data. It doesn't do any object mapping, but maps to special objects representing MessagePack types. To build, use command ./gradlew build.

For most cases you might be better off using org.msgpack:msgpack, but I found that I needed something that generically represents the internal structure of the data.

Simple MessagePack uses Semantic Versioning, meaning as long as the major version doesn't change, nothing should break if you update. Be aware though that this doesn't necessarily applies for SNAPSHOT builds and the development branch.

Master

Build Status Code Quality Test Coverage

Develop

Build Status Code Quality Test Coverage

Limitations

  • There is no fallback to BigInteger for large integer type numbers, so there might be an integer overflow when reading too large numbers
  • MPFloat uses the data type you're using to decide on precision (float 32 or 64) - not the actual value. E.g. 0.5 could be saved perfectly as a float 42, but if you provide a double value, it will be stored as float 64, wasting 4 bytes.
  • If you want to use the 'ext format family', you'll need to implement and register your own MPType and MPType.Unpacker.
  • Be aware that custom MPType.Unpacker take precedence over the default unpackers, i.e. if you accidentally define your unpacker to handle strings, for example, you won't be able to unpack any regular strings anymore.

Setup

Add msgpack as Gradle dependency:

compile "ch.dissem.msgpack:msgpack:1.0.0"

Usage

Serialize Data

First, you'll need to create some msgpack objects to serialize:

MPMap<MPString, MPType<?>> object = new MPMap<>();
object.put(new MPString("compact"), new MPBoolean(true));
object.put(new MPString("schema"), new MPInteger(0));

or the shorthand version for simple types:

import static ch.dissem.msgpack.types.Utils.mp;

MPMap<MPString, MPType<?>> object = new MPMap<>();
object.put(mp("compact"), mp(true));
object.put(mp("schema"), mp(0));

then just use pack(OutputStream):

OutputStream out = ...;
object.pack(out);

Deserialize Data

For deserializing data there is the reader object:

Reader reader = Reader.getInstance()

just use reader.read(InputStream). Unfortunately you'll need to make sure you got what you expected, the following example might result in ClassCastException at weird places:

InputStream in = ...;
MPType read = reader.read(in);
MPMap<MPString, MPString> map = (MPMap<MPString, MPString>) read;
String value = map.get(mp("key")).getValue();