- create network APIs with little effort
- be as type safe as C++
- don't waste developer time hunting down unnecessary encoding-related issues
- don't waste bandwidth or CPU time for no reason
- support many languages, not only C++
- no coupling to a specific transport protocol
- support the most common ones by default though: TCP, TLS, Websocket, TLS Websocket
- UTF-8 everywhere
- "human-readability" of the transport stream
- support for inheritance or similar nonsense
- support for ancient compilers, standards or Boost versions
- reinventing Boost.Asio, TLS, authentication or Websockets
Supported compilers:
- Visual C++ 2015
- GCC 4.9
Install the required C++ libraries with the Conan package manager (https://conan.io).
The C++ code is formatted automatically with clang-format if CMake can find the clang-format executable on your system.
For consistent formatting use version 3.7 (http://llvm.org/releases/download.html#3.7.1).
You can disable formatting with the CMake option WARPCOIL_USE_CLANG_FORMAT.
| name | parameters | encoding | remarks |
|---|---|---|---|
| integer | minimum, maximum | big endian, as many bytes as necessary for maximum | i. e. 1 byte for 255, 2 bytes for 256 |
| UTF-8 | length (integer) | actual length followed by the usual UTF-8 code units | length is the number of code units. Has to be valid and complete UTF-8 |
| tuple | element types | elements in order | |
| variant | element types | actual element index encoded as an integer followed by the actual element | |
| vector | length (integer), element type | length followed by the elements in order | |
| structure | vector(integer(0, 2^64-1), tuple(UTF-8(integer(1, 255)), type)) | values of the fields in order (no names or indices etc) | The structure is a map from names to types. The order of the fields is significant. Its wire representation does not contain any meta-information about the structure, only the values of the fields in declared order. |
| part of the message | type |
|---|---|
| message type | 1 byte unsigned with value 0 |
| request ID | 8 byte unsigned |
| method | UTF-8, length 0-255 |
| argument | the parameters of the method being called |
| part of the message | type |
|---|---|
| message type (planned new field) | 1 byte unsigned with value 1 |
| request ID | 8 byte unsigned |
| result | the result of the method being called |