romixlab/qmsgpack
1
0
Fork 1
mirror of https://github.com/romixlab/qmsgpack.git synced 2025-07-30 10:27:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Roman
2015-06-27 14:46:47 +03:00
parent 8482a8a5c8
commit 2bbc07fb52
1 changed files with 13 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -8,24 +8,11 @@ Installation
Clone repository: Clone repository:
~~~bash ~~~bash
git clone https://github.com/romixlab/qmsgpack.git git clone https://github.com/romixlab/qmsgpack.git
~~~
Run cmake:
~~~bash
cd qmsgpack cd qmsgpack
mkdir build mkdir build
cd build cd build
cmake .. cmake ..
~~~ make install
Compile:
~~~bash
make
~~~
Run tests and install
~~~bash
make tests install
~~~ ~~~
Sample usage Sample usage
@ -42,11 +29,16 @@ Unpacking:
QVariantList unpacked = MsgPack::unpack(array).toList(); QVariantList unpacked = MsgPack::unpack(array).toList();
~~~ ~~~
By default these Qt types are supported: `Int, UInt, LongLong, ULongLong, Double, QByteArray, Bool, QString, QStringList, QVariantList, QVariantMap`. Streaming API:
~~~cpp
// packing
MsgPackStream stream(&ba, QIODevice::WriteOnly);
stream << 1 << 2.3 << "some string";
Also you can provide packer and unpacker functions for any other type (even for user type defined via `Q_DECLARE_METATYPE`) or MsgPack type. // unpacking
MsgPackStream stream(ba);
Thread-safety int a;
------------- double b;
At this time it is not safe to call `MsgPack::registerPacker`, `MsgPack::registerUnpacker` and `MsgPack::setCompatibilityModeEnabled` from different threads. QSting s;
pack and unpack methods do not use any global data, so should be safe to use from multiple threads. stream >> a >> b >> s;
~~~