MessagePack implementation for C and C++ / msgpack.org[C/C++]
C++ C CMake Other
Permalink
Failed to load latest commit information.
ci Updated travis-ci. Jan 6, 2017
erb/v1 Fixed zone expansion algorithm. Jul 23, 2017
example Merge branch 'alignment' of https://github.com/chshaob1/msgpack-c int… Jul 22, 2017
external/boost Updated boost predef and preprocessor from 1.58.0 to 1.61.0 May 30, 2016
include Removed unused code. Nov 12, 2017
src Pass wildcard precision of snprintf as int Mar 22, 2017
test Added * and -> operators to object_handle Oct 9, 2017
.gitignore Add a list of contributors in README.md and remove AUTHORS file Feb 16, 2015
.gitmodules Added Boost.Preprocessor as a submodule. Aug 11, 2015
.travis.yml Added symbolic link. Oct 9, 2017
CHANGELOG.md Updated the version to 2.1.5. Aug 4, 2017
CMakeLists.txt Partially fixed #460. Jul 20, 2017
COPYING Version 1.3.0. Nov 21, 2015
Doxyfile reorganized tree Jan 4, 2013
Files.cmake Fixed #644. Nov 11, 2017
LICENSE_1_0.txt Version 1.3.0. Nov 21, 2015
NOTICE Version 1.3.0. Nov 21, 2015
QUICKSTART-C.md Don't sudo with brew in QUICKSTART-C.md Oct 1, 2017
QUICKSTART-CPP.md Minor fix to Quickstart (broke with 2.0) Feb 11, 2017
README.md Updated the version to 2.1.5. Aug 4, 2017
appveyor.yml Updated the version to 2.1.5. Aug 4, 2017
make_file_list.sh Fix typo that caused the C++ headers not to be included in cmake file… Oct 30, 2016
makedist.sh Added a missing cmake file to makedist.sh. Jun 12, 2017
msgpack-config.cmake.in Add cmake package config support Apr 4, 2017
msgpack.pc.in Fixed #395 Jan 13, 2016
msgpack_vc8.sln Add msvc project back Jun 7, 2016
msgpack_vc8.vcproj Add msvc project back Jun 7, 2016
preprocess Re-organized tree to prepare for version 2.0.0. Jan 31, 2016
update_version.sh Added version updating script. Aug 3, 2017

README.md

msgpack for C/C++

Version 2.1.5 Build Status Build status

It's like JSON but small and fast.

Overview

MessagePack is an efficient binary serialization format, which lets you exchange data among multiple languages like JSON, except that it's faster and smaller. Small integers are encoded into a single byte while typical short strings require only one extra byte in addition to the strings themselves.

Example

In C:

#include <msgpack.h>
#include <stdio.h>

int main(void)
{
    /* msgpack::sbuffer is a simple buffer implementation. */
    msgpack_sbuffer sbuf;
    msgpack_sbuffer_init(&sbuf);

    /* serialize values into the buffer using msgpack_sbuffer_write callback function. */
    msgpack_packer pk;
    msgpack_packer_init(&pk, &sbuf, msgpack_sbuffer_write);

    msgpack_pack_array(&pk, 3);
    msgpack_pack_int(&pk, 1);
    msgpack_pack_true(&pk);
    msgpack_pack_str(&pk, 7);
    msgpack_pack_str_body(&pk, "example", 7);

    /* deserialize the buffer into msgpack_object instance. */
    /* deserialized object is valid during the msgpack_zone instance alive. */
    msgpack_zone mempool;
    msgpack_zone_init(&mempool, 2048);

    msgpack_object deserialized;
    msgpack_unpack(sbuf.data, sbuf.size, NULL, &mempool, &deserialized);

    /* print the deserialized object. */
    msgpack_object_print(stdout, deserialized);
    puts("");

    msgpack_zone_destroy(&mempool);
    msgpack_sbuffer_destroy(&sbuf);

    return 0;
}

See QUICKSTART-C.md for more details.

In C++:

#include <msgpack.hpp>
#include <string>
#include <iostream>
#include <sstream>

int main(void)
{
    msgpack::type::tuple<int, bool, std::string> src(1, true, "example");

    // serialize the object into the buffer.
    // any classes that implements write(const char*,size_t) can be a buffer.
    std::stringstream buffer;
    msgpack::pack(buffer, src);

    // send the buffer ...
    buffer.seekg(0);

    // deserialize the buffer into msgpack::object instance.
    std::string str(buffer.str());

    msgpack::object_handle oh =
        msgpack::unpack(str.data(), str.size());

    // deserialized object is valid during the msgpack::object_handle instance is alive.
    msgpack::object deserialized = oh.get();

    // msgpack::object supports ostream.
    std::cout << deserialized << std::endl;

    // convert msgpack::object instance into the original type.
    // if the type is mismatched, it throws msgpack::type_error exception.
    msgpack::type::tuple<int, bool, std::string> dst;
    deserialized.convert(dst);

    return 0;
}

See QUICKSTART-CPP.md for more details.

Usage

C++ Header Only Library

When you use msgpack on C++03 and C++11, you can just add msgpack-c/include to your include path:

g++ -I msgpack-c/include your_source_file.cpp

If you want to use C version of msgpack, you need to build it. You can also install the C and C++ versions of msgpack.

Building and Installing

Install from git repository

Using the Terminal (CLI)

You will need:

  • gcc >= 4.1.0
  • cmake >= 2.8.0

C and C++03:

$ git clone https://github.com/msgpack/msgpack-c.git
$ cd msgpack-c
$ cmake .
$ make
$ sudo make install

If you want to setup C++11 version of msgpack instead, execute the following commands:

$ git clone https://github.com/msgpack/msgpack-c.git
$ cd msgpack-c
$ cmake -DMSGPACK_CXX11=ON .
$ sudo make install

GUI on Windows

Clone msgpack-c git repository.

$ git clone https://github.com/msgpack/msgpack-c.git

or using GUI git client.

e.g.) tortoise git https://code.google.com/p/tortoisegit/

  1. Launch cmake GUI client.

  2. Set 'Where is the source code:' text box and 'Where to build the binaries:' text box.

  3. Click 'Configure' button.

  4. Choose your Visual Studio version.

  5. Click 'Generate' button.

  6. Open the created msgpack.sln on Visual Studio.

  7. Build all.

Documentation

You can get addtional information on the wiki.

Contributing

msgpack-c is developed on GitHub at msgpack/msgpack-c. To report an issue or send a pull request, use the issue tracker.

Here's the list of great contributors.

License

msgpack-c is licensed under the Boost Software License, Version 1.0. See the LICENSE_1_0.txt file for details.