Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Token #26

Merged
merged 10 commits into from
Mar 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 1 addition & 11 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,7 @@ matrix:
env:
- CONAN_APPLE_CLANG_VERSIONS=11.0

# Test supported dependency versions
- <<: *linux
env:
- CONAN_GCC_VERSIONS=7
- CONAN_DOCKER_IMAGE=conanio/gcc7
- CONAN_OPTIONS=boost=1.70.0
- <<: *linux
env:
- CONAN_GCC_VERSIONS=7
- CONAN_DOCKER_IMAGE=conanio/gcc7
- CONAN_OPTIONS=boost=1.71.0
# Test supported boost versions
- <<: *linux
env:
- CONAN_GCC_VERSIONS=7
Expand Down
54 changes: 28 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@

## Header-only | msgpack-RPC | Boost.Asio

This library requires C++17 and is designed as an extension to Boost.Asio. It will let you built asynchronous servers or client for msgpack-RPC.
This library requires C++17 and is designed as an extension to Boost.Asio. It will let you build asynchronous servers or client for msgpack-RPC.

The library is still under development and is therefore subject heavy API changes.

The project is hosted on [GitHub](https://github.com/qchateau/packio/) and packaged with [Conan](https://bintray.com/beta/#/qchateau/qchateau/packio:_?tab=overview). Documentation is available on [GitHub Pages](https://qchateau.github.io/packio/).
The project is hosted on [GitHub](https://github.com/qchateau/packio/) and available on [Conan Center](https://conan.io/center/). Documentation is available on [GitHub Pages](https://qchateau.github.io/packio/).

## Primer

Expand All @@ -21,7 +19,11 @@ server->dispatcher()->add("add", [](int a, int b) { return a + b; });
// Declare an asynchronous callback
server->dispatcher()->add_async(
"multiply", [](packio::completion_handler complete, int a, int b) {
complete(a * b);
// Call the completion handler later
boost::asio::post(
io, [a, b, complete = std::move(complete)]() mutable {
complete(a * b);
});
});

// Accept connections forever
Expand All @@ -34,20 +36,26 @@ client->async_call("add", std::make_tuple(42, 24),
[&](boost::system::error_code, msgpack::object r) {
std::cout << "The result is: " << r.as<int>() << std::endl;
});
// Use as<> wrapper to hide result type conversion

// Use boost::asio::use_future
std::future<msgpack::object_handle> add_future = client->async_call(
"add", std::tuple{12, 23}, boost::asio::use_future);
std::cout << "The result is: " << add_future.get()->as<int>() << std::endl;

// Use auto result type conversion
client->async_call(
"multiply",
std::make_tuple(42, 24),
packio::as<int>([&](boost::system::error_code, std::optional<int> r) {
multiply_result.set_value(*r);
}));
[&](boost::system::error_code, std::optional<int> r) {
std::cout << "The result is: " << *r << std::endl;
});
```

## Requirements

- C++17
- Boost.Asio >= 1.70.0
- msgpack >= 3.0.1
- Boost.Asio >= 1.72.0
- msgpack >= 3.2.1

## Tested compilers

Expand All @@ -65,10 +73,8 @@ client->async_call(

## Conan

Add my remote and install packio:
```bash
conan remote add qchateau https://api.bintray.com/conan/qchateau/qchateau
conan install -r qchateau packio/0.8.0
conan install packio/1.1.0
```

## Bonus
Expand Down Expand Up @@ -106,18 +112,15 @@ int main(int argc, char** argv)
client->async_call(
"fibonacci",
std::tuple{n - 1},
[=, &client, complete = std::move(complete)](
boost::system::error_code,
msgpack::object_handle result1) mutable {
int r1 = result1->as<int>();
[n, &client, complete = std::move(complete)](
boost::system::error_code, std::optional<int> r1) mutable {
client->async_call(
"fibonacci",
std::tuple{n - 2},
[=, complete = std::move(complete)](
[r1, complete = std::move(complete)](
boost::system::error_code,
msgpack::object_handle result2) mutable {
int r2 = result2->as<int>();
complete(r1 + r2);
std::optional<int> r2) mutable {
complete(*r1 + *r2);
});
});
});
Expand All @@ -129,9 +132,9 @@ int main(int argc, char** argv)

client->async_call(
"fibonacci",
std::make_tuple(n),
[&](boost::system::error_code, msgpack::object_handle r) {
result = r->as<int>();
std::tuple{n},
[&](boost::system::error_code, std::optional<int> r) {
result = *r;
io.stop();
});

Expand All @@ -141,5 +144,4 @@ int main(int argc, char** argv)

return 0;
}

```
4 changes: 2 additions & 2 deletions conanfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

class PackioConan(ConanFile):
name = "packio"
version = "1.0.2"
version = "1.1.0"
license = "MPL-2.0"
author = "Quentin Chateau <quentin.chateau@gmail.com>"
url = "https://github.com/qchateau/packio"
Expand All @@ -13,7 +13,7 @@ class PackioConan(ConanFile):
no_copy_source = True
requires = [
"msgpack/3.2.1",
"boost/[>=1.70]",
"boost/[>=1.72]",
]

def package(self):
Expand Down
12 changes: 5 additions & 7 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,11 @@
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepackio.html" target="_self">packio</a></td><td class="desc">The packio namespace </td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>traits</b></td><td class="desc"></td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1AsCallHandler.html" target="_self">AsCallHandler</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1AsCallHandler.html" title="AsCallHandler. ">AsCallHandler</a> </td></tr>
<tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1AsVoidCallHandler.html" target="_self">AsVoidCallHandler</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1AsVoidCallHandler.html" title="AsVoidCallHandler. ">AsVoidCallHandler</a> </td></tr>
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1AsyncProcedure.html" target="_self">AsyncProcedure</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1AsyncProcedure.html" title="AsyncProcedure trait. ">AsyncProcedure</a> trait </td></tr>
<tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1CallHandler.html" target="_self">CallHandler</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1CallHandler.html" title="CallHandler trait. ">CallHandler</a> trait </td></tr>
<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1NotifyHandler.html" target="_self">NotifyHandler</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1NotifyHandler.html" title="NotifyHandler trait. ">NotifyHandler</a> trait </td></tr>
<tr id="row_0_0_5_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1ServeHandler.html" target="_self">ServeHandler</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1ServeHandler.html" title="ServeHandler trait. ">ServeHandler</a> trait </td></tr>
<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1SyncProcedure.html" target="_self">SyncProcedure</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1SyncProcedure.html" title="SyncProcedure trait. ">SyncProcedure</a> trait </td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1AsyncProcedure.html" target="_self">AsyncProcedure</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1AsyncProcedure.html" title="AsyncProcedure trait. ">AsyncProcedure</a> trait </td></tr>
<tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1CallHandler.html" target="_self">CallHandler</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1CallHandler.html" title="CallHandler trait. ">CallHandler</a> trait </td></tr>
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1NotifyHandler.html" target="_self">NotifyHandler</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1NotifyHandler.html" title="NotifyHandler trait. ">NotifyHandler</a> trait </td></tr>
<tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1ServeHandler.html" target="_self">ServeHandler</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1ServeHandler.html" title="ServeHandler trait. ">ServeHandler</a> trait </td></tr>
<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpackio_1_1traits_1_1SyncProcedure.html" target="_self">SyncProcedure</a></td><td class="desc"><a class="el" href="structpackio_1_1traits_1_1SyncProcedure.html" title="SyncProcedure trait. ">SyncProcedure</a> trait </td></tr>
<tr id="row_0_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpackio_1_1client.html" target="_self">client</a></td><td class="desc">The client class </td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpackio_1_1completion__handler.html" target="_self">completion_handler</a></td><td class="desc">The <a class="el" href="classpackio_1_1completion__handler.html" title="The completion_handler class. ">completion_handler</a> class </td></tr>
<tr id="row_0_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpackio_1_1dispatcher.html" target="_self">dispatcher</a></td><td class="desc">The dispatcher class, used to store and dispatch procedures </td></tr>
Expand Down
20 changes: 10 additions & 10 deletions docs/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,17 @@
<div class="qindex"><a class="qindex" href="#letter_a">a</a>&#160;|&#160;<a class="qindex" href="#letter_c">c</a>&#160;|&#160;<a class="qindex" href="#letter_d">d</a>&#160;|&#160;<a class="qindex" href="#letter_n">n</a>&#160;|&#160;<a class="qindex" href="#letter_s">s</a></div>
<table class="classindex">
<tr><td rowspan="2" valign="bottom"><a name="letter_a"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;a&#160;&#160;</div></td></tr></table>
</td><td rowspan="2" valign="bottom"><a name="letter_c"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;c&#160;&#160;</div></td></tr></table>
</td><td rowspan="2" valign="bottom"><a name="letter_d"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;d&#160;&#160;</div></td></tr></table>
</td><td valign="top"><a class="el" href="classpackio_1_1client.html">client</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_n"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;n&#160;&#160;</div></td></tr></table>
</td><td valign="top"><a class="el" href="classpackio_1_1server.html">server</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td></tr>
<tr><td valign="top"><a class="el" href="classpackio_1_1completion__handler.html">completion_handler</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classpackio_1_1server__session.html">server_session</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td></tr>
<tr><td valign="top"><a class="el" href="structpackio_1_1traits_1_1AsyncProcedure.html">AsyncProcedure</a> (packio::traits)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_d"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;d&#160;&#160;</div></td></tr></table>
</td><td valign="top"><a class="el" href="structpackio_1_1traits_1_1NotifyHandler.html">NotifyHandler</a> (packio::traits)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structpackio_1_1traits_1_1SyncProcedure.html">SyncProcedure</a> (packio::traits)&#160;&#160;&#160;</td></tr>
<tr><td rowspan="2" valign="bottom"><a name="letter_c"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;c&#160;&#160;</div></td></tr></table>
</td><td rowspan="2" valign="bottom"><a name="letter_s"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;s&#160;&#160;</div></td></tr></table>
</td><td valign="top"><a class="el" href="structpackio_1_1traits_1_1SyncProcedure.html">SyncProcedure</a> (packio::traits)&#160;&#160;&#160;</td></tr>
<tr><td></td></tr>
<tr><td valign="top"><a class="el" href="structpackio_1_1traits_1_1AsCallHandler.html">AsCallHandler</a> (packio::traits)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structpackio_1_1traits_1_1CallHandler.html">CallHandler</a> (packio::traits)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classpackio_1_1dispatcher.html">dispatcher</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structpackio_1_1traits_1_1ServeHandler.html">ServeHandler</a> (packio::traits)&#160;&#160;&#160;</td><td></td></tr>
<tr><td valign="top"><a class="el" href="structpackio_1_1traits_1_1AsVoidCallHandler.html">AsVoidCallHandler</a> (packio::traits)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classpackio_1_1client.html">client</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_n"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;n&#160;&#160;</div></td></tr></table>
</td><td valign="top"><a class="el" href="classpackio_1_1server.html">server</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td><td></td></tr>
<tr><td valign="top"><a class="el" href="structpackio_1_1traits_1_1AsyncProcedure.html">AsyncProcedure</a> (packio::traits)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classpackio_1_1completion__handler.html">completion_handler</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classpackio_1_1server__session.html">server_session</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td><td></td></tr>
<tr><td></td><td></td><td valign="top"><a class="el" href="structpackio_1_1traits_1_1NotifyHandler.html">NotifyHandler</a> (packio::traits)&#160;&#160;&#160;</td><td></td><td></td></tr>
<tr><td></td><td></td><td></td><td></td><td></td></tr>
</td><td></td></tr>
<tr><td valign="top"><a class="el" href="classpackio_1_1dispatcher.html">dispatcher</a> (<a class="el" href="namespacepackio.html">packio</a>)&#160;&#160;&#160;</td><td></td></tr>
<tr><td valign="top"><a class="el" href="structpackio_1_1traits_1_1CallHandler.html">CallHandler</a> (packio::traits)&#160;&#160;&#160;</td><td></td><td valign="top"><a class="el" href="structpackio_1_1traits_1_1ServeHandler.html">ServeHandler</a> (packio::traits)&#160;&#160;&#160;</td><td></td></tr>
<tr><td></td><td></td><td></td><td></td></tr>
</table>
<div class="qindex"><a class="qindex" href="#letter_a">a</a>&#160;|&#160;<a class="qindex" href="#letter_c">c</a>&#160;|&#160;<a class="qindex" href="#letter_d">d</a>&#160;|&#160;<a class="qindex" href="#letter_n">n</a>&#160;|&#160;<a class="qindex" href="#letter_s">s</a></div>
</div><!-- contents -->
Expand Down