diff --git a/CMakeLists.txt b/CMakeLists.txt index 67cd5323..b614663b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -32,7 +32,7 @@ cmake_minimum_required(VERSION 3.16) project( "rpc.hpp" - VERSION 0.6.1 + VERSION 0.7.1 DESCRIPTION "Simple RPC Header-Only Library" LANGUAGES CXX ) @@ -162,6 +162,7 @@ elseif(CXX_CLANG) -Wno-documentation -Wno-documentation-unknown-command -Wno-weak-vtables + -Wno-reserved-identifier -Wno-reserved-id-macro -Wno-missing-braces -Wno-covered-switch-default) diff --git a/INSTALL.md b/INSTALL.md index 445b8baf..5c56a76a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -24,7 +24,7 @@ $ cmake -B build -D BUILD_ADAPTER_BOOST_JSON=ON -D BUILD_ADAPTER_NJSON=ON -D BUI $ cmake --install build ``` -CMake version 3.12 or newer is required for this method, see below for instructions to install CMake +CMake version 3.16 or newer is required for this method, see below for instructions to install CMake if it is not already installed. ## Building and Testing the Project @@ -36,7 +36,7 @@ need to make sure that you can build the project and its test suite. While `rpc.hpp` is a header-only library, the project relies on using a buildsystem to perform certain tasks. -It is therefore required that CMake (version 3.12 or newer) is installed on your machine and +It is therefore required that CMake (version 3.16 or newer) is installed on your machine and available on your `$PATH` to build the project. Additionally, `rpc.hpp` requires at least one C++ compiler that fully supports C++17 or newer: @@ -209,16 +209,16 @@ $ mkdir build 3. Configure the project ```shell -$ cmake -B build -G Ninja -D BUILD_ADAPTER_BOOST_JSON=ON -D BUILD_ADAPTER_NJSON=ON -D BUILD_ADAPTER_RAPIDJSON=ON -D BUILD_TESTING=ON +$ cmake -B build -G Ninja -D BUILD_ADAPTER_BITSERY -D BUILD_ADAPTER_BOOST_JSON=ON -D BUILD_ADAPTER_NJSON=ON -D BUILD_ADAPTER_RAPIDJSON=ON -D BUILD_TESTING=ON ``` NOTE: The above command can be altered based on your needs: - In this example, the "Ninja" generator is used as it is fast, but `-G Ninja` may be omitted to use the system default make system -- With this example, all three adapters are to be built. By omitting one or more, they will not be +- With this example, all adapters are to be built. By omitting one or more, they will not be built (example: `-D BUILD_ADAPTER_BOOST_JSON=ON` could be omitted or set to `=OFF`) - - `BUILD_ADAPTER_NJSON` is required for testing + - **NOTE:** `BUILD_ADAPTER_NJSON` is required for testing - If using Conan to auto-install dependencies, make sure to set its option (add `-D DEPENDS_CONAN=ON`) - If using vcpkg to manage dependencies, make sure to set its option (add `-D DEPENDS_VCPKG=ON`) - You may also need to provide CMake with a vcpkg toolchain file: @@ -235,6 +235,7 @@ $ cmake --build build | Option | Description | |--|--| +| `BUILD_ADAPTER_BITSERY` | Build the adapter for Bitsery | | `BUILD_ADAPTER_BOOST_JSON` | Build the adapter for Boost.JSON | | `BUILD_ADAPTER_NJSON` | Build the adapter for nlohmann/json | | `BUILD_ADAPTER_RAPIDJSON` | Build the adapter for rapidjson | diff --git a/README.md b/README.md index bad8ac06..b5bc4e96 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,6 @@ server.cpp ```C++ #define RPC_HPP_SERVER_IMPL -#define RPC_HPP_ENABLE_NJSON #include #include @@ -101,7 +100,6 @@ client.cpp ```C++ #define RPC_HPP_CLIENT_IMPL -#define RPC_HPP_ENABLE_NJSON #include @@ -126,6 +124,11 @@ private: // Send mesg to server... } + void send(std::string&& mesg) override + { + // Send mesg to server... + } + std::string receive() override { // Get message back from server... diff --git a/benchmarks/CMakeLists.txt b/benchmarks/CMakeLists.txt index d880cf77..ae8186f9 100644 --- a/benchmarks/CMakeLists.txt +++ b/benchmarks/CMakeLists.txt @@ -77,6 +77,7 @@ endif() add_executable(rpc_benchmark benchmark.cpp) target_include_directories(rpc_benchmark PRIVATE ../tests) target_link_libraries(rpc_benchmark PRIVATE rpc_hpp catch2_lib asio_lib) +target_precompile_headers(rpc_benchmark PRIVATE pch.hpp) if(${BUILD_ADAPTER_BITSERY}) target_link_libraries(rpc_benchmark PRIVATE bitsery_adapter) diff --git a/benchmarks/benchmark.cpp b/benchmarks/benchmark.cpp index b1c6040f..39df21c8 100644 --- a/benchmarks/benchmark.cpp +++ b/benchmarks/benchmark.cpp @@ -1,26 +1,26 @@ -#define CATCH_CONFIG_ENABLE_BENCHMARKING -#define CATCH_CONFIG_MAIN #define RPC_HPP_CLIENT_IMPL - -#include "rpc.client.hpp" +#include "test_client/rpc.client.hpp" #include "test_structs.hpp" +#define CATCH_CONFIG_ENABLE_BENCHMARKING +#define CATCH_CONFIG_MAIN #include #if defined(RPC_HPP_ENABLE_BITSERY) const uint64_t rpc::adapters::bitsery::config::max_func_name_size = 30; -const uint64_t rpc::adapters::bitsery::config::max_string_size = 100; -const uint64_t rpc::adapters::bitsery::config::max_container_size = 100; +const uint64_t rpc::adapters::bitsery::config::max_string_size = 2048; +const uint64_t rpc::adapters::bitsery::config::max_container_size = 1'000; #endif TEST_CASE("By Value (simple)", "[value][simple][cached]") { constexpr uint64_t expected = 10946UL; + constexpr uint64_t input = 20; uint64_t test = 1; BENCHMARK("rpc.hpp (asio::tcp, njson)") { - test = GetClient().template call_func("Fibonacci", 20); + test = GetClient().template call_func("Fibonacci", input); }; REQUIRE(expected == test); @@ -30,7 +30,7 @@ TEST_CASE("By Value (simple)", "[value][simple][cached]") BENCHMARK("rpc.hpp (asio::tcp, rapidjson)") { - test = GetClient().template call_func("Fibonacci", 20); + test = GetClient().template call_func("Fibonacci", input); }; REQUIRE(expected == test); @@ -41,7 +41,7 @@ TEST_CASE("By Value (simple)", "[value][simple][cached]") BENCHMARK("rpc.hpp (asio::tcp, Boost.JSON)") { - test = GetClient().template call_func("Fibonacci", 20); + test = GetClient().template call_func("Fibonacci", input); }; REQUIRE(expected == test); @@ -52,7 +52,7 @@ TEST_CASE("By Value (simple)", "[value][simple][cached]") BENCHMARK("rpc.hpp (asio::tcp, bitsery)") { - test = GetClient().template call_func("Fibonacci", 20); + test = GetClient().template call_func("Fibonacci", input); }; REQUIRE(expected == test); @@ -64,15 +64,11 @@ TEST_CASE("By Value (complex)", "[value][complex][cached]") const std::string expected = "467365747274747d315a473a527073796c7e707b85"; std::string test; + const ComplexObject cx{ 24, "Franklin D. Roosevelt", false, true, + { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 } }; + BENCHMARK("rpc.hpp (asio::tcp, njson)") { - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; - test = GetClient().template call_func("HashComplex", cx); }; @@ -83,13 +79,6 @@ TEST_CASE("By Value (complex)", "[value][complex][cached]") BENCHMARK("rpc.hpp (asio::tcp, rapidjson)") { - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; - test = GetClient().template call_func("HashComplex", cx); }; @@ -101,13 +90,6 @@ TEST_CASE("By Value (complex)", "[value][complex][cached]") BENCHMARK("rpc.hpp (asio::tcp, Boost.JSON)") { - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; - test = GetClient().template call_func("HashComplex", cx); }; @@ -119,13 +101,6 @@ TEST_CASE("By Value (complex)", "[value][complex][cached]") BENCHMARK("rpc.hpp (asio::tcp, bitsery)") { - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; - test = GetClient().template call_func("HashComplex", cx); }; @@ -186,11 +161,12 @@ TEST_CASE("By Value (many)", "[value][many][cached]") TEST_CASE("By Reference (simple)", "[ref][simple]") { constexpr uint64_t expected = 10946UL; - uint64_t test = 20; + constexpr uint64_t input = 20; + uint64_t test{}; BENCHMARK("rpc.hpp (asio::tcp, njson)") { - test = 20; + test = input; GetClient().call_func("FibonacciRef", test); }; @@ -199,7 +175,7 @@ TEST_CASE("By Reference (simple)", "[ref][simple]") #if defined(RPC_HPP_ENABLE_RAPIDJSON) BENCHMARK("rpc.hpp (asio::tcp, rapidjson)") { - test = 20; + test = input; GetClient().call_func("FibonacciRef", test); }; #endif @@ -209,7 +185,7 @@ TEST_CASE("By Reference (simple)", "[ref][simple]") #if defined(RPC_HPP_ENABLE_BOOST_JSON) BENCHMARK("rpc.hpp (asio::tcp, Boost.JSON)") { - test = 20; + test = input; GetClient().call_func("FibonacciRef", test); }; @@ -219,7 +195,7 @@ TEST_CASE("By Reference (simple)", "[ref][simple]") #if defined(RPC_HPP_ENABLE_BITSERY) BENCHMARK("rpc.hpp (asio::tcp, bitsery)") { - test = 20; + test = input; GetClient().call_func("FibonacciRef", test); }; @@ -230,17 +206,17 @@ TEST_CASE("By Reference (simple)", "[ref][simple]") TEST_CASE("By Reference (complex)", "[ref][complex]") { const std::string expected = "467365747274747d315a473a527073796c7e707b85"; + const ComplexObject input{ 24, "Franklin D. Roosevelt", false, true, + { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 } }; + + ComplexObject cx{}; + std::string test; BENCHMARK("rpc.hpp (asio::tcp, njson)") { test.clear(); - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; + cx = input; GetClient().call_func("HashComplexRef", cx, test); }; @@ -251,12 +227,7 @@ TEST_CASE("By Reference (complex)", "[ref][complex]") BENCHMARK("rpc.hpp (asio::tcp, rapidjson)") { test.clear(); - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; + cx = input; GetClient().call_func("HashComplexRef", cx, test); }; @@ -268,12 +239,7 @@ TEST_CASE("By Reference (complex)", "[ref][complex]") BENCHMARK("rpc.hpp (asio::tcp, Boost.JSON)") { test.clear(); - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; + cx = input; GetClient().call_func("HashComplexRef", cx, test); }; @@ -285,12 +251,7 @@ TEST_CASE("By Reference (complex)", "[ref][complex]") BENCHMARK("rpc.hpp (asio::tcp, bitsery)") { test.clear(); - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; + cx = input; GetClient().call_func("HashComplexRef", cx, test); }; @@ -302,7 +263,7 @@ TEST_CASE("By Reference (complex)", "[ref][complex]") TEST_CASE("By Reference (many)", "[ref][many]") { constexpr double expected = 313.2216436152; - double test; + double test{}; BENCHMARK("rpc.hpp (asio::tcp, njson)") { @@ -402,13 +363,14 @@ TEST_CASE("By Reference (many)", "[ref][many]") TEST_CASE("With Container", "[container][cached]") { constexpr double expected = 1731.8635996333; + const std::vector input{ 55.65, 125.325, 552.125, 12.767, 2599.6, 1245.125663, 9783.49, + 125.12, 553.3333333333, 2266.1 }; + double test = 1.0; BENCHMARK("rpc.hpp (asio::tcp, njson)") { - const std::vector vec{ 55.65, 125.325, 552.125, 12.767, 2599.6, 1245.125663, - 9783.49, 125.12, 553.3333333333, 2266.1 }; - + const auto& vec = input; test = GetClient().template call_func("AverageContainer", vec); }; @@ -420,9 +382,7 @@ TEST_CASE("With Container", "[container][cached]") BENCHMARK("rpc.hpp (asio::tcp, rapidjson)") { - const std::vector vec{ 55.65, 125.325, 552.125, 12.767, 2599.6, 1245.125663, - 9783.49, 125.12, 553.3333333333, 2266.1 }; - + const auto& vec = input; test = GetClient().template call_func( "AverageContainer", vec); }; @@ -433,9 +393,7 @@ TEST_CASE("With Container", "[container][cached]") BENCHMARK("rpc.hpp (asio::tcp, Boost.JSON)") { - const std::vector vec{ 55.65, 125.325, 552.125, 12.767, 2599.6, 1245.125663, - 9783.49, 125.12, 553.3333333333, 2266.1 }; - + const auto& vec = input; test = GetClient().template call_func( "AverageContainer", vec); }; @@ -446,9 +404,7 @@ TEST_CASE("With Container", "[container][cached]") BENCHMARK("rpc.hpp (asio::tcp, bitsery)") { - const std::vector vec{ 55.65, 125.325, 552.125, 12.767, 2599.6, 1245.125663, - 9783.49, 125.12, 553.3333333333, 2266.1 }; - + const auto& vec = input; test = GetClient().template call_func( "AverageContainer", vec); }; @@ -457,10 +413,14 @@ TEST_CASE("With Container", "[container][cached]") TEST_CASE("Sequential", "[sequential][cached]") { + constexpr uint64_t min_num = 5; + constexpr uint64_t max_num = 30; + constexpr size_t num_rands = 1'000; + BENCHMARK("rpc.hpp (asio::tcp, njson)") { auto vec = GetClient().template call_func>( - "GenRandInts", 5, 30, 1000); + "GenRandInts", min_num, max_num, num_rands); for (auto& val : vec) { @@ -475,7 +435,7 @@ TEST_CASE("Sequential", "[sequential][cached]") BENCHMARK("rpc.hpp (asio::tcp, rapidjson)") { auto vec = GetClient().template call_func>( - "GenRandInts", 5, 30, 1000); + "GenRandInts", min_num, max_num, num_rands); for (auto& val : vec) { @@ -491,7 +451,7 @@ TEST_CASE("Sequential", "[sequential][cached]") BENCHMARK("rpc.hpp (asio::tcp, bjson)") { auto vec = GetClient().template call_func>( - "GenRandInts", 5, 30, 1000); + "GenRandInts", min_num, max_num, num_rands); for (auto& val : vec) { @@ -507,7 +467,7 @@ TEST_CASE("Sequential", "[sequential][cached]") BENCHMARK("rpc.hpp (asio::tcp, bitsery)") { auto vec = GetClient().template call_func>( - "GenRandInts", 5, 30, 1000); + "GenRandInts", min_num, max_num, num_rands); for (auto& val : vec) { @@ -531,5 +491,6 @@ TEST_CASE("KillServer", } catch (...) { + // Exception is expected so continue } } diff --git a/benchmarks/meson.build b/benchmarks/meson.build deleted file mode 100644 index c0adb59a..00000000 --- a/benchmarks/meson.build +++ /dev/null @@ -1,57 +0,0 @@ -# BSD 3-Clause License -# -# Copyright (c) 2020-2021, Jackson Harmer -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, this -# list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -asio_dep = dependency('asio') -catch2_dep = dependency('catch2', version : ['>2.10.0', '<3.0.0']) -thread_dep = dependency('threads') - -bench_dependencies = [rpc_hpp_dep, asio_dep, catch2_dep, thread_dep] -bench_defines = [] - -if get_option('build_adapter_boost_json') - bench_dependencies += [boost_json_adapter_dep] - bench_defines += ['-DRPC_HPP_ENABLE_BOOST_JSON'] -endif - -if get_option('build_adapter_njson') - bench_dependencies += [njson_adapter_dep] - bench_defines += ['-DRPC_HPP_ENABLE_NJSON'] -endif - -if get_option('build_adapter_rapidjson') - bench_dependencies += [rapidjson_adapter_dep] - bench_defines += ['-DRPC_HPP_ENABLE_RAPIDJSON'] -endif - -rpc_bench_exe = executable('rpc_benchmark', 'benchmark.cpp', include_directories : '../tests', dependencies : bench_dependencies, install : false, cpp_args : [project_warnings, bench_defines]) - -if get_option('buildtype') in ['debugoptimized', 'release'] - benchmark('rpc_benchmark', rpc_bench_exe, args : ['--benchmark-samples 20'], timeout : 90) -endif diff --git a/benchmarks/pch.hpp b/benchmarks/pch.hpp new file mode 100644 index 00000000..f134bdc5 --- /dev/null +++ b/benchmarks/pch.hpp @@ -0,0 +1,41 @@ +#pragma once + +// Standard Library +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +// 3rd Party +#include + +#if defined(RPC_HPP_ENABLE_BITSERY) +# include +# include +# include +# include +# include +# include +#endif + +#if defined(RPC_HPP_ENABLE_BOOST_JSON) +# include +#endif + +#if defined(RPC_HPP_ENABLE_NJSON) +# include +#endif + +#if defined(RPC_HPP_ENABLE_RAPIDJSON) +# include +# include +# include +#endif diff --git a/dispatch_gen.py b/dispatch_gen.py index 76a5e06f..d53ab0b4 100644 --- a/dispatch_gen.py +++ b/dispatch_gen.py @@ -129,11 +129,11 @@ f.write("#if defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL)\n") f.write( - "# define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) extern RETURN (*FUNCNAME)(__VA_ARGS__)\n" + "# define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) extern RETURN (* const FUNCNAME)(__VA_ARGS__)\n" ) f.write("#elif defined(RPC_HPP_CLIENT_IMPL)\n") f.write( - "# define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) inline RETURN (*FUNCNAME)(__VA_ARGS__) = nullptr" + "# define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) inline RETURN (* const FUNCNAME)(__VA_ARGS__) = nullptr\n" ) f.write("#endif\n\n") diff --git a/docs/annotated.html b/docs/annotated.html index a319094a..cdabf4da 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
@@ -68,17 +68,38 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
-
[detail level 123]
+
[detail level 12345]
- - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼NrpcTop-level namespace for rpc.hpp classes and functions
 ▼NclientNamespace containing functions and classes only relevant to "client-side" implentations
 Cclient_interfaceClass defining an interface for calling into an RPC server or module
 ▼NserverNamespace containing functions and classes only relevant to "server-side" implentations
 Cserver_interfaceClass defining an interface for serving functions via RPC
 Cpacked_funcObject representing a function call, including the function's name, arguments and result
 Cpacked_func< void, Args... >Object representing a void returning function call, including the function's name and arguments
 Cpack_adapterClass collecting several functions for interoperating between serial objects and a packed_func
 Cserver_interfaceClass defining an interface for serving functions via RPC
 Cclient_interfaceClass defining an interface for calling into an RPC server or module
 ▼Nadapters
 ▼Nbitsery
 ▼Ndetails
 Clargest
 Clargest< T, 0 >
 Clargest< T, 3 >
 Clargest< T, 4 >
 Clargest< T, 6 >
 Cpack_helper
 Cpack_helper< void, Args... >
 ▼NclientNamespace containing functions and classes only relevant to "client-side" implentations
 Cclient_interfaceClass defining an interface for calling into an RPC server or module
 ▼Nexceptions
 Crpc_exception
 Cfunction_not_found
 Cremote_exec_error
 Cserialization_error
 Cdeserialization_error
 Cfunction_mismatch
 Cclient_send_error
 Cclient_receive_error
 Cserver_send_error
 Cserver_receive_error
 ▼NserverNamespace containing functions and classes only relevant to "server-side" implentations
 Cserver_interfaceClass defining an interface for serving functions via RPC
 Cpack_adapterClass collecting several functions for interoperating between serial objects and a packed_func
 Cserver_interfaceClass defining an interface for serving functions via RPC
 Cclient_interfaceClass defining an interface for calling into an RPC server or module
 ▼Nstd
 Chash< std::vector< uint8_t > >
diff --git a/docs/classes.html b/docs/classes.html index a54bda22..106f50be 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
@@ -67,17 +67,32 @@
Class Index
-
C | P | S
+
C | D | F | H | L | P | R | S
C
-
client_interface (rpc::client)
client_interface (rpc)
+
client_interface (rpc::client)
client_interface (rpc)
client_receive_error (rpc::exceptions)
client_send_error (rpc::exceptions)
+
+
D
+
deserialization_error (rpc::exceptions)
+
+
F
+
function_mismatch (rpc::exceptions)
function_not_found (rpc::exceptions)
+
+
H
+
hash< std::vector< uint8_t > > (std)
+
+
L
+
largest (rpc::adapters::bitsery::details)
largest< T, 0 > (rpc::adapters::bitsery::details)
largest< T, 3 > (rpc::adapters::bitsery::details)
largest< T, 4 > (rpc::adapters::bitsery::details)
largest< T, 6 > (rpc::adapters::bitsery::details)
P
-
pack_adapter (rpc)
packed_func (rpc)
packed_func< void, Args... > (rpc)
+
pack_adapter (rpc)
pack_helper (rpc::adapters::bitsery::details)
pack_helper< void, Args... > (rpc::adapters::bitsery::details)
+
R
+
remote_exec_error (rpc::exceptions)
rpc_exception (rpc::exceptions)
+
S
-
server_interface (rpc::server)
server_interface (rpc)
+
serialization_error (rpc::exceptions)
server_interface (rpc::server)
server_interface (rpc)
server_receive_error (rpc::exceptions)
server_send_error (rpc::exceptions)
diff --git a/docs/classrpc_1_1client_1_1client__interface-members.html b/docs/classrpc_1_1client_1_1client__interface-members.html index 5a7d4481..6bd4b43f 100644 --- a/docs/classrpc_1_1client_1_1client__interface-members.html +++ b/docs/classrpc_1_1client_1_1client__interface-members.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
@@ -74,10 +74,19 @@

This is the complete list of members for rpc::client::client_interface< Serial >, including all inherited members.

- + + + + + + + + + - + +
call_func(std::string func_name, Args &&... args)rpc::client::client_interface< Serial >inline
call_func(const std::string &func_name, Args &&... args)rpc::client::client_interface< Serial >inline
call_func(std::string &&func_name, Args &&... args)rpc::client::client_interface< Serial >inline
call_header_func_impl([[maybe_unused]] R(*func)(Args...), const std::string &func_name, Args &&... args) (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >inline
call_header_func_impl([[maybe_unused]] R(*func)(Args...), std::string &&func_name, Args &&... args) (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >inline
client_interface() noexcept=default (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >
client_interface(const client_interface &)=delete (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >
client_interface(client_interface &&) noexcept=default (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >
operator=(const client_interface &)=delete (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >
operator=(client_interface &&)=delete (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >
receive()=0rpc::client::client_interface< Serial >protectedpure virtual
send(const typename Serial::bytes_t &bytes)=0rpc::client::client_interface< Serial >protectedpure virtual
~client_interface()=default (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >virtual
send(typename Serial::bytes_t &&bytes)=0rpc::client::client_interface< Serial >protectedpure virtual
~client_interface() noexcept=default (defined in rpc::client::client_interface< Serial >)rpc::client::client_interface< Serial >virtual
diff --git a/docs/classrpc_1_1client_1_1client__interface.html b/docs/classrpc_1_1client_1_1client__interface.html index 44f37428..50f88830 100644 --- a/docs/classrpc_1_1client_1_1client__interface.html +++ b/docs/classrpc_1_1client_1_1client__interface.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
@@ -83,16 +83,43 @@ - - - - + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

template<typename R = void, typename... Args>
R call_func (std::string func_name, Args &&... args)
 Sends an RPC call request to a server, waits for a response, then returns the result. More...
 
+ client_interface (const client_interface &)=delete
 
+ client_interface (client_interface &&) noexcept=default
 
+client_interface & operator= (const client_interface &)=delete
 
+client_interface & operator= (client_interface &&)=delete
 
template<typename R = void, typename... Args>
R call_func (const std::string &func_name, Args &&... args)
 Sends an RPC call request to a server, waits for a response, then returns the result. More...
 
template<typename R = void, typename... Args>
R call_func (std::string &&func_name, Args &&... args)
 Sends an RPC call request to a server, waits for a response, then returns the result. More...
 
+template<typename R , typename... Args>
R call_header_func_impl ([[maybe_unused]] R(*func)(Args...), const std::string &func_name, Args &&... args)
 
+template<typename R , typename... Args>
R call_header_func_impl ([[maybe_unused]] R(*func)(Args...), std::string &&func_name, Args &&... args)
 
+ + + @@ -109,8 +136,8 @@

Member Function Documentation

- -

◆ call_func()

+ +

◆ call_func() [1/2]

@@ -125,7 +152,64 @@

R rpc::client::client_interface< Serial >::call_func

- + + + + + + + + + + + + + + +

Protected Member Functions

virtual void send (const typename Serial::bytes_t &bytes)=0
 Sends serialized data to a server or module. More...
 
virtual void send (typename Serial::bytes_t &&bytes)=0
 Sends serialized data to a server or module. More...
 
virtual Serial::bytes_t receive ()=0
 Receives serialized data from a server or module. More...
 
(std::string const std::string & func_name,
Args &&... args 
)
+ + +inline + + +
+ +

Sends an RPC call request to a server, waits for a response, then returns the result.

+
Template Parameters
+ + + +
RReturn type of the remote function to call
ArgsVariadic argument type(s) of the remote function to call
+
+
+
Parameters
+ + + +
func_nameName of the remote function to call
argsArgument(s) for the remote function
+
+
+
Returns
R Result of the function call, will throw with server's error message if the result does not exist
+ +
+ + +

◆ call_func() [2/2]

+ +
+
+
+template<typename Serial >
+
+template<typename R = void, typename... Args>
+ + + @@ -63,23 +63,20 @@
-
rpc::packed_func< R, Args > Member List
+
rpc::exceptions::rpc_exception Member List
-

This is the complete list of members for rpc::packed_func< R, Args >, including all inherited members.

+

This is the complete list of members for rpc::exceptions::rpc_exception, including all inherited members.

+ + + + + @@ -197,7 +281,7 @@

-

◆ send()

+

◆ send() [1/2]

@@ -230,6 +314,42 @@

+

◆ send() [2/2]

+ +
+
+
+template<typename Serial >
+

R rpc::client::client_interface< Serial >::call_func (std::string &&  func_name,
+ + + + +
+ + + + + + + + +
virtual void rpc::client::client_interface< Serial >::send (typename Serial::bytes_t && bytes)
+ 		+protectedpure virtual
+
+ +

Sends serialized data to a server or module.

+
Parameters
+ + +
bytesSerialized data to be sent
+
+
+
The documentation for this class was generated from the following file:
    diff --git a/docs/classrpc_1_1exceptions_1_1client__receive__error-members.html b/docs/classrpc_1_1exceptions_1_1client__receive__error-members.html new file mode 100644 index 00000000..bf5fdd46 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__receive__error-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    rpc::exceptions::client_receive_error Member List
    +
    +
    + +

    This is the complete list of members for rpc::exceptions::client_receive_error, including all inherited members.

    + + + + + + +
    client_receive_error(const std::string &mesg) noexcept (defined in rpc::exceptions::client_receive_error)rpc::exceptions::client_receive_errorinlineexplicit
    client_receive_error(const char *mesg) noexcept (defined in rpc::exceptions::client_receive_error)rpc::exceptions::client_receive_errorinlineexplicit
    get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
    rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1client__receive__error.html b/docs/classrpc_1_1exceptions_1_1client__receive__error.html new file mode 100644 index 00000000..9f4efac7 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__receive__error.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::client_receive_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    rpc::exceptions::client_receive_error Class Reference
    +
    +
    +
    +Inheritance diagram for rpc::exceptions::client_receive_error:
    +
    +
    Inheritance graph
    + + + + + +
    [legend]
    +
    +Collaboration diagram for rpc::exceptions::client_receive_error:
    +
    +
    Collaboration graph
    + + + + + +
    [legend]
    + + + + + + + + + + + + + +

    +Public Member Functions

    + client_receive_error (const std::string &mesg) noexcept
     
    + client_receive_error (const char *mesg) noexcept
     
    - Public Member Functions inherited from rpc::exceptions::rpc_exception
    + rpc_exception (const std::string &mesg, Type type) noexcept
     
    + rpc_exception (const char *mesg, Type type) noexcept
     
    +Type get_type () const noexcept
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.map b/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.map new file mode 100644 index 00000000..09a08e1f --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.md5 new file mode 100644 index 00000000..ba2f7a6e --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.md5 @@ -0,0 +1 @@ +59cd42c567f4ee8f17763e3ef6a1ddde \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.png b/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.png new file mode 100644 index 00000000..f325722c Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1client__receive__error__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.map new file mode 100644 index 00000000..09a08e1f --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.md5 new file mode 100644 index 00000000..ba2f7a6e --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.md5 @@ -0,0 +1 @@ +59cd42c567f4ee8f17763e3ef6a1ddde \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.png new file mode 100644 index 00000000..f325722c Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1client__receive__error__inherit__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1client__send__error-members.html b/docs/classrpc_1_1exceptions_1_1client__send__error-members.html new file mode 100644 index 00000000..b17b9d2e --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__send__error-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    rpc::exceptions::client_send_error Member List
    +
    +
    + +

    This is the complete list of members for rpc::exceptions::client_send_error, including all inherited members.

    + + + + + + +
    client_send_error(const std::string &mesg) noexcept (defined in rpc::exceptions::client_send_error)rpc::exceptions::client_send_errorinlineexplicit
    client_send_error(const char *mesg) noexcept (defined in rpc::exceptions::client_send_error)rpc::exceptions::client_send_errorinlineexplicit
    get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
    rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1client__send__error.html b/docs/classrpc_1_1exceptions_1_1client__send__error.html new file mode 100644 index 00000000..06b85c83 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__send__error.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::client_send_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    rpc::exceptions::client_send_error Class Reference
    +
    +
    +
    +Inheritance diagram for rpc::exceptions::client_send_error:
    +
    +
    Inheritance graph
    + + + + + +
    [legend]
    +
    +Collaboration diagram for rpc::exceptions::client_send_error:
    +
    +
    Collaboration graph
    + + + + + +
    [legend]
    + + + + + + + + + + + + + +

    +Public Member Functions

    + client_send_error (const std::string &mesg) noexcept
     
    + client_send_error (const char *mesg) noexcept
     
    - Public Member Functions inherited from rpc::exceptions::rpc_exception
    + rpc_exception (const std::string &mesg, Type type) noexcept
     
    + rpc_exception (const char *mesg, Type type) noexcept
     
    +Type get_type () const noexcept
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.map b/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.map new file mode 100644 index 00000000..5df5cfc6 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.md5 new file mode 100644 index 00000000..7df0c83e --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.md5 @@ -0,0 +1 @@ +d3ba3c8d145acc5e4e7b7773d9ca0fee \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.png b/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.png new file mode 100644 index 00000000..152fd8f0 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1client__send__error__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.map new file mode 100644 index 00000000..5df5cfc6 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.md5 new file mode 100644 index 00000000..7df0c83e --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.md5 @@ -0,0 +1 @@ +d3ba3c8d145acc5e4e7b7773d9ca0fee \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.png new file mode 100644 index 00000000..152fd8f0 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1client__send__error__inherit__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1deserialization__error-members.html b/docs/classrpc_1_1exceptions_1_1deserialization__error-members.html new file mode 100644 index 00000000..0fef8599 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1deserialization__error-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    rpc::exceptions::deserialization_error Member List
    +
    +
    + +

    This is the complete list of members for rpc::exceptions::deserialization_error, including all inherited members.

    + + + + + + +
    deserialization_error(const std::string &mesg) noexcept (defined in rpc::exceptions::deserialization_error)rpc::exceptions::deserialization_errorinlineexplicit
    deserialization_error(const char *mesg) noexcept (defined in rpc::exceptions::deserialization_error)rpc::exceptions::deserialization_errorinlineexplicit
    get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
    rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1deserialization__error.html b/docs/classrpc_1_1exceptions_1_1deserialization__error.html new file mode 100644 index 00000000..65bcf0a3 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1deserialization__error.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::deserialization_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    rpc::exceptions::deserialization_error Class Reference
    +
    +
    +
    +Inheritance diagram for rpc::exceptions::deserialization_error:
    +
    +
    Inheritance graph
    + + + + + +
    [legend]
    +
    +Collaboration diagram for rpc::exceptions::deserialization_error:
    +
    +
    Collaboration graph
    + + + + + +
    [legend]
    + + + + + + + + + + + + + +

    +Public Member Functions

    + deserialization_error (const std::string &mesg) noexcept
     
    + deserialization_error (const char *mesg) noexcept
     
    - Public Member Functions inherited from rpc::exceptions::rpc_exception
    + rpc_exception (const std::string &mesg, Type type) noexcept
     
    + rpc_exception (const char *mesg, Type type) noexcept
     
    +Type get_type () const noexcept
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.map b/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.map new file mode 100644 index 00000000..4f3f564a --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.md5 new file mode 100644 index 00000000..ded806a2 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.md5 @@ -0,0 +1 @@ +32d355d9f57a70262256a263fa5cdada \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.png b/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.png new file mode 100644 index 00000000..628b75e7 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1deserialization__error__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.map new file mode 100644 index 00000000..4f3f564a --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.md5 new file mode 100644 index 00000000..ded806a2 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.md5 @@ -0,0 +1 @@ +32d355d9f57a70262256a263fa5cdada \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.png new file mode 100644 index 00000000..628b75e7 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1deserialization__error__inherit__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1function__mismatch-members.html b/docs/classrpc_1_1exceptions_1_1function__mismatch-members.html new file mode 100644 index 00000000..17aafa4f --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__mismatch-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    rpc::exceptions::function_mismatch Member List
    +
    +
    + +

    This is the complete list of members for rpc::exceptions::function_mismatch, including all inherited members.

    + + + + + + +
    function_mismatch(const std::string &mesg) noexcept (defined in rpc::exceptions::function_mismatch)rpc::exceptions::function_mismatchinlineexplicit
    function_mismatch(const char *mesg) noexcept (defined in rpc::exceptions::function_mismatch)rpc::exceptions::function_mismatchinlineexplicit
    get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
    rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1function__mismatch.html b/docs/classrpc_1_1exceptions_1_1function__mismatch.html new file mode 100644 index 00000000..ca0b800a --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__mismatch.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::function_mismatch Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    rpc::exceptions::function_mismatch Class Reference
    +
    +
    +
    +Inheritance diagram for rpc::exceptions::function_mismatch:
    +
    +
    Inheritance graph
    + + + + + +
    [legend]
    +
    +Collaboration diagram for rpc::exceptions::function_mismatch:
    +
    +
    Collaboration graph
    + + + + + +
    [legend]
    + + + + + + + + + + + + + +

    +Public Member Functions

    + function_mismatch (const std::string &mesg) noexcept
     
    + function_mismatch (const char *mesg) noexcept
     
    - Public Member Functions inherited from rpc::exceptions::rpc_exception
    + rpc_exception (const std::string &mesg, Type type) noexcept
     
    + rpc_exception (const char *mesg, Type type) noexcept
     
    +Type get_type () const noexcept
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.map b/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.map new file mode 100644 index 00000000..b7a3f970 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.md5 new file mode 100644 index 00000000..260fa7a3 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.md5 @@ -0,0 +1 @@ +6232da5d8f20c061408c3ff55482865a \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.png b/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.png new file mode 100644 index 00000000..e598b64c Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1function__mismatch__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.map new file mode 100644 index 00000000..b7a3f970 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.md5 new file mode 100644 index 00000000..260fa7a3 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.md5 @@ -0,0 +1 @@ +6232da5d8f20c061408c3ff55482865a \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.png new file mode 100644 index 00000000..e598b64c Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1function__mismatch__inherit__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1function__not__found-members.html b/docs/classrpc_1_1exceptions_1_1function__not__found-members.html new file mode 100644 index 00000000..00cdbeb6 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__not__found-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    rpc::exceptions::function_not_found Member List
    +
    +
    + +

    This is the complete list of members for rpc::exceptions::function_not_found, including all inherited members.

    + + + + + + +
    function_not_found(const std::string &mesg) noexcept (defined in rpc::exceptions::function_not_found)rpc::exceptions::function_not_foundinlineexplicit
    function_not_found(const char *mesg) noexcept (defined in rpc::exceptions::function_not_found)rpc::exceptions::function_not_foundinlineexplicit
    get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
    rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1function__not__found.html b/docs/classrpc_1_1exceptions_1_1function__not__found.html new file mode 100644 index 00000000..f676038c --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__not__found.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::function_not_found Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    rpc::exceptions::function_not_found Class Reference
    +
    +
    +
    +Inheritance diagram for rpc::exceptions::function_not_found:
    +
    +
    Inheritance graph
    + + + + + +
    [legend]
    +
    +Collaboration diagram for rpc::exceptions::function_not_found:
    +
    +
    Collaboration graph
    + + + + + +
    [legend]
    + + + + + + + + + + + + + +

    +Public Member Functions

    + function_not_found (const std::string &mesg) noexcept
     
    + function_not_found (const char *mesg) noexcept
     
    - Public Member Functions inherited from rpc::exceptions::rpc_exception
    + rpc_exception (const std::string &mesg, Type type) noexcept
     
    + rpc_exception (const char *mesg, Type type) noexcept
     
    +Type get_type () const noexcept
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.map b/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.map new file mode 100644 index 00000000..d32088e4 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.md5 new file mode 100644 index 00000000..222075b4 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.md5 @@ -0,0 +1 @@ +3b43ad1c28d14c9f5080d7367ca76ac3 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.png b/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.png new file mode 100644 index 00000000..c2f2dba2 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1function__not__found__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.map new file mode 100644 index 00000000..d32088e4 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.md5 new file mode 100644 index 00000000..222075b4 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.md5 @@ -0,0 +1 @@ +3b43ad1c28d14c9f5080d7367ca76ac3 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.png new file mode 100644 index 00000000..c2f2dba2 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1function__not__found__inherit__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1remote__exec__error-members.html b/docs/classrpc_1_1exceptions_1_1remote__exec__error-members.html new file mode 100644 index 00000000..2e059a99 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1remote__exec__error-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    rpc::exceptions::remote_exec_error Member List
    +
    +
    + +

    This is the complete list of members for rpc::exceptions::remote_exec_error, including all inherited members.

    + + + + + + +
    get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
    remote_exec_error(const std::string &mesg) noexcept (defined in rpc::exceptions::remote_exec_error)rpc::exceptions::remote_exec_errorinlineexplicit
    remote_exec_error(const char *mesg) noexcept (defined in rpc::exceptions::remote_exec_error)rpc::exceptions::remote_exec_errorinlineexplicit
    rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1remote__exec__error.html b/docs/classrpc_1_1exceptions_1_1remote__exec__error.html new file mode 100644 index 00000000..b37598be --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1remote__exec__error.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::remote_exec_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    rpc::exceptions::remote_exec_error Class Reference
    +
    +
    +
    +Inheritance diagram for rpc::exceptions::remote_exec_error:
    +
    +
    Inheritance graph
    + + + + + +
    [legend]
    +
    +Collaboration diagram for rpc::exceptions::remote_exec_error:
    +
    +
    Collaboration graph
    + + + + + +
    [legend]
    + + + + + + + + + + + + + +

    +Public Member Functions

    + remote_exec_error (const std::string &mesg) noexcept
     
    + remote_exec_error (const char *mesg) noexcept
     
    - Public Member Functions inherited from rpc::exceptions::rpc_exception
    + rpc_exception (const std::string &mesg, Type type) noexcept
     
    + rpc_exception (const char *mesg, Type type) noexcept
     
    +Type get_type () const noexcept
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.map b/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.map new file mode 100644 index 00000000..e3e4d98c --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.md5 new file mode 100644 index 00000000..c45afb4d --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.md5 @@ -0,0 +1 @@ +f18a9f4883f3e50a4e72515bf1d56795 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.png b/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.png new file mode 100644 index 00000000..0000c852 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1remote__exec__error__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.map new file mode 100644 index 00000000..e3e4d98c --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.md5 new file mode 100644 index 00000000..c45afb4d --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.md5 @@ -0,0 +1 @@ +f18a9f4883f3e50a4e72515bf1d56795 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.png new file mode 100644 index 00000000..0000c852 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1remote__exec__error__inherit__graph.png differ diff --git a/docs/classrpc_1_1packed__func-members.html b/docs/classrpc_1_1exceptions_1_1rpc__exception-members.html similarity index 57% rename from docs/classrpc_1_1packed__func-members.html rename to docs/classrpc_1_1exceptions_1_1rpc__exception-members.html index c605e4dd..3156e566 100644 --- a/docs/classrpc_1_1packed__func-members.html +++ b/docs/classrpc_1_1exceptions_1_1rpc__exception-members.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
- - - - - - + + +
clear_result() &rpc::packed_func< R, Args >inline
get_result() constrpc::packed_func< R, Args >inline
operator bool() constrpc::packed_func< R, Args >inlineexplicit
packed_func(std::string func_name, std::optional< result_t > result, args_t args)rpc::packed_func< R, Args >inline
result_t typedefrpc::packed_func< R, Args >
set_result(const R &value) &rpc::packed_func< R, Args >inline
get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
diff --git a/docs/classrpc_1_1exceptions_1_1rpc__exception.html b/docs/classrpc_1_1exceptions_1_1rpc__exception.html new file mode 100644 index 00000000..6bf58b39 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1rpc__exception.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::rpc_exception Class Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
rpc::exceptions::rpc_exception Class Reference
+
+
+
+Inheritance diagram for rpc::exceptions::rpc_exception:
+
+
Inheritance graph
+ + + + + + + + + + + + + +
[legend]
+
+Collaboration diagram for rpc::exceptions::rpc_exception:
+
+
Collaboration graph
+ + + + +
[legend]
+ + + + + + + + +

+Public Member Functions

+ rpc_exception (const std::string &mesg, Type type) noexcept
 
+ rpc_exception (const char *mesg, Type type) noexcept
 
+Type get_type () const noexcept
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.map b/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.map new file mode 100644 index 00000000..cfb48769 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.md5 new file mode 100644 index 00000000..ce8798ba --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.md5 @@ -0,0 +1 @@ +2c1b5627eae5eb8f5f362e638ee6bf42 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.png b/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.png new file mode 100644 index 00000000..34ea4356 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1rpc__exception__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.map new file mode 100644 index 00000000..c719d02c --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.md5 new file mode 100644 index 00000000..8f29cbc1 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.md5 @@ -0,0 +1 @@ +0359857a7b2e62c49dfb1d106ac1383d \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.png new file mode 100644 index 00000000..a872a319 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1rpc__exception__inherit__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1serialization__error-members.html b/docs/classrpc_1_1exceptions_1_1serialization__error-members.html new file mode 100644 index 00000000..8b7e69ff --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1serialization__error-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
rpc::exceptions::serialization_error Member List
+
+
+ +

This is the complete list of members for rpc::exceptions::serialization_error, including all inherited members.

+ + + + + + +
get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
serialization_error(const std::string &mesg) noexcept (defined in rpc::exceptions::serialization_error)rpc::exceptions::serialization_errorinlineexplicit
serialization_error(const char *mesg) noexcept (defined in rpc::exceptions::serialization_error)rpc::exceptions::serialization_errorinlineexplicit
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/classrpc_1_1exceptions_1_1serialization__error.html b/docs/classrpc_1_1exceptions_1_1serialization__error.html new file mode 100644 index 00000000..4150b797 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1serialization__error.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::serialization_error Class Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
rpc::exceptions::serialization_error Class Reference
+
+
+
+Inheritance diagram for rpc::exceptions::serialization_error:
+
+
Inheritance graph
+ + + + + +
[legend]
+
+Collaboration diagram for rpc::exceptions::serialization_error:
+
+
Collaboration graph
+ + + + + +
[legend]
+ + + + + + + + + + + + + +

+Public Member Functions

+ serialization_error (const std::string &mesg) noexcept
 
+ serialization_error (const char *mesg) noexcept
 
- Public Member Functions inherited from rpc::exceptions::rpc_exception
+ rpc_exception (const std::string &mesg, Type type) noexcept
 
+ rpc_exception (const char *mesg, Type type) noexcept
 
+Type get_type () const noexcept
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.map b/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.map new file mode 100644 index 00000000..ac64aea4 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.md5 new file mode 100644 index 00000000..c79b6c54 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.md5 @@ -0,0 +1 @@ +4bca6598423711f3748a60159b77dd5a \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.png b/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.png new file mode 100644 index 00000000..d4c44ee9 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1serialization__error__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.map new file mode 100644 index 00000000..ac64aea4 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.md5 new file mode 100644 index 00000000..c79b6c54 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.md5 @@ -0,0 +1 @@ +4bca6598423711f3748a60159b77dd5a \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.png new file mode 100644 index 00000000..d4c44ee9 Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1serialization__error__inherit__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1server__receive__error-members.html b/docs/classrpc_1_1exceptions_1_1server__receive__error-members.html new file mode 100644 index 00000000..33c8bde6 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__receive__error-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
rpc::exceptions::server_receive_error Member List
+
+
+ +

This is the complete list of members for rpc::exceptions::server_receive_error, including all inherited members.

+ + + + + + +
get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
server_receive_error(const std::string &mesg) noexcept (defined in rpc::exceptions::server_receive_error)rpc::exceptions::server_receive_errorinlineexplicit
server_receive_error(const char *mesg) noexcept (defined in rpc::exceptions::server_receive_error)rpc::exceptions::server_receive_errorinlineexplicit
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/classrpc_1_1exceptions_1_1server__receive__error.html b/docs/classrpc_1_1exceptions_1_1server__receive__error.html new file mode 100644 index 00000000..858e3f98 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__receive__error.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::server_receive_error Class Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
rpc::exceptions::server_receive_error Class Reference
+
+
+
+Inheritance diagram for rpc::exceptions::server_receive_error:
+
+
Inheritance graph
+ + + + + +
[legend]
+
+Collaboration diagram for rpc::exceptions::server_receive_error:
+
+
Collaboration graph
+ + + + + +
[legend]
+ + + + + + + + + + + + + +

+Public Member Functions

+ server_receive_error (const std::string &mesg) noexcept
 
+ server_receive_error (const char *mesg) noexcept
 
- Public Member Functions inherited from rpc::exceptions::rpc_exception
+ rpc_exception (const std::string &mesg, Type type) noexcept
 
+ rpc_exception (const char *mesg, Type type) noexcept
 
+Type get_type () const noexcept
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.map b/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.map new file mode 100644 index 00000000..83fb9421 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.md5 new file mode 100644 index 00000000..a42399aa --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.md5 @@ -0,0 +1 @@ +dde9ca3a43949d2966e79a6c8de0c334 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.png b/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.png new file mode 100644 index 00000000..f940c8bc Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1server__receive__error__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.map new file mode 100644 index 00000000..83fb9421 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.md5 new file mode 100644 index 00000000..a42399aa --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.md5 @@ -0,0 +1 @@ +dde9ca3a43949d2966e79a6c8de0c334 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.png new file mode 100644 index 00000000..f940c8bc Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1server__receive__error__inherit__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1server__send__error-members.html b/docs/classrpc_1_1exceptions_1_1server__send__error-members.html new file mode 100644 index 00000000..401b70f4 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__send__error-members.html @@ -0,0 +1,88 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
rpc::exceptions::server_send_error Member List
+
+
+ +

This is the complete list of members for rpc::exceptions::server_send_error, including all inherited members.

+ + + + + + +
get_type() const noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninline
rpc_exception(const std::string &mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
rpc_exception(const char *mesg, Type type) noexcept (defined in rpc::exceptions::rpc_exception)rpc::exceptions::rpc_exceptioninlineexplicit
server_send_error(const std::string &mesg) noexcept (defined in rpc::exceptions::server_send_error)rpc::exceptions::server_send_errorinlineexplicit
server_send_error(const char *mesg) noexcept (defined in rpc::exceptions::server_send_error)rpc::exceptions::server_send_errorinlineexplicit
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/classrpc_1_1exceptions_1_1server__send__error.html b/docs/classrpc_1_1exceptions_1_1server__send__error.html new file mode 100644 index 00000000..a46b8c76 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__send__error.html @@ -0,0 +1,126 @@ + + + + + + + +rpc.hpp: rpc::exceptions::server_send_error Class Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
rpc::exceptions::server_send_error Class Reference
+
+
+
+Inheritance diagram for rpc::exceptions::server_send_error:
+
+
Inheritance graph
+ + + + + +
[legend]
+
+Collaboration diagram for rpc::exceptions::server_send_error:
+
+
Collaboration graph
+ + + + + +
[legend]
+ + + + + + + + + + + + + +

+Public Member Functions

+ server_send_error (const std::string &mesg) noexcept
 
+ server_send_error (const char *mesg) noexcept
 
- Public Member Functions inherited from rpc::exceptions::rpc_exception
+ rpc_exception (const std::string &mesg, Type type) noexcept
 
+ rpc_exception (const char *mesg, Type type) noexcept
 
+Type get_type () const noexcept
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.map b/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.map new file mode 100644 index 00000000..9945d027 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.md5 b/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.md5 new file mode 100644 index 00000000..4c185fd9 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.md5 @@ -0,0 +1 @@ +8b0993be15d1d896fbe7e29d131d5759 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.png b/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.png new file mode 100644 index 00000000..3de9a13d Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1server__send__error__coll__graph.png differ diff --git a/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.map b/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.map new file mode 100644 index 00000000..9945d027 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.md5 b/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.md5 new file mode 100644 index 00000000..4c185fd9 --- /dev/null +++ b/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.md5 @@ -0,0 +1 @@ +8b0993be15d1d896fbe7e29d131d5759 \ No newline at end of file diff --git a/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.png b/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.png new file mode 100644 index 00000000..3de9a13d Binary files /dev/null and b/docs/classrpc_1_1exceptions_1_1server__send__error__inherit__graph.png differ diff --git a/docs/classrpc_1_1pack__adapter-members.html b/docs/classrpc_1_1pack__adapter-members.html index adc56f72..4ca75659 100644 --- a/docs/classrpc_1_1pack__adapter-members.html +++ b/docs/classrpc_1_1pack__adapter-members.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
@@ -74,22 +74,26 @@

This is the complete list of members for rpc::pack_adapter< Serial >, including all inherited members.

- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
deserialize_pack(const typename Serial::serial_t &serial_obj)rpc::pack_adapter< Serial >static
deserialize_pack(const adapters::bjson_val &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
deserialize_pack(const adapters::njson &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
deserialize_pack(const adapters::rapidjson_doc &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
get_func_name(const typename Serial::serial_t &serial_obj)rpc::pack_adapter< Serial >static
get_func_name(const adapters::bjson_val &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
get_func_name(const adapters::njson &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
get_func_name(const adapters::rapidjson_doc &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
serialize_pack(const packed_func< R, Args... > &pack)rpc::pack_adapter< Serial >static
serialize_pack(const packed_func< R, Args... > &pack) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
serialize_pack(const packed_func< R, Args... > &pack) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
serialize_pack(const packed_func< R, Args... > &pack) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
set_err_mesg(typename Serial::serial_t &serial_obj, std::string mesg)rpc::pack_adapter< Serial >static
set_err_mesg(adapters::bjson_val &serial_obj, std::string mesg) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
set_err_mesg(adapters::njson &serial_obj, std::string mesg) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
set_err_mesg(adapters::rapidjson_doc &serial_obj, std::string mesg) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
deserialize_pack(const typename Serial::serial_t &serial_obj)rpc::pack_adapter< Serial >static
deserialize_pack(const adapters::bitsery::bit_buffer &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
deserialize_pack(const adapters::boost_json::value_t &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
deserialize_pack(const adapters::njson::njson_t &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
deserialize_pack(const adapters::rapidjson::doc_t &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
get_func_name(const typename Serial::serial_t &serial_obj)rpc::pack_adapter< Serial >static
get_func_name(const adapters::bitsery::bit_buffer &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
get_func_name(const adapters::boost_json::value_t &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
get_func_name(const adapters::njson::njson_t &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
get_func_name(const adapters::rapidjson::doc_t &serial_obj) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
serialize_pack(const details::packed_func< R, Args... > &pack)rpc::pack_adapter< Serial >static
serialize_pack(const ::rpc::details::packed_func< R, Args... > &pack) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
serialize_pack(const ::rpc::details::packed_func< R, Args... > &pack) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
serialize_pack(const ::rpc::details::packed_func< R, Args... > &pack) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
serialize_pack(const ::rpc::details::packed_func< R, Args... > &pack) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >
set_exception(typename Serial::serial_t &serial_obj, const exceptions::rpc_exception &ex) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >static
set_exception(adapters::bitsery::bit_buffer &serial_obj, const rpc::exceptions::rpc_exception &ex) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
set_exception(adapters::boost_json::value_t &serial_obj, const rpc::exceptions::rpc_exception &ex) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
set_exception(adapters::njson::njson_t &serial_obj, const rpc::exceptions::rpc_exception &ex) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
set_exception(adapters::rapidjson::doc_t &serial_obj, const rpc::exceptions::rpc_exception &ex) (defined in rpc::pack_adapter< Serial >)rpc::pack_adapter< Serial >inline
diff --git a/docs/classrpc_1_1pack__adapter.html b/docs/classrpc_1_1pack__adapter.html index 6123ce7b..ac559499 100644 --- a/docs/classrpc_1_1pack__adapter.html +++ b/docs/classrpc_1_1pack__adapter.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
@@ -76,72 +76,84 @@
-

Class collecting several functions for interoperating between serial objects and a packed_func. +

Class collecting several functions for interoperating between serial objects and a packed_func. More...

#include <rpc.hpp>

- - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

-adapters::bjson_val serialize_pack (const packed_func< R, Args... > &pack)
 
-packed_func< R, Args... > deserialize_pack (const adapters::bjson_val &serial_obj)
 
-std::string get_func_name (const adapters::bjson_val &serial_obj)
 
-void set_err_mesg (adapters::bjson_val &serial_obj, std::string mesg)
 
-adapters::njson serialize_pack (const packed_func< R, Args... > &pack)
 
-packed_func< R, Args... > deserialize_pack (const adapters::njson &serial_obj)
 
-std::string get_func_name (const adapters::njson &serial_obj)
 
-void set_err_mesg (adapters::njson &serial_obj, std::string mesg)
 
-adapters::rapidjson_doc serialize_pack (const packed_func< R, Args... > &pack)
 
-packed_func< R, Args... > deserialize_pack (const adapters::rapidjson_doc &serial_obj)
 
-std::string get_func_name (const adapters::rapidjson_doc &serial_obj)
 
-void set_err_mesg (adapters::rapidjson_doc &serial_obj, std::string mesg)
 
+adapters::bitsery::bit_buffer serialize_pack (const ::rpc::details::packed_func< R, Args... > &pack)
 
+rpc::details::packed_func< R, Args... > deserialize_pack (const adapters::bitsery::bit_buffer &serial_obj)
 
+std::string get_func_name (const adapters::bitsery::bit_buffer &serial_obj)
 
+void set_exception (adapters::bitsery::bit_buffer &serial_obj, const rpc::exceptions::rpc_exception &ex)
 
+adapters::boost_json::value_t serialize_pack (const ::rpc::details::packed_func< R, Args... > &pack)
 
+rpc::details::packed_func< R, Args... > deserialize_pack (const adapters::boost_json::value_t &serial_obj)
 
+std::string get_func_name (const adapters::boost_json::value_t &serial_obj)
 
+void set_exception (adapters::boost_json::value_t &serial_obj, const rpc::exceptions::rpc_exception &ex)
 
+adapters::njson::njson_t serialize_pack (const ::rpc::details::packed_func< R, Args... > &pack)
 
+rpc::details::packed_func< R, Args... > deserialize_pack (const adapters::njson::njson_t &serial_obj)
 
+std::string get_func_name (const adapters::njson::njson_t &serial_obj)
 
+void set_exception (adapters::njson::njson_t &serial_obj, const rpc::exceptions::rpc_exception &ex)
 
+adapters::rapidjson::doc_t serialize_pack (const ::rpc::details::packed_func< R, Args... > &pack)
 
+rpc::details::packed_func< R, Args... > deserialize_pack (const adapters::rapidjson::doc_t &serial_obj)
 
+std::string get_func_name (const adapters::rapidjson::doc_t &serial_obj)
 
+void set_exception (adapters::rapidjson::doc_t &serial_obj, const rpc::exceptions::rpc_exception &ex)
 
- - - - - - - - + + + + + + + + - - - + +

Static Public Member Functions

template<typename R , typename... Args>
static Serial::serial_t serialize_pack (const packed_func< R, Args... > &pack)
 Serializes a packed_func to a serial object. More...
 
template<typename R , typename... Args>
static packed_func< R, Args... > deserialize_pack (const typename Serial::serial_t &serial_obj)
 De-serializes a serial object to a packed_func. More...
 
template<typename R , typename... Args>
static Serial::serial_t serialize_pack (const details::packed_func< R, Args... > &pack)
 Serializes a packed_func to a serial object. More...
 
template<typename R , typename... Args>
static details::packed_func< R, Args... > deserialize_pack (const typename Serial::serial_t &serial_obj)
 De-serializes a serial object to a packed_func. More...
 
static std::string get_func_name (const typename Serial::serial_t &serial_obj)
 Extracts the function name of a serialized function call. More...
 
static void set_err_mesg (typename Serial::serial_t &serial_obj, std::string mesg)
 Sets the error message for the serialized function call. More...
 
+static void set_exception (typename Serial::serial_t &serial_obj, const exceptions::rpc_exception &ex)
 

Detailed Description

template<typename Serial>
class rpc::pack_adapter< Serial >

-

Class collecting several functions for interoperating between serial objects and a packed_func.

+

Class collecting several functions for interoperating between serial objects and a packed_func.

Template Parameters
@@ -149,8 +161,8 @@

Member Function Documentation

- -

◆ deserialize_pack()

+ +

◆ deserialize_pack()

@@ -163,7 +175,7 @@

Serialserial_adapter type that controls how objects are serialized/deserialized
- + @@ -177,11 +189,11 @@

-

De-serializes a serial object to a packed_func.

+

De-serializes a serial object to a packed_func.

Template Parameters

static packed_func<R, Args...> rpc::pack_adapter< Serial >::deserialize_pack static details::packed_func<R, Args...> rpc::pack_adapter< Serial >::deserialize_pack ( const typename Serial::serial_t &  serial_obj)
- - + +
RReturn type of the packed_func
ArgsVariadic argument type(s) of the packed_func
RReturn type of the packed_func
ArgsVariadic argument type(s) of the packed_func
@@ -191,7 +203,7 @@

Returns
packed_func<R, Args...> resulting packed_func
+
Returns
packed_func<R, Args...> resulting packed_func

@@ -232,8 +244,8 @@

-

◆ serialize_pack()

+ +

◆ serialize_pack()

@@ -248,7 +260,7 @@

static Serial::serial_t rpc::pack_adapter< Serial >::serialize_pack ( - const packed_func< R, Args... > &  + const details::packed_func< R, Args... > &  pack) @@ -260,68 +272,21 @@

-

Serializes a packed_func to a serial object.

+

Serializes a packed_func to a serial object.

Template Parameters
- - + +
RReturn type of the packed_func
ArgsVariadic argument type(s) of the packed_func
RReturn type of the packed_func
ArgsVariadic argument type(s) of the packed_func
Parameters
- -
packpacked_func to be serialized
-
-
-
Returns
Serial::serial_t Serial representation of the packed_func
- -

-
- -

◆ set_err_mesg()

- -
-
-
-template<typename Serial >
- - - - - -
- - - - - - - - - - - - - - - - - - -
static void rpc::pack_adapter< Serial >::set_err_mesg (typename Serial::serial_t & serial_obj,
std::string mesg 
)
- 		-static
-
- -

Sets the error message for the serialized function call.

-
Parameters
- - - +
serial_objSerial object to be modified
mesgString to set as the error message
packpacked_func to be serialized
+
Returns
Serial::serial_t Serial representation of the packed_func
diff --git a/docs/classrpc_1_1packed__func.html b/docs/classrpc_1_1packed__func.html deleted file mode 100644 index 42dffb4b..00000000 --- a/docs/classrpc_1_1packed__func.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - -rpc.hpp: rpc::packed_func< R, Args > Class Template Reference - - - - - - - - - -
-
- - - - - - -
-
rpc.hpp -  0.6.1 -
-
Simple RPC Header-Only Library
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Types | -Public Member Functions | -List of all members
-
-
rpc::packed_func< R, Args > Class Template Referencefinal
-
-
- -

Object representing a function call, including the function's name, arguments and result. - More...

- -

#include <rpc.hpp>

-
-Inheritance diagram for rpc::packed_func< R, Args >:
-
-
Inheritance graph
- - - - -
[legend]
-
-Collaboration diagram for rpc::packed_func< R, Args >:
-
-
Collaboration graph
- - - - -
[legend]
- - - - - -

-Public Types

-using result_t = R
 Type alias for the return type.
 
- - - - - - - - - - - - - - - - -

-Public Member Functions

 packed_func (std::string func_name, std::optional< result_t > result, args_t args)
 Constructs a packed_func. More...
 
 operator bool () const
 Indicates if the packed_func holds a return value and no error occurred. More...
 
R get_result () const
 Returns the result, throwing with the error message if it does not exist. More...
 
void set_result (const R &value) &
 Sets the result to a value. More...
 
-void clear_result () &
 Clears the result stored (sets it back to std::nullopt)
 
-

Detailed Description

-

template<typename R, typename... Args>
-class rpc::packed_func< R, Args >

- -

Object representing a function call, including the function's name, arguments and result.

-
Template Parameters
- - - -
RReturn type of the function
ArgsVariadic type(s) of the function's arguments
-
-
-

Constructor & Destructor Documentation

- -

◆ packed_func()

- -
-
-
-template<typename R , typename... Args>
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
rpc::packed_func< R, Args >::packed_func (std::string func_name,
std::optional< result_t > result,
args_t args 
)
- 		-inline
-
- -

Constructs a packed_func.

-
Parameters
- - - - -
func_nameFunction name
resultReturn value of the function (std::nullopt if not called yet or an error occurred)
argsTuple containing the argument(s)
-
-
- -
-
-

Member Function Documentation

- -

◆ get_result()

- -
-
-
-template<typename R , typename... Args>
- - - - - -
- - - - - - - -
R rpc::packed_func< R, Args >::get_result () const
- 		-inline
-
- -

Returns the result, throwing with the error message if it does not exist.

-
Returns
R The result of the function call
- -
-
- -

◆ operator bool()

- -
-
-
-template<typename R , typename... Args>
- - - - - -
- - - - - - - -
rpc::packed_func< R, Args >::operator bool () const
- 		-inlineexplicit
-
- -

Indicates if the packed_func holds a return value and no error occurred.

-
Note
If an error occurred, the reason may be retrieved from the get_err_mesg() function
-
Returns
true A return value exists and no error occurred
-
-false A return value does not exist AND/OR an error occurred
- -
-
- -

◆ set_result()

- -
-
-
-template<typename R , typename... Args>
- - - - - -
- - - - - - - - -
void rpc::packed_func< R, Args >::set_result (const R & value) &
- 		-inline
-
- -

Sets the result to a value.

-
Parameters
- - -
valueThe value to store as the result
-
-
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html b/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html deleted file mode 100644 index 125591ec..00000000 --- a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - - -rpc.hpp: rpc::packed_func< void, Args... > Class Template Reference - - - - - - - - - -
-
- - - - - - -
-
rpc.hpp -  0.6.1 -
-
Simple RPC Header-Only Library
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Types | -Public Member Functions | -List of all members
-
-
rpc::packed_func< void, Args... > Class Template Referencefinal
-
-
- -

Object representing a void returning function call, including the function's name and arguments. - More...

- -

#include <rpc.hpp>

-
-Inheritance diagram for rpc::packed_func< void, Args... >:
-
-
Inheritance graph
- - - - -
[legend]
-
-Collaboration diagram for rpc::packed_func< void, Args... >:
-
-
Collaboration graph
- - - - -
[legend]
- - - - - -

-Public Types

-using result_t = void
 Type alias for the return type (void)
 
- - - - -

-Public Member Functions

 packed_func (std::string func_name, args_t args)
 Constructs a packed_func. More...
 
-

Detailed Description

-

template<typename... Args>
-class rpc::packed_func< void, Args... >

- -

Object representing a void returning function call, including the function's name and arguments.

-
Template Parameters
- - -
ArgsVariadic type(s) of the function's arguments
-
-
-

Constructor & Destructor Documentation

- -

◆ packed_func()

- -
-
-
-template<typename... Args>
- - - - - -
- - - - - - - - - - - - - - - - - - -
rpc::packed_func< void, Args... >::packed_func (std::string func_name,
args_t args 
)
- 		-inline
-
- -

Constructs a packed_func.

-
Parameters
- - - -
func_nameFunction name
argsTuple containing the argument(s)
-
-
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.map b/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.map deleted file mode 100644 index 73b18310..00000000 --- a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.map +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.md5 b/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.md5 deleted file mode 100644 index 1487def5..00000000 --- a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -5b02f101fe3dfc26c955803025c6a174 \ No newline at end of file diff --git a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.png b/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.png deleted file mode 100644 index 8062f3e8..00000000 Binary files a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__coll__graph.png and /dev/null differ diff --git a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.map b/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.map deleted file mode 100644 index 73b18310..00000000 --- a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.map +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.md5 b/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.md5 deleted file mode 100644 index 1487def5..00000000 --- a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -5b02f101fe3dfc26c955803025c6a174 \ No newline at end of file diff --git a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.png b/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.png deleted file mode 100644 index 8062f3e8..00000000 Binary files a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4__inherit__graph.png and /dev/null differ diff --git a/docs/classrpc_1_1packed__func__coll__graph.map b/docs/classrpc_1_1packed__func__coll__graph.map deleted file mode 100644 index 73904174..00000000 --- a/docs/classrpc_1_1packed__func__coll__graph.map +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/docs/classrpc_1_1packed__func__coll__graph.md5 b/docs/classrpc_1_1packed__func__coll__graph.md5 deleted file mode 100644 index ff789dbb..00000000 --- a/docs/classrpc_1_1packed__func__coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -fa7d0564615dd9c5cfd670a6f21879f5 \ No newline at end of file diff --git a/docs/classrpc_1_1packed__func__coll__graph.png b/docs/classrpc_1_1packed__func__coll__graph.png deleted file mode 100644 index 8f850c68..00000000 Binary files a/docs/classrpc_1_1packed__func__coll__graph.png and /dev/null differ diff --git a/docs/classrpc_1_1packed__func__inherit__graph.map b/docs/classrpc_1_1packed__func__inherit__graph.map deleted file mode 100644 index 73904174..00000000 --- a/docs/classrpc_1_1packed__func__inherit__graph.map +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/docs/classrpc_1_1packed__func__inherit__graph.md5 b/docs/classrpc_1_1packed__func__inherit__graph.md5 deleted file mode 100644 index ff789dbb..00000000 --- a/docs/classrpc_1_1packed__func__inherit__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -fa7d0564615dd9c5cfd670a6f21879f5 \ No newline at end of file diff --git a/docs/classrpc_1_1packed__func__inherit__graph.png b/docs/classrpc_1_1packed__func__inherit__graph.png deleted file mode 100644 index 8f850c68..00000000 Binary files a/docs/classrpc_1_1packed__func__inherit__graph.png and /dev/null differ diff --git a/docs/classrpc_1_1server_1_1server__interface-members.html b/docs/classrpc_1_1server_1_1server__interface-members.html index 23d6fe79..8102955b 100644 --- a/docs/classrpc_1_1server_1_1server__interface-members.html +++ b/docs/classrpc_1_1server_1_1server__interface-members.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
@@ -75,12 +75,17 @@

This is the complete list of members for rpc::server::server_interface< Serial >, including all inherited members.

- - - - - - + + + + + + + + + + +
adapter_t typedef (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >
dispatch(typename Serial::bytes_t &bytes)rpc::server::server_interface< Serial >inline
dispatch_cached_func(R(*func)(Args...), typename Serial::serial_t &serial_obj)rpc::server::server_interface< Serial >inlinestatic
dispatch_func(R(*func)(Args...), typename Serial::serial_t &serial_obj)rpc::server::server_interface< Serial >inlinestatic
dispatch_impl(typename Serial::serial_t &serial_obj)=0rpc::server::server_interface< Serial >pure virtual
run_callback(R(*func)(Args...), packed_func< R, Args... > &pack)rpc::server::server_interface< Serial >inlinestatic
~server_interface()=default (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >virtual
clear_all_cache() noexcept (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >inline
dispatch(typename Serial::bytes_t &bytes)rpc::server::server_interface< Serial >inline
dispatch_cached_func(R(*func)(Args...), typename Serial::serial_t &serial_obj)rpc::server::server_interface< Serial >inlineprotected
dispatch_func(R(*func)(Args...), typename Serial::serial_t &serial_obj)rpc::server::server_interface< Serial >inlineprotectedstatic
get_func_cache(const std::string &func_name) (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >inline
operator=(const server_interface &)=delete (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >
operator=(server_interface &&)=delete (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >
server_interface() noexcept=default (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >
server_interface(const server_interface &)=delete (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >
server_interface(server_interface &&) noexcept=default (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >protected
~server_interface() noexcept=default (defined in rpc::server::server_interface< Serial >)rpc::server::server_interface< Serial >virtual
diff --git a/docs/classrpc_1_1server_1_1server__interface.html b/docs/classrpc_1_1server_1_1server__interface.html index b98a0561..f1544986 100644 --- a/docs/classrpc_1_1server_1_1server__interface.html +++ b/docs/classrpc_1_1server_1_1server__interface.html @@ -22,7 +22,7 @@
rpc.hpp -  0.6.1 +  0.7.1
Simple RPC Header-Only Library
@@ -70,7 +70,8 @@
Public Types | Public Member Functions | -Static Public Member Functions | +Protected Member Functions | +Static Protected Member Functions | List of all members
rpc::server::server_interface< Serial > Class Template Referenceabstract
@@ -90,26 +91,41 @@ - - - + + + + + + + + + + +

Public Member Functions

virtual void dispatch_impl (typename Serial::serial_t &serial_obj)=0
 Implementation component for the dispatch function. More...
 
+ server_interface (const server_interface &)=delete
 
+server_interface & operator= (const server_interface &)=delete
 
+server_interface & operator= (server_interface &&)=delete
 
+template<typename Val >
std::unordered_map< typename Serial::bytes_t, Val > & get_func_cache (const std::string &func_name)
 
+void clear_all_cache () noexcept
 
void dispatch (typename Serial::bytes_t &bytes)
 Parses the received serialized data and determines which function to call. More...
 
- - - - - - - - - + + + + + + + +

-Static Public Member Functions

template<typename R , typename... Args>
static void run_callback (R(*func)(Args...), packed_func< R, Args... > &pack)
 Runs the callback function and updates the result (and any changes to mutable arguments) in the packed_func. More...
 
template<typename R , typename... Args>
static void dispatch_cached_func (R(*func)(Args...), typename Serial::serial_t &serial_obj)
 Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object, using a server-side cache for performance. More...
 

+Protected Member Functions

+ server_interface (server_interface &&) noexcept=default
 
template<typename R , typename... Args>
void dispatch_cached_func (R(*func)(Args...), typename Serial::serial_t &serial_obj)
 Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object, using a server-side cache for performance. More...
 
+ - +

+Static Protected Member Functions

template<typename R , typename... Args>
static void dispatch_func (R(*func)(Args...), typename Serial::serial_t &serial_obj)
 Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object. More...
 Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object. More...
 

Detailed Description

@@ -160,8 +176,8 @@

-

◆ dispatch_cached_func()

+ +

◆ dispatch_cached_func()

@@ -174,7 +190,7 @@

- + @@ -193,12 +209,12 @@

-inlinestatic +inlineprotected

static void rpc::server::server_interface< Serial >::dispatch_cached_func void rpc::server::server_interface< Serial >::dispatch_cached_func ( R(*)(Args...)  func,

-

Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object, using a server-side cache for performance.

+

Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object, using a server-side cache for performance.

Note
This feature is enabled by defining RPC_HPP_ENABLE_SERVER_CACHE
Template Parameters
@@ -250,12 +266,12 @@

-inlinestatic +inlinestaticprotected

-

Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object.

+

Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object.

Template Parameters
@@ -271,98 +287,6 @@

-

◆ dispatch_impl()

- -
-
-
-template<typename Serial >
-

RReturn type of the callback function
- - - - -
- - - - - - - - -
virtual void rpc::server::server_interface< Serial >::dispatch_impl (typename Serial::serial_t & serial_obj)
- 		-pure virtual
-
- -

Implementation component for the dispatch function.

-
Parameters
- - -
serial_objSerial object used to represent the function call
-
-
- -
-
- -

◆ run_callback()

- -
-
-
-template<typename Serial >
-
-template<typename R , typename... Args>
- - - - - -
- - - - - - - - - - - - - - - - - - -
static void rpc::server::server_interface< Serial >::run_callback (R(*)(Args...) func,
packed_func< R, Args... > & pack 
)
- 		-inlinestatic
-
- -

Runs the callback function and updates the result (and any changes to mutable arguments) in the packed_func.

-
Template Parameters
- - - -
RReturn type of the callback function
ArgsVariadic argument type(s) for the function
-
-
-
Parameters
- - - -
funcpointer to the callback function
packpacked_func representing the callback
-
-
-
The documentation for this class was generated from the following file:
    diff --git a/docs/dir_0ca40f09774b0c9b36fedfbb476b8248.html b/docs/dir_0ca40f09774b0c9b36fedfbb476b8248.html index 2def2100..899ecd04 100644 --- a/docs/dir_0ca40f09774b0c9b36fedfbb476b8248.html +++ b/docs/dir_0ca40f09774b0c9b36fedfbb476b8248.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -83,6 +83,9 @@ + + + diff --git a/docs/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/dir_d44c64559bbebec7f509842c48db8b23.html index a3780bf1..a266122b 100644 --- a/docs/dir_d44c64559bbebec7f509842c48db8b23.html +++ b/docs/dir_d44c64559bbebec7f509842c48db8b23.html @@ -22,7 +22,7 @@ diff --git a/docs/files.html b/docs/files.html index f8d1df9d..72fa635d 100644 --- a/docs/files.html +++ b/docs/files.html @@ -22,7 +22,7 @@ @@ -71,11 +71,12 @@
    [detail level 123]

    Files

    file  rpc_bitsery.hpp [code]
     Implementation of adapting Bitsery serialization (https://github.com/fraillt/bitsery)
     
    file  rpc_boost_json.hpp [code]
     Implementation of adapting Boost.JSON (https://github.com/boostorg/json)
     
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    - - - - - + + + + + +
     ▼ include
     ▼ rpc_adapters
     rpc_boost_json.hppImplementation of adapting Boost.JSON (https://github.com/boostorg/json)
     rpc_njson.hppImplementation of adapting nlohmann's JSON library (https://github.com/nlohmann/json)
     rpc_rapidjson.hppImplementation of adapting rapidjson (https://github.com/Tencent/rapidjson)
     rpc.hppHeader-only library for serialized RPC usage
     rpc_dispatch_helper.hppHelper macros for server dispatching of remote function calls
     rpc_bitsery.hppImplementation of adapting Bitsery serialization (https://github.com/fraillt/bitsery)
     rpc_boost_json.hppImplementation of adapting Boost.JSON (https://github.com/boostorg/json)
     rpc_njson.hppImplementation of adapting nlohmann's JSON library (https://github.com/nlohmann/json)
     rpc_rapidjson.hppImplementation of adapting rapidjson (https://github.com/Tencent/rapidjson)
     rpc.hppHeader-only library for serialized RPC usage
     rpc_dispatch_helper.hppHelper macros for server dispatching of remote function calls
    diff --git a/docs/functions.html b/docs/functions.html index 93f2d269..7a72d14f 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -65,60 +65,31 @@
    Here is a list of all documented class members with links to the class documentation for each member:
    diff --git a/docs/functions_func.html b/docs/functions_func.html index b202fc59..6d1c985a 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -65,56 +65,31 @@
     
    diff --git a/docs/globals.html b/docs/globals.html index e86b5581..7c783b33 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -64,27 +64,6 @@
    Here is a list of all documented file members with links to the documentation:
    diff --git a/docs/globals_defs.html b/docs/globals_defs.html index 2026d0fa..6e9393a4 100644 --- a/docs/globals_defs.html +++ b/docs/globals_defs.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -64,27 +64,6 @@
     
    diff --git a/docs/graph_legend.html b/docs/graph_legend.html index bc2ce871..80b3b6fa 100644 --- a/docs/graph_legend.html +++ b/docs/graph_legend.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 0adc4b17..23fc4ef9 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -70,15 +70,31 @@

    Go to the graphical class hierarchy

    This inheritance list is sorted roughly, but not completely, alphabetically:
    -
    [detail level 12]
    +
    [detail level 123]
    - - - - - - + + + + + + + + + + + + + + + + + + + + + +
     Crpc::client::client_interface< Serial >Class defining an interface for calling into an RPC server or module
     Crpc::client_interface< Serial >Class defining an interface for calling into an RPC server or module
     Crpc::pack_adapter< Serial >Class collecting several functions for interoperating between serial objects and a packed_func
     ▼Cdetails::packed_func_base
     Crpc::packed_func< R, Args >Object representing a function call, including the function's name, arguments and result
     Crpc::packed_func< void, Args... >Object representing a void returning function call, including the function's name and arguments
     Crpc::server::server_interface< Serial >Class defining an interface for serving functions via RPC
     Crpc::server_interface< Serial >Class defining an interface for serving functions via RPC
     Cstd::hash< std::vector< uint8_t > >
     Crpc::adapters::bitsery::details::largest< T, int >
     Crpc::adapters::bitsery::details::largest< T, 0 >
     Crpc::adapters::bitsery::details::largest< T, 3 >
     Crpc::adapters::bitsery::details::largest< T, 4 >
     Crpc::adapters::bitsery::details::largest< T, 6 >
     Crpc::pack_adapter< Serial >Class collecting several functions for interoperating between serial objects and a packed_func
     Crpc::adapters::bitsery::details::pack_helper< R, Args >
     Crpc::adapters::bitsery::details::pack_helper< void, Args... >
     ▼Cstd::runtime_error
     ▼Crpc::exceptions::rpc_exception
     Crpc::exceptions::client_receive_error
     Crpc::exceptions::client_send_error
     Crpc::exceptions::deserialization_error
     Crpc::exceptions::function_mismatch
     Crpc::exceptions::function_not_found
     Crpc::exceptions::remote_exec_error
     Crpc::exceptions::serialization_error
     Crpc::exceptions::server_receive_error
     Crpc::exceptions::server_send_error
     Crpc::server::server_interface< Serial >Class defining an interface for serving functions via RPC
     Crpc::server_interface< Serial >Class defining an interface for serving functions via RPC
    diff --git a/docs/index.html b/docs/index.html index a5861493..c2b3d54f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -68,36 +68,155 @@

    cmake codecov

    -

    +

    rpc.hpp

    -

    A simple header-only library for supporting remote procedure calls using a variety of extensible features

    -

    +

    A simple header-only library for supporting remote procedure calls using a variety of extensible features.

    +

    +License

    +

    rpc.hpp is licensed under the [BSD 3-Clause License](LICENSE).

    +

    Features

      -
    • Cross-platform
        -
      • Supports every major compiler/operating system
        • +
      • Cross-platform.
          +
        • Supports every major compiler/operating system.
        • -
      • Modern
          -
        • Utilizes features like C++17's constexpr if
          • +
        • Modern.
          • -
        • Type safe support for various types
            -
          • Supports most built-in/STL types out of the box
            • -
          • Can add your own "extensions" to allow serialization and sending of any custom type
            • +
          • Type-safe support for various types.
              +
            • Supports most built-in/STL types out of the box.
              • +
            • Users can create serialization methods for their own custom types.
            • -
          • Easy to use
            • +
          • Easy to use.
            • +
          • Extensible support via "adapters".
              +
            • Currently supported: -

              -Upcoming Features

              -
                -
              • Utilizing C++20's concepts/requires statement will make the library a lot simpler, cleaner, and easy to read.
                • + +
              +
            -

            +

            Documentation

            -

            See Doxygen docs here

            -
    +

    See Doxygen docs here.

    +

    +Basic Example

    +

    For more examples see [examples](examples).

    +

    server.cpp

    +
    {C++}
    +
    #define RPC_HPP_SERVER_IMPL
    +
    +
    #include <rpc_adapters/rpc_njson.hpp>
    +
    #include <rpc_dispatch_helper.hpp>
    +
    +
    #include <string>
    +
    +
    using rpc::adapters::njson;
    +
    using rpc::adapters::njson_adapter;
    +
    +
    int Add(int n1, int n2)
    +
    {
    +
    return n1 + n2;
    +
    }
    +
    +
    void AppendStr(std::string& str, const char* append)
    +
    {
    +
    str.append(append);
    +
    }
    +
    +
    class RpcServer : public rpc::server_interface<njson_adapter>
    +
    {
    +
    public:
    +
    RpcServer(const char* address)
    +
    {
    +
    // initialize server...
    +
    }
    +
    +
    // ...
    +
    +
    void Run()
    +
    {
    +
    std::string data;
    +
    +
    // Get data from client...
    +
    +
    dispatch(data);
    +
    +
    // Send data back to client...
    +
    }
    +
    +
    private:
    +
    void dispatch_impl(njson& serial_obj) override
    +
    {
    +
    RPC_DEFAULT_DISPATCH(Add, AppendStr)
    +
    }
    +
    };
    +
    +
    int main()
    +
    {
    +
    RpcServer my_server{"address"};
    +
    +
    while (true)
    +
    {
    +
    my_server.Run();
    +
    }
    +
    }
    +

    client.cpp

    +
    {C++}
    +
    #define RPC_HPP_CLIENT_IMPL
    +
    +
    #include <rpc_adapters/rpc_njson.hpp>
    +
    +
    #include <cassert>
    +
    #include <string>
    +
    +
    using rpc::adapters::njson_adapter;
    +
    +
    class RpcClient : public rpc::client_interface<njson_adapter>
    +
    {
    +
    public:
    +
    RpcClient(const char* address)
    +
    {
    +
    // initialize client...
    +
    }
    +
    +
    // ...
    +
    +
    private:
    +
    void send(const std::string& mesg) override
    +
    {
    +
    // Send mesg to server...
    +
    }
    +
    +
    void send(std::string&& mesg) override
    +
    {
    +
    // Send mesg to server...
    +
    }
    +
    +
    std::string receive() override
    +
    {
    +
    // Get message back from server...
    +
    }
    +
    };
    +
    +
    int main()
    +
    {
    +
    RpcClient my_client{ "address" };
    +
    +
    const auto result = my_client.template call_func<int>("Sum", 1, 2);
    +
    assert(result == 3);
    +
    +
    std::string str{ "Hello" };
    +
    my_client.call_func("AppendStr", str, " world!");
    +
    assert(str == "Hello world!");
    +
    }
    +
    diff --git a/docs/inherit_graph_0.map b/docs/inherit_graph_0.map index b9f007bd..ba5034f2 100644 --- a/docs/inherit_graph_0.map +++ b/docs/inherit_graph_0.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_0.md5 b/docs/inherit_graph_0.md5 index 38cecb11..04528f07 100644 --- a/docs/inherit_graph_0.md5 +++ b/docs/inherit_graph_0.md5 @@ -1 +1 @@ -b2162d7413880f487e46b9da0d05483f \ No newline at end of file +0dd7c2554708e440207df0a4665ad491 \ No newline at end of file diff --git a/docs/inherit_graph_0.png b/docs/inherit_graph_0.png index 736522f2..0362fcc9 100644 Binary files a/docs/inherit_graph_0.png and b/docs/inherit_graph_0.png differ diff --git a/docs/inherit_graph_1.map b/docs/inherit_graph_1.map index b9f007bd..0cb8e973 100644 --- a/docs/inherit_graph_1.map +++ b/docs/inherit_graph_1.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_1.md5 b/docs/inherit_graph_1.md5 index e4edf8c8..1f9bcd32 100644 --- a/docs/inherit_graph_1.md5 +++ b/docs/inherit_graph_1.md5 @@ -1 +1 @@ -f202e2b51d403af5366ed23426723245 \ No newline at end of file +1c9a8309179350fe0b116b3864d5618e \ No newline at end of file diff --git a/docs/inherit_graph_1.png b/docs/inherit_graph_1.png index 73c00d17..3caed919 100644 Binary files a/docs/inherit_graph_1.png and b/docs/inherit_graph_1.png differ diff --git a/docs/inherit_graph_10.map b/docs/inherit_graph_10.map new file mode 100644 index 00000000..46537ee4 --- /dev/null +++ b/docs/inherit_graph_10.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/inherit_graph_10.md5 b/docs/inherit_graph_10.md5 new file mode 100644 index 00000000..cc41054e --- /dev/null +++ b/docs/inherit_graph_10.md5 @@ -0,0 +1 @@ +59966011ec015855be33c76882688596 \ No newline at end of file diff --git a/docs/inherit_graph_10.png b/docs/inherit_graph_10.png new file mode 100644 index 00000000..befdefc8 Binary files /dev/null and b/docs/inherit_graph_10.png differ diff --git a/docs/inherit_graph_11.map b/docs/inherit_graph_11.map new file mode 100644 index 00000000..c9ec115c --- /dev/null +++ b/docs/inherit_graph_11.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/inherit_graph_11.md5 b/docs/inherit_graph_11.md5 new file mode 100644 index 00000000..0a3a5eff --- /dev/null +++ b/docs/inherit_graph_11.md5 @@ -0,0 +1 @@ +d6b0017eded12ad892c93089f2ef3caa \ No newline at end of file diff --git a/docs/inherit_graph_11.png b/docs/inherit_graph_11.png new file mode 100644 index 00000000..7ef85b60 Binary files /dev/null and b/docs/inherit_graph_11.png differ diff --git a/docs/inherit_graph_12.map b/docs/inherit_graph_12.map new file mode 100644 index 00000000..b82bd973 --- /dev/null +++ b/docs/inherit_graph_12.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/inherit_graph_12.md5 b/docs/inherit_graph_12.md5 new file mode 100644 index 00000000..6d79d3c9 --- /dev/null +++ b/docs/inherit_graph_12.md5 @@ -0,0 +1 @@ +9341470b98e419578c66d42edd6c8a47 \ No newline at end of file diff --git a/docs/inherit_graph_12.png b/docs/inherit_graph_12.png new file mode 100644 index 00000000..07e1e4c9 Binary files /dev/null and b/docs/inherit_graph_12.png differ diff --git a/docs/inherit_graph_13.map b/docs/inherit_graph_13.map new file mode 100644 index 00000000..4a5c1738 --- /dev/null +++ b/docs/inherit_graph_13.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/inherit_graph_13.md5 b/docs/inherit_graph_13.md5 new file mode 100644 index 00000000..9c356b25 --- /dev/null +++ b/docs/inherit_graph_13.md5 @@ -0,0 +1 @@ +32be1b3097611a8aa62b28c64ada573a \ No newline at end of file diff --git a/docs/inherit_graph_13.png b/docs/inherit_graph_13.png new file mode 100644 index 00000000..049e0dc5 Binary files /dev/null and b/docs/inherit_graph_13.png differ diff --git a/docs/inherit_graph_2.map b/docs/inherit_graph_2.map index 46537ee4..961a7ae1 100644 --- a/docs/inherit_graph_2.map +++ b/docs/inherit_graph_2.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_2.md5 b/docs/inherit_graph_2.md5 index cc41054e..a80bdd05 100644 --- a/docs/inherit_graph_2.md5 +++ b/docs/inherit_graph_2.md5 @@ -1 +1 @@ -59966011ec015855be33c76882688596 \ No newline at end of file +4a3a749965ea4a6c45f6338cdf4c595d \ No newline at end of file diff --git a/docs/inherit_graph_2.png b/docs/inherit_graph_2.png index befdefc8..b8e42b1a 100644 Binary files a/docs/inherit_graph_2.png and b/docs/inherit_graph_2.png differ diff --git a/docs/inherit_graph_3.map b/docs/inherit_graph_3.map index 0d687b0b..c60ffff2 100644 --- a/docs/inherit_graph_3.map +++ b/docs/inherit_graph_3.map @@ -1,5 +1,3 @@ - - - + diff --git a/docs/inherit_graph_3.md5 b/docs/inherit_graph_3.md5 index 21164cad..8b9cfc87 100644 --- a/docs/inherit_graph_3.md5 +++ b/docs/inherit_graph_3.md5 @@ -1 +1 @@ -aed4b485b92bcf2a612ed0863f6710da \ No newline at end of file +cc11ca27bdfdb5e94b314d63d6c2513c \ No newline at end of file diff --git a/docs/inherit_graph_3.png b/docs/inherit_graph_3.png index 21527315..fea599d9 100644 Binary files a/docs/inherit_graph_3.png and b/docs/inherit_graph_3.png differ diff --git a/docs/inherit_graph_4.map b/docs/inherit_graph_4.map index c9ec115c..85b78746 100644 --- a/docs/inherit_graph_4.map +++ b/docs/inherit_graph_4.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_4.md5 b/docs/inherit_graph_4.md5 index 0a3a5eff..4054c2b3 100644 --- a/docs/inherit_graph_4.md5 +++ b/docs/inherit_graph_4.md5 @@ -1 +1 @@ -d6b0017eded12ad892c93089f2ef3caa \ No newline at end of file +c83a793381451b30df05c3ced893968b \ No newline at end of file diff --git a/docs/inherit_graph_4.png b/docs/inherit_graph_4.png index 7ef85b60..4fdafe04 100644 Binary files a/docs/inherit_graph_4.png and b/docs/inherit_graph_4.png differ diff --git a/docs/inherit_graph_5.map b/docs/inherit_graph_5.map index b82bd973..72d8cc97 100644 --- a/docs/inherit_graph_5.map +++ b/docs/inherit_graph_5.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_5.md5 b/docs/inherit_graph_5.md5 index 6d79d3c9..daf68f26 100644 --- a/docs/inherit_graph_5.md5 +++ b/docs/inherit_graph_5.md5 @@ -1 +1 @@ -9341470b98e419578c66d42edd6c8a47 \ No newline at end of file +4c199379d956786fb3bace59c708c7ca \ No newline at end of file diff --git a/docs/inherit_graph_5.png b/docs/inherit_graph_5.png index 07e1e4c9..8020a601 100644 Binary files a/docs/inherit_graph_5.png and b/docs/inherit_graph_5.png differ diff --git a/docs/inherit_graph_6.map b/docs/inherit_graph_6.map new file mode 100644 index 00000000..930b546f --- /dev/null +++ b/docs/inherit_graph_6.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/inherit_graph_6.md5 b/docs/inherit_graph_6.md5 new file mode 100644 index 00000000..40477cbb --- /dev/null +++ b/docs/inherit_graph_6.md5 @@ -0,0 +1 @@ +aff3f124beb34c2e17b0ff5ecfd03013 \ No newline at end of file diff --git a/docs/inherit_graph_6.png b/docs/inherit_graph_6.png new file mode 100644 index 00000000..611fabdc Binary files /dev/null and b/docs/inherit_graph_6.png differ diff --git a/docs/inherit_graph_7.map b/docs/inherit_graph_7.map new file mode 100644 index 00000000..b9f007bd --- /dev/null +++ b/docs/inherit_graph_7.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/inherit_graph_7.md5 b/docs/inherit_graph_7.md5 new file mode 100644 index 00000000..38cecb11 --- /dev/null +++ b/docs/inherit_graph_7.md5 @@ -0,0 +1 @@ +b2162d7413880f487e46b9da0d05483f \ No newline at end of file diff --git a/docs/inherit_graph_7.png b/docs/inherit_graph_7.png new file mode 100644 index 00000000..736522f2 Binary files /dev/null and b/docs/inherit_graph_7.png differ diff --git a/docs/inherit_graph_8.map b/docs/inherit_graph_8.map new file mode 100644 index 00000000..b9f007bd --- /dev/null +++ b/docs/inherit_graph_8.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/inherit_graph_8.md5 b/docs/inherit_graph_8.md5 new file mode 100644 index 00000000..e4edf8c8 --- /dev/null +++ b/docs/inherit_graph_8.md5 @@ -0,0 +1 @@ +f202e2b51d403af5366ed23426723245 \ No newline at end of file diff --git a/docs/inherit_graph_8.png b/docs/inherit_graph_8.png new file mode 100644 index 00000000..73c00d17 Binary files /dev/null and b/docs/inherit_graph_8.png differ diff --git a/docs/inherit_graph_9.map b/docs/inherit_graph_9.map new file mode 100644 index 00000000..1ce4b5ea --- /dev/null +++ b/docs/inherit_graph_9.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/inherit_graph_9.md5 b/docs/inherit_graph_9.md5 new file mode 100644 index 00000000..b70f6e0b --- /dev/null +++ b/docs/inherit_graph_9.md5 @@ -0,0 +1 @@ +67cf32d5e0fbe94dadcdd039133ef776 \ No newline at end of file diff --git a/docs/inherit_graph_9.png b/docs/inherit_graph_9.png new file mode 100644 index 00000000..20f58015 Binary files /dev/null and b/docs/inherit_graph_9.png differ diff --git a/docs/inherits.html b/docs/inherits.html index 30d66549..57248354 100644 --- a/docs/inherits.html +++ b/docs/inherits.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -70,38 +70,86 @@

    Go to the textual class hierarchy

    - + + + + + + + - - - - - +
    +
    + + + +
    + + + +
    + + + +
    + + + +
    + + + +
    + + + +
    + + + +
    +
    - - +
    + + + + + + + + + + + +
    - - - - +
    + +
    +
    +
    + + + +
    diff --git a/docs/md__c_o_d_e__o_f__c_o_n_d_u_c_t.html b/docs/md__c_o_d_e__o_f__c_o_n_d_u_c_t.html new file mode 100644 index 00000000..f413ec7b --- /dev/null +++ b/docs/md__c_o_d_e__o_f__c_o_n_d_u_c_t.html @@ -0,0 +1,134 @@ + + + + + + + +rpc.hpp: Contributor Covenant Code of Conduct + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    Contributor Covenant Code of Conduct
    +
    +
    +

    +Our Pledge

    +

    We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

    +

    We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

    +

    +Our Standards

    +

    Examples of behavior that contributes to a positive environment for our community include:

    +
      +
    • Demonstrating empathy and kindness toward other people
      • +
    • Being respectful of differing opinions, viewpoints, and experiences
      • +
    • Giving and gracefully accepting constructive feedback
      • +
    • Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
      • +
    • Focusing on what is best not just for us as individuals, but for the overall community
      • +
    +

    Examples of unacceptable behavior include:

    +
      +
    • The use of sexualized language or imagery, and sexual attention or advances of any kind
      • +
    • Trolling, insulting or derogatory comments, and personal or political attacks
      • +
    • Public or private harassment
      • +
    • Publishing others' private information, such as a physical or email address, without their explicit permission
      • +
    • Other conduct which could reasonably be considered inappropriate in a professional setting
      • +
    +

    +Enforcement Responsibilities

    +

    Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

    +

    Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

    +

    +Scope

    +

    This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

    +

    +Enforcement

    +

    Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jharm.nosp@m.er95.nosp@m.@gmai.nosp@m.l.co.nosp@m.m. All complaints will be reviewed and investigated promptly and fairly.

    +

    All community leaders are obligated to respect the privacy and security of the reporter of any incident.

    +

    +Enforcement Guidelines

    +

    Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

    +

    +1. Correction

    +

    Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

    +

    Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

    +

    +2. Warning

    +

    Community Impact: A violation through a single incident or series of actions.

    +

    Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

    +

    +3. Temporary Ban

    +

    Community Impact: A serious violation of community standards, including sustained inappropriate behavior.

    +

    Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

    +

    +4. Permanent Ban

    +

    Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

    +

    Consequence: A permanent ban from any sort of public interaction within the community.

    +

    +Attribution

    +

    This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

    +

    Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.

    +

    For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

    +
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/md__c_o_n_t_r_i_b_u_t_i_n_g.html b/docs/md__c_o_n_t_r_i_b_u_t_i_n_g.html new file mode 100644 index 00000000..d567dcdc --- /dev/null +++ b/docs/md__c_o_n_t_r_i_b_u_t_i_n_g.html @@ -0,0 +1,361 @@ + + + + + + + +rpc.hpp: How to Contribute + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    How to Contribute
    +
    +
    +

    +Code of Conduct

    +

    This project and everyone participating in it is governed by the rpc.hpp Code of Conduct. By participating, you are expected to uphold this code.\ Please report unacceptable behavior to jharm.nosp@m.er95.nosp@m.@gmai.nosp@m.l.co.nosp@m.m.

    +

    +Reporting an Issue

    +

    You may report an issue from the issues page.

    +

    Before submitting a new issue, please go through the following steps:

    +
      +
    1. Check if you are running the latest version
        +
      • The easiest way to do this is to open the file rcp.hpp on your system
        • +
      • The version number will be in a comment near the top of the file
        • +
      • Compare that to the latest release
        • +
      • If your version is out of date, please update to the newest version before reporting an issue
        • +
      +
      2. +
    2. Perform a search to see if a similar issue has already been opened
        +
      • If your issue is the same, give that issue a :+1:
          +
        • Please don't add additional comments like _"Me too"_ or _"I need this fix"_, a :+1: conveys this much more succinctly and allows for an easy way to visualize the popularity/demand for this issue.
          • +
        +
        • +
      • Even if your issue is not exactly the same, it may be more beneficial to provide some extra context or details for your situation via a comment vs. a new issue.
          +
        • Sometimes it's easier to understand the scope of an issue this way and can allow for one patch to be made instead of multiple
          • +
        +
        • +
      +
      3. +
    +

    Please stick to using one of the provided templates to ensure that issues are consistent.

    +

    +Feature Requests

    +

    Using the Feature Request template, make sure to replace the comments with the indicated content. Hopefully, this can be replaced by GitHub Issue Forms soon.

    +

    An example feature request might look like:

    +
    # Feature Request: Add Support For SomeSerialLibrary
    +
    +
    ## Brief Summary of Request
    +
    <!-- insert a brief summary of your feature request here -->
    +
    Add adapter to support for serialization using
    +
    [SomeSerialLibrary](https://github.com/fake-author/some-serial-lib)
    +
    +
    ## What Is The Value Added With This Feature
    +
    <!-- provide some reasons why you believe this feature is valuable -->
    +
    SomeSerialLibrary is a really powerful serialization library and an adapter for
    +
    it would be of great benefit to the community.
    +
    +
    Some features of the library are:
    +
    +
    - Feature A
    +
    - Feature B
    +
    +
    ## Possible Implementation
    +
    <!-- if you have some ideas on how this can actually be done put them here -->
    +
    - Create an additional header: `rpc_adapters/rpc_some_serial_lib.hpp`
    +
    +
    ## Desired Outcome
    +
    <!-- describe the outcome you'd like to see here as well as provide some
    +
    code/pseudocode to indicate the usage or API of your request -->
    +
    +
    ```C++
    +
    class MyClient : public rpc::client_interface<some_serial_lib_adapter>
    +
    {
    +
    };
    +
    +
    // ...
    +
    +
    auto result = MyClient.call_func("SomeFunc");
    +

    +Other Details

    +
    ### Bug Reports
    +
    +
    Using the Bug Report template, make sure to replace the comments with the indicated content.
    +
    Hopefully, this can be replaced by GitHub Issue Forms soon.
    +
    +
    > **NOTE:** If you believe that an issue is most likely a security concern/vulnerability,
    +
    > **DO NOT** file a bug report.
    +
    >
    +
    > Please see the [security policy](SECURITY.md) on how to report this!
    +
    +
    An example bug report might look like:
    +
    +
    ```markdown
    +
    # Bug Report: rapidjson adapter fails to compile with Clang 12
    +
    +
    ## System Information
    +
    +
    - Platform: x86_64
    +
    - Operating System: Ubuntu 21.10
    +
    - Compiler: clang 12.0.1
    +
    +
    ## Brief Summary of Bug
    +
    <!-- here you can provide a brief summary of the bug -->
    +
    When compiling with Clang 12.0.1, the error:
    +
    "This fake error occurred (rpc_adapters/rpc_rapidjson.hpp:80)" is given.
    +
    +
    - Issue does not exist in gcc.
    +
    +
    ## Steps To Reproduce
    +
    <!-- please list the **exact** steps taken to encounter this bug or the cases
    +
    when it occurs -->
    +
    Using example code, compile with Clang 12 or newer with `-D RPC_HPP_ENABLE_RAPIDJSON`
    +
    +
    ## Areas Of Concern
    +
    <!-- what parts of the project are impacted by this bug, everything? and
    +
    experimental feature? only a few functions? -->
    +
    - Prevents using rapidjson with the newer versions of Clang.
    +
    - Requires switching to gcc or an older version of Clang.
    +
    +
    ## Estimated Severity
    +
    <!-- Please "check" one of the boxes by replacing the blank space in the square
    +
    brackets with an X -->
    +
    +
    - [ ] Pedantic (code-style, design)
    +
    - [ ] Minimal (compiler warnings, legacy support)
    +
    - [ ] Minor (incompatibilities, problems that have easy work-arounds)
    +
    - [X] Major (breaking changes, problems with more advanced work-arounds)
    +
    - [ ] Critical (major security issues, complete failure)
    +
    +
    ## Possible Fixes
    +
    <!-- if you know of a way that could possibly fix this issue, list it here,
    +
    feel free to fork and submit a PR once this bug report is submitted -->
    +

    +Forking the Project

    +

    To make changes to the project, you should first fork the project on GitHub. This makes it easy to work on your own copy of the project without having to worry about creating a lot of branches. You may work on the main branch of your fork, though it is recommended that you create a new branch for each change you are trying to fix, that way, you can keep your copy of main up-to-date with upstream. You may merge this branch back into your main branch prior to submitting a pull request.

    +

    +Contributing Code

    +

    rpc.hpp welcomes code contributions from anyone of any skill level or background.

    +

    Contributors must agree to the code of conduct and additionally, should follow the guidelines provided in this section to ensure their changes are reviewed and accepted.

    +

    +Setting Up Your Build Environment

    +

    Please refer to the Installation Guide for details on getting your build environment set up and compiling the project and its tests.

    +

    +Running Tests

    +

    To build and run the tests, see Running Tests from the Installation Guide.

    +

    NOTE: All tests must pass on CI for a PR to be accepted! These tests will be performed using both GCC and Clang on Ubuntu Linux.

    +

    +Code Conventions

    +

    rpc.hpp aims to maintain a clean, easy to read, and idiomatic codebase. It does this by following best practices such as those provided by:

    + +

    +Code Style

    +

    To simplify keeping a consistent code style, a .clang-format file is provided. Please make sure you have clang-format installed and run it on any changed C++ files (.h, .hpp, .cpp, etc.) before submitting a PR.

    +

    In addition to this, there are a few naming conventions to stick to:

    +

    +Naming Convention

    +

    The naming convention is very similar to that of the C++ standard library:

    +
      +
    • All variables should be meaningfully named unless they are trivial such as:
        +
      • A loop index (i, j, k)
        • +
      • A loop iterator (it, it2, etc.)
        • +
      • A temporary variable being consumed within the next few lines, like for a swap (tmp)
        • +
      • An unrestricted generic template typename (T, U)
        • +
      +
      • +
    • Variables do not need to indicate their type
        +
      • No hungarian notation (no iSomeVar, fSomeVar)
        • +
      • No type prefixes/suffixes (no length_int, string_name)
        • +
      • (Smart) pointers/references may include a ptr_/ref_ prefix when needed for clarity
        • +
      +
      • +
    • All variable/function/parameter/class/struct/namespace/member names should be snake_case with a few exceptions:
        +
      • SCREAMING_SNAKE_CASE:
          +
        • Macros
          • +
        • Global variables
          • +
        • constexpr variables
          • +
        +
        • +
      • CamelCase
          +
        • template parameters
          • +
        +
        • +
      +
      • +
    • private/protected non-static member variables should have a m_ prefix
      • +
    • private/protected static member variables should have a s_ prefix
      • +
    • Type aliases should have a _t suffix
      • +
    • Boolean variables and boolean-returning functions should indicate what they are testing, (ex. is_full, has_value(), was_used)
        +
      • Booleans should only be named in the affirmative (no is_not_empty, no_value)
        • +
      +
      • +
    +

    +Documentation Comments

    +

    All public variables, functions, namespaces, and types must be documented using a Doxygen comment, where "public" means anything in the rpc namespace and its child namespaces, excluding things in the details namespace and private/protected members of classes/structs.

    +

    The comment follows the Doxygen spec, using the /// style of comment.

    +

    An example comment would look like:

    +
    {C++}
    +
    ///@brief Calculates the length of a given string.
    +
    ///
    +
    /// Iterates through the string until a null character ('\0') is found.
    +
    ///@param str The string to find the length of.
    +
    ///@return size_t The length of the string.
    +
    size_t GetStrLen(const char* str);
    +

    If documentation comments are added/changed/removed, the Doxygen docs should be re-generated. See Generating Doxygen Docs below for more information.

    +

    +Contributing Documentation

    +

    Documentation exists in two forms:

    +
      +
    • In-code documentation via Doxygen
      • +
    • External Markdown documents
      • +
    +

    Both of these forms of documentation are important to ensure users and developers have an easy time working with the library and therefore should stay as clean and up-to-date as possible.

    +

    +Generating Doxygen Docs

    +

    If the documentation comments have been altered, a new set of Doxygen docs should be generated.

    +

    You will need to make sure that the following components are installed on your machine:

    +
      +
    • doxygen
      • +
    • graphviz
      • +
    • dot
      • +
    +

    NOTE: On some platforms, dot is installed as part of the doxygen package, and is not provided separately. If you have doxygen installed, it is usually safe to assume that dot is also installed.

    +

    Once you have these tools installed you may proceed with the documentation generation:

    +
      +
    • First, empty the docs directory found under the project root directory.
      • +
    • Then, configure the CMake project such that GENERATE_DOXYGEN and all of the adapters are turned on.
        +
      • You may turn off all other options.
        • +
      +
      • +
    • Next, run the command cmake --build build --target docs to generate the new documentation and populate the docs directory
      • +
    • Make sure to commit the changes to docs
      • +
    +

    +Committing Changes

    +

    When creating git commits, there are a few guidelines you should keep in mind:

    +
      +
    • To the best of your ability, try to address only one issue or add only one feature per commit.
        +
      • For example, a single commit should not "Fix bug #1234 and add cool new feature".
        • +
      +
      • +
    • When writing commit messages, use the present-tense and imperative mood to describe the change(s).
        +
      • A good way to think about this is: if you added "This commit will" before your message, it would be accurate and form a proper sentence.
        • +
      • i.e. "Add logging" not "Adds logging" or "Added logging".
        • +
      +
      • +
    • Specific issues may be referenced by their number, ex: "... fixes #123".
        +
      • When possible, please use a more detailed description of the issue or feature in the commit, you may refer to the issue number later, in the body of the message. This will make it easier to find where a specific change was made without having to reference the closed issue.
        • +
      +
      • +
    • If a commit message can not fit in a single, 50 character sentence, it should be broken up into multiple lines with the following format:
      • +
    +
    50 character or less summary
    +
    +
    Separated by an empty line, detailed description of the changes made as
    +
    necessary, with lines limited to 72 characters.
    +
    +
    * Bullet points
    +
    * Are
    +
    * Acceptable
    +

    +Submitting Pull Requests

    +

    To submit a pull request, make sure you are making your changes on a fork of the project. See Forking the Project for more details. Once you have finalized your changes, you may submit a pull request against your fork.

    +

    Please make sure to provide adequate comments describing the changes made and the reasoning behind those changes. It really helps to have good commit messages.

    +

    Also make sure to reference any issues that these changes may address (i.e. closes #123).

    +

    If you know there are breaking or backwards-incompatible changes, **_please_** indicate this in the pull request comments and by tagging the PR with the potentially-breaking label.

    +

    +Acceptance Criteria

    +

    A few basic requirements will need to be made before any PR is accepted:

    +
      +
    • All automated CI checks complete successfully
      • +
    • All new/modified source code files must be formatted with clang-format
      • +
    • If there are any changes to documentation comments, new documentation must be generated
        +
      • If new public functions/variables/types/namespaces are added, they must have documentation comments
        • +
      +
      • +
    • Example code must compile
      • +
    • If the API changes, external documentation must be updated
      • +
    • No new warnings may occur (must build with -Werror)
      • +
    +

    If all these conditions are met, the code will be reviewed. Once the code has been reviewed on of the following may occur:

    +
      +
    • :heavy_check_mark: The merge will be accepted, a new version will be generated, and you will be notified.
        +
      • You may delete your fork/development branch at this time if you like.
        • +
      • You will probably want to update your fork to pull in the changes from upstream.
        • +
      +
      • +
    • :warning: The merge will require some additional work or discussion, with constructive comments provided.
        +
      • After receiving the notification, you can make the necessary alterations and push those changes. to your fork. You will not need to submit a new PR, the push will update the existing PR automatically.
        • +
      • Once these new changes are received the review process will start over.
        • +
      +
      • +
    • :x: The merge will be rejected with a detailed reason as to why.
      • +
    +
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/md__i_n_s_t_a_l_l.html b/docs/md__i_n_s_t_a_l_l.html new file mode 100644 index 00000000..1c917928 --- /dev/null +++ b/docs/md__i_n_s_t_a_l_l.html @@ -0,0 +1,258 @@ + + + + + + + +rpc.hpp: Installation Guide + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    Installation Guide
    +
    +
    +

    +Header Installation

    +

    As rpc.hpp is a header-only library, you only need to install the header files to your system.

    +

    This can be done by cloning the project's main branch or downloading it as an archive from GitHub. Once you have the files, you may copy the contents of the include directory to your system or user's include path, or to the relevant place in your project's directory.

    +

    +Installing With CMake

    +

    You may also install the headers by cloning the repository and running the following commands:

    +
    $ mkdir build
    +
    $ cmake -B build -D BUILD_ADAPTER_BOOST_JSON=ON -D BUILD_ADAPTER_NJSON=ON -D BUILD_ADAPTER_RAPIDJSON=ON
    +
    $ cmake --install build
    +

    CMake version 3.16 or newer is required for this method, see below for instructions to install CMake if it is not already installed.

    +

    +Building and Testing the Project

    +

    If you are looking to contribute to rpc.hpp, or just want to run the tests/benchmarks, you will need to make sure that you can build the project and its test suite.

    +

    +Setting Up Your Environment

    +

    While rpc.hpp is a header-only library, the project relies on using a buildsystem to perform certain tasks. It is therefore required that CMake (version 3.16 or newer) is installed on your machine and available on your $PATH to build the project.

    +

    Additionally, rpc.hpp requires at least one C++ compiler that fully supports C++17 or newer:

    +

    Linux/macOS/BSD

    +
      +
    • gcc >= 7
      • +
    • clang >= 5
      • +
    +

    Windows

    +
      +
    • MSVC (cl.exe) >= 19.14 (Visual Studio 2017 15.7 or newer)
      • +
    +

    On Windows you will have to install Visual Studio 2017 or newer. You may install the full IDE with the C++ "Workload" selected or simply install the standalone build tools instead.

    +

    These development dependencies can be installed in the following ways, depending on your operating system (replace gcc w/ clang if desired):

    +

    Arch / Manjaro

    +
    $ sudo pacman -S gcc cmake ninja
    +

    CentOS 7 / RHEL 7

    +
    $ sudo dnf install devtoolset-10-gcc cmake ninja-build
    +

    CentOS 8+ / Fedora 33+ / RHEL 8+

    +
    $ sudo dnf install gcc cmake ninja-build
    +

    Debian 10+ / PopOS/Ubuntu 18.04+

    +
    $ sudo apt install gcc cmake ninja-build
    +

    FreeBSD 12+

    +
    # pkg install cmake ninja
    +

    OpenSUSE / SLES

    +
    $ sudo zypper install gcc cmake ninja
    +

    Windows - Chocolatey

    +
    > choco install cmake ninja
    +

    Windows - Scoop

    +
    > scoop install cmake ninja
    +

    +Library Dependencies

    +

    While not strictly required, the adapter headers are considered a core part of the library and therefore should build without issue after any code change, and should be tested.

    +

    (NOTE: if the community ends up creating a lot of adapters, this may change)

    +
    +

    The libraries needed to build the current adapters are:

    + +

    For building the unit tests, there are additional libraries required:

    + +

    Building the benchmarks also requires one library:

    + +

    These dependencies can be installed in one of three ways:

    +
      +
    1. Installing manually from source, binary, or system package manager
      2. +
    2. Install via vcpkg
      3. +
    3. Auto-install via Conan
      4. +
    +

    +Setting up <tt>vcpkg</tt>

    +
      +
    1. In a terminal, navigate to the location where vcpkg should be installed ($HOME is fine for most)
      2. +
    2. Clone the vcpkg project and enter the source directory
      3. +
    +
    $ git clone https://github.com/Microsoft/vcpkg
    +
    $ cd vcpkg
    +
      +
    1. "Bootstrap" vcpkg
      2. +
    +

    Linux/macOS/BSD

    +
    $ ./bootstrap-vcpkg.sh
    +

    Windows

    +
    > .\bootstrap-vcpkg.bat
    +
      +
    1. Add vcpkg to your path (optional)
      2. +
    2. Integrate your vcpkg installation into CMake/Visual Studio
      3. +
    +
    $ vcpkg integrate install
    +
      +
    1. Install dependencies
      2. +
    +
    $ vcpkg install catch2 doctest nlohmann-json rapidjson boost-json
    +

    +Setting up Conan

    +
      +
    1. Make sure you have Python 3 and pip installed.
        +
      • It is recommended to install and use pipx rather than pip for installing applications like Conan, however
        • +
      +
      2. +
    2. Install Conan
        +
      • With pipx (preferred)
        • +
      +
      3. +
    +
    $ pipx install conan
    +
      +
    • With pip
      • +
    +
    $ pip install --user conan
    +

    +Building the Project

    +
      +
    1. Enter the top-level directory of the project
      2. +
    2. Create the build directory
      3. +
    +
    $ mkdir build
    +
      +
    1. Configure the project
      2. +
    +
    $ cmake -B build -G Ninja -D BUILD_ADAPTER_BITSERY -D BUILD_ADAPTER_BOOST_JSON=ON -D BUILD_ADAPTER_NJSON=ON -D BUILD_ADAPTER_RAPIDJSON=ON -D BUILD_TESTING=ON
    +

    NOTE: The above command can be altered based on your needs:

    +
      +
    • In this example, the "Ninja" generator is used as it is fast, but -G Ninja may be omitted to use the system default make system
      • +
    • With this example, all adapters are to be built. By omitting one or more, they will not be built (example: -D BUILD_ADAPTER_BOOST_JSON=ON could be omitted or set to =OFF)
        +
      • NOTE: BUILD_ADAPTER_NJSON is required for testing
        • +
      +
      • +
    • If using Conan to auto-install dependencies, make sure to set its option (add -D DEPENDS_CONAN=ON)
      • +
    • If using vcpkg to manage dependencies, make sure to set its option (add -D DEPENDS_VCPKG=ON)
        +
      • You may also need to provide CMake with a vcpkg toolchain file: (-D CMAKE_TOOLCHAIN_FILE="/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake")
        • +
      +
      • +
    • See Build Options for more details on these and other configuration options
      • +
    +
      +
    1. Build the project
      2. +
    +
    $ cmake --build build
    +

    +Build Options

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Option Description
    BUILD_ADAPTER_BITSERY Build the adapter for Bitsery
    BUILD_ADAPTER_BOOST_JSON Build the adapter for Boost.JSON
    BUILD_ADAPTER_NJSON Build the adapter for nlohmann/json
    BUILD_ADAPTER_RAPIDJSON Build the adapter for rapidjson
    BUILD_BENCHMARK Build the benchmarking suite
    BUILD_EXAMPLES Build the examples
    BUILD_TESTING Build the testing tree
    CODE_COVERAGE Enable coverage reporting
    DEPENDS_CONAN Use Conan to manage C/C++ dependencies
    DEPENDS_VCPKG User vcpkg to manage C/C++ dependencies
    GENERATE_DOXYGEN Generate Doxygen documentation from comments
    +

    NOTE:

    +
      +
    • Only one or neither of DEPENDS_CONAN and DEPENDS_VCPKG may be defined
      • +
    • BUILD_BENCHMARK requires BUILD_TESTING
      • +
    • GENERATE_DOXYGEN and CODE_COVERAGE should only be defined when doing a documentation or coverage build, respectively
      • +
    +

    +Running Tests

    +

    To build the tests, make sure your build environment is set up. Also make sure that the BUILD_TESTING option is set in your CMakeCache.txt.

    +

    NOTE: The test server will have to be running for the tests to succeed. You could run it in a separate terminal session, or add tests/test_server & at the beginning of the ctest command below. The tests will successfully kill the serer on completion.

    +

    From the project build directory run:

    +
    $ ctest --test-dir tests
    +
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/md__s_e_c_u_r_i_t_y.html b/docs/md__s_e_c_u_r_i_t_y.html new file mode 100644 index 00000000..f6ba9b19 --- /dev/null +++ b/docs/md__s_e_c_u_r_i_t_y.html @@ -0,0 +1,108 @@ + + + + + + + +rpc.hpp: rpc.hpp Security Policy + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    rpc.hpp Security Policy
    +
    +
    +

    This policy describes the ways in which security vulnerabilities may be reported.

    +

    Please keep in mind:

    +
      +
    • Security vulnerabilities of a particular client/server implementation are not covered. This is up to the author(s) of that implementation.
      • +
    • Likewise, vulnerabilities of serialization libraries are not covered, though the adapters provided for them are.
      • +
    • The examples, tests, and benchmarks for this library are also not covered. These tests and examples are not designed for production use.
      • +
    +

    +Supported Versions

    + + + + + + + + + +
    Version Supported
    1.0.x :white_check_mark:
    < 1.0 :x:
    X.X-beta.X :x:
    +

    +Reporting a Vulnerability

    +

    Please report vulnerabilities directly to jharm.nosp@m.er95.nosp@m.@gmai.nosp@m.l.co.nosp@m.m using the following format:

    +
      +
    • Put "RPC.HPP SECURITY VULNERABILITY: <brief_description_of_issue>" as the subject of the email.
      • +
    • In the body, put as detailed a description as you can, including the steps to reproduce and the version(s) affected.
      • +
    • If your preferred method of contact is NOT the email address you used to send the report, please also provide that in the body as well.
      • +
    • Please also indicate if you know the fix and, if possible, attach an updated archive or patch file(s) with these changes.
      • +
    +

    You will be contacted with updates regarding this vulnerability as it is received, addressed, dismissed, or fixed in production.

    +

    In the meantime, please avoid disclosing this to the public or creating a bug report/pull request. You may be asked for additional details or modifications.

    +

    If you are providing a fix, you will be contacted to create a pull request to merge the change into production. If you do not wish to be involved in this process or would like to remain anonymous, please indicate that in the correspondence.

    +
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/menudata.js b/docs/menudata.js index 7311ac3d..6ae99a61 100644 --- a/docs/menudata.js +++ b/docs/menudata.js @@ -24,6 +24,7 @@ */ var menudata={children:[ {text:"Main Page",url:"index.html"}, +{text:"Related Pages",url:"pages.html"}, {text:"Namespaces",url:"namespaces.html",children:[ {text:"Namespace List",url:"namespaces.html"}]}, {text:"Classes",url:"annotated.html",children:[ @@ -32,8 +33,7 @@ var menudata={children:[ {text:"Class Hierarchy",url:"inherits.html"}, {text:"Class Members",url:"functions.html",children:[ {text:"All",url:"functions.html"}, -{text:"Functions",url:"functions_func.html"}, -{text:"Typedefs",url:"functions_type.html"}]}]}, +{text:"Functions",url:"functions_func.html"}]}]}, {text:"Files",url:"files.html",children:[ {text:"File List",url:"files.html"}, {text:"File Members",url:"globals.html",children:[ diff --git a/docs/namespacerpc.html b/docs/namespacerpc.html index 3db621c7..b7995d37 100644 --- a/docs/namespacerpc.html +++ b/docs/namespacerpc.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -88,14 +88,8 @@ - - - - - - - + diff --git a/docs/namespacerpc_1_1client.html b/docs/namespacerpc_1_1client.html index db7a383a..2ca4e32c 100644 --- a/docs/namespacerpc_1_1client.html +++ b/docs/namespacerpc_1_1client.html @@ -22,7 +22,7 @@ diff --git a/docs/namespacerpc_1_1details.html b/docs/namespacerpc_1_1details.html index bd68c3a2..5ce2d15c 100644 --- a/docs/namespacerpc_1_1details.html +++ b/docs/namespacerpc_1_1details.html @@ -22,7 +22,7 @@ diff --git a/docs/namespacerpc_1_1server.html b/docs/namespacerpc_1_1server.html index b1f0dac0..24215f8e 100644 --- a/docs/namespacerpc_1_1server.html +++ b/docs/namespacerpc_1_1server.html @@ -22,7 +22,7 @@ diff --git a/docs/namespaces.html b/docs/namespaces.html index 73fa4341..611e5ab1 100644 --- a/docs/namespaces.html +++ b/docs/namespaces.html @@ -22,7 +22,7 @@ @@ -68,19 +68,43 @@
    Here is a list of all documented namespaces with brief descriptions:
    -
    [detail level 123]

    Classes

    class  packed_func
     Object representing a function call, including the function's name, arguments and result. More...
     
    class  packed_func< void, Args... >
     Object representing a void returning function call, including the function's name and arguments. More...
     
    class  pack_adapter
     Class collecting several functions for interoperating between serial objects and a packed_func. More...
     Class collecting several functions for interoperating between serial objects and a packed_func. More...
     
    class  server_interface
     Class defining an interface for serving functions via RPC. More...
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    +
    [detail level 12345]
    - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     ▼NrpcTop-level namespace for rpc.hpp classes and functions
     Nadapters
     ▼NclientNamespace containing functions and classes only relevant to "client-side" implentations
     Cclient_interfaceClass defining an interface for calling into an RPC server or module
     NdetailsNamespace for implementation details, should not be used outside of the library
     ▼NserverNamespace containing functions and classes only relevant to "server-side" implentations
     Cserver_interfaceClass defining an interface for serving functions via RPC
     Cpacked_funcObject representing a function call, including the function's name, arguments and result
     Cpacked_func< void, Args... >Object representing a void returning function call, including the function's name and arguments
     Cpack_adapterClass collecting several functions for interoperating between serial objects and a packed_func
     Cserver_interfaceClass defining an interface for serving functions via RPC
     Cclient_interfaceClass defining an interface for calling into an RPC server or module
     ▼Nadapters
     ▼Nbitsery
     Nconfig
     ▼Ndetails
     Clargest
     Clargest< T, 0 >
     Clargest< T, 3 >
     Clargest< T, 4 >
     Clargest< T, 6 >
     Cpack_helper
     Cpack_helper< void, Args... >
     Nboost_json
     Nnjson
     Nrapidjson
     ▼NclientNamespace containing functions and classes only relevant to "client-side" implentations
     Cclient_interfaceClass defining an interface for calling into an RPC server or module
     NdetailsNamespace for implementation details, should not be used outside of the library
     ▼Nexceptions
     Crpc_exception
     Cfunction_not_found
     Cremote_exec_error
     Cserialization_error
     Cdeserialization_error
     Cfunction_mismatch
     Cclient_send_error
     Cclient_receive_error
     Cserver_send_error
     Cserver_receive_error
     ▼NserverNamespace containing functions and classes only relevant to "server-side" implentations
     Cserver_interfaceClass defining an interface for serving functions via RPC
     Cpack_adapterClass collecting several functions for interoperating between serial objects and a packed_func
     Cserver_interfaceClass defining an interface for serving functions via RPC
     Cclient_interfaceClass defining an interface for calling into an RPC server or module
     ▼Nstd
     Chash< std::vector< uint8_t > >
    diff --git a/docs/pages.html b/docs/pages.html new file mode 100644 index 00000000..8b392810 --- /dev/null +++ b/docs/pages.html @@ -0,0 +1,84 @@ + + + + + + + +rpc.hpp: Related Pages + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    Related Pages
    +
    +
    +
    Here is a list of all related documentation pages:
    + + + + + +
     Contributor Covenant Code of Conduct
     How to Contribute
     Installation Guide
     rpc.hpp Security Policy
    +
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/rpc_8hpp.html b/docs/rpc_8hpp.html index ee8c83aa..5a946bd0 100644 --- a/docs/rpc_8hpp.html +++ b/docs/rpc_8hpp.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -70,7 +70,8 @@
    Classes | Namespaces | -Macros
    +Macros | +Enumerations
    rpc.hpp File Reference
    @@ -78,7 +79,8 @@

    Header-only library for serialized RPC usage. More...

    -
    #include <cstddef>
    +
    #include <cassert>
    +#include <cstddef>
    #include <optional>
    #include <stdexcept>
    #include <string>
    @@ -91,15 +93,16 @@
    - - - - - - - - - + + + + + + + + + +
    @@ -107,10 +110,11 @@
    - - - - + + + + +
    @@ -118,14 +122,28 @@ - - + - - + + + + + + + + + + + + + + + + + - + @@ -167,11 +185,39 @@ #define  + + + + + + +

    Classes

    class  rpc::packed_func< R, Args >
     Object representing a function call, including the function's name, arguments and result. More...
    class  rpc::exceptions::rpc_exception
     
    class  rpc::packed_func< void, Args... >
     Object representing a void returning function call, including the function's name and arguments. More...
    class  rpc::exceptions::function_not_found
     
    class  rpc::exceptions::remote_exec_error
     
    class  rpc::exceptions::serialization_error
     
    class  rpc::exceptions::deserialization_error
     
    class  rpc::exceptions::function_mismatch
     
    class  rpc::exceptions::client_send_error
     
    class  rpc::exceptions::client_receive_error
     
    class  rpc::exceptions::server_send_error
     
    class  rpc::exceptions::server_receive_error
     
    class  rpc::pack_adapter< Serial >
     Class collecting several functions for interoperating between serial objects and a packed_func. More...
     Class collecting several functions for interoperating between serial objects and a packed_func. More...
     
    class  rpc::server::server_interface< Serial >
     Class defining an interface for serving functions via RPC. More...
    RPC_HPP_SERVER_IMPL
     Indicates that rpc.hpp is being consumed by a server translation unit.
     
    +#define RPC_HPP_PRECONDITION(EXPR)   assert(EXPR)
     
    +#define RPC_HPP_POSTCONDITION(EXPR)   assert(EXPR)
     
    +#define call_header_func(FUNCNAME, ...)   call_header_func_impl(FUNCNAME, # FUNCNAME, __VA_ARGS__)
     
    + + +

    +Enumerations

    enum class  Type {
    +  None +, FuncNotFound +, RemoteExec +, Serialization +,
    +  DeSerialization +, SignatureMismatch +, ClientSend +, ClientReceive +,
    +  ServerSend +, ServerReceive +
    + }
     

    Detailed Description

    Header-only library for serialized RPC usage.

    Author
    Jackson Harmer (jharm.nosp@m.er95.nosp@m.@gmai.nosp@m.l.co.nosp@m.m)
    -
    Version
    0.6.1
    +
    Version
    0.7.1
    Copyright
    BSD 3-Clause License

    Copyright (c) 2020-2021, Jackson Harmer All rights reserved.

    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    diff --git a/docs/rpc_8hpp__dep__incl.map b/docs/rpc_8hpp__dep__incl.map index 1e4d36d4..7dbc9ed4 100644 --- a/docs/rpc_8hpp__dep__incl.map +++ b/docs/rpc_8hpp__dep__incl.map @@ -1,6 +1,7 @@ - - - - + + + + + diff --git a/docs/rpc_8hpp__dep__incl.md5 b/docs/rpc_8hpp__dep__incl.md5 index 8ca5c237..667f6205 100644 --- a/docs/rpc_8hpp__dep__incl.md5 +++ b/docs/rpc_8hpp__dep__incl.md5 @@ -1 +1 @@ -e25d24605fe77fb95b5c8790a3abe32d \ No newline at end of file +53b513d7589127c325618eba31c0c714 \ No newline at end of file diff --git a/docs/rpc_8hpp__dep__incl.png b/docs/rpc_8hpp__dep__incl.png index 50242343..6133298a 100644 Binary files a/docs/rpc_8hpp__dep__incl.png and b/docs/rpc_8hpp__dep__incl.png differ diff --git a/docs/rpc_8hpp__incl.map b/docs/rpc_8hpp__incl.map index a7e5c4fe..d739cc3f 100644 --- a/docs/rpc_8hpp__incl.map +++ b/docs/rpc_8hpp__incl.map @@ -1,11 +1,12 @@ - - - - - - - - - + + + + + + + + + + diff --git a/docs/rpc_8hpp__incl.md5 b/docs/rpc_8hpp__incl.md5 index 618b582d..64610901 100644 --- a/docs/rpc_8hpp__incl.md5 +++ b/docs/rpc_8hpp__incl.md5 @@ -1 +1 @@ -783332501a733c1c57f781285f3272f0 \ No newline at end of file +44b1a519eea4b556c187093e9939d312 \ No newline at end of file diff --git a/docs/rpc_8hpp__incl.png b/docs/rpc_8hpp__incl.png index 527b6922..67b20686 100644 Binary files a/docs/rpc_8hpp__incl.png and b/docs/rpc_8hpp__incl.png differ diff --git a/docs/rpc_8hpp_source.html b/docs/rpc_8hpp_source.html index 4b50924b..06b57363 100644 --- a/docs/rpc_8hpp_source.html +++ b/docs/rpc_8hpp_source.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -85,475 +85,997 @@
    52 # error At least one implementation type must be defined using 'RPC_HPP_{CLIENT, SERVER, MODULE}_IMPL'
    53 #endif
    54 
    -
    55 #include <cstddef> // for size_t
    -
    56 #include <optional> // for nullopt, optional
    -
    57 #include <stdexcept> // for runtime_error
    -
    58 #include <string> // for string
    -
    59 #include <tuple> // for tuple, forward_as_tuple
    -
    60 #include <type_traits> // for declval, false_type, is_same, integral_constant
    -
    61 #include <utility> // for move, index_sequence, make_index_sequence
    -
    62 
    -
    63 #if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE)
    -
    64 # include <unordered_map> // for unordered_map
    -
    65 #endif
    -
    66 
    -
    68 namespace rpc
    -
    69 {
    -
    71 namespace details
    -
    72 {
    -
    73 #if !defined(RPC_HPP_DOXYGEN_GEN)
    -
    74  template<typename, typename T>
    -
    75  struct is_serializable_base
    -
    76  {
    -
    77  static_assert(std::integral_constant<T, false>::value,
    -
    78  "Second template parameter needs to be of function type");
    -
    79  };
    -
    80 
    -
    81  template<typename C, typename R, typename... Args>
    -
    82  struct is_serializable_base<C, R(Args...)>
    -
    83  {
    -
    84  private:
    -
    85  template<typename T>
    -
    86  static constexpr auto check(T*) noexcept ->
    -
    87  typename std::is_same<decltype(std::declval<T>().serialize(std::declval<Args>()...)),
    -
    88  R>::type;
    -
    89 
    -
    90  template<typename>
    -
    91  static constexpr std::false_type check(...) noexcept;
    +
    55 #include <cassert> // for assert
    +
    56 #include <cstddef> // for size_t
    +
    57 #include <optional> // for nullopt, optional
    +
    58 #include <stdexcept> // for runtime_error
    +
    59 #include <string> // for string
    +
    60 #include <tuple> // for tuple, forward_as_tuple
    +
    61 #include <type_traits> // for declval, false_type, is_same, integral_constant
    +
    62 #include <utility> // for move, index_sequence, make_index_sequence
    +
    63 
    +
    64 #if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE)
    +
    65 # include <unordered_map> // for unordered_map
    +
    66 #endif
    +
    67 
    +
    68 #define RPC_HPP_PRECONDITION(EXPR) assert(EXPR)
    +
    69 #define RPC_HPP_POSTCONDITION(EXPR) assert(EXPR)
    +
    70 
    +
    72 namespace rpc
    +
    73 {
    +
    75 static constexpr unsigned version[]{ 0, 7, 1 };
    +
    76 
    +
    77 namespace exceptions
    +
    78 {
    +
    79  enum class Type
    +
    80  {
    +
    81  None,
    +
    82  FuncNotFound,
    +
    83  RemoteExec,
    +
    84  Serialization,
    +
    85  DeSerialization,
    +
    86  SignatureMismatch,
    +
    87  ClientSend,
    +
    88  ClientReceive,
    +
    89  ServerSend,
    +
    90  ServerReceive,
    +
    91  };
    92 
    -
    93  using type = decltype(check<C>(nullptr));
    -
    94 
    +
    93  class rpc_exception : public std::runtime_error
    +
    94  {
    95  public:
    -
    96  static constexpr bool value = type::value;
    -
    97  };
    -
    98 
    -
    99  template<typename, typename T>
    -
    100  struct is_deserializable_base
    -
    101  {
    -
    102  static_assert(std::integral_constant<T, false>::value,
    -
    103  "Second template parameter needs to be of function type");
    -
    104  };
    +
    96  explicit rpc_exception(const std::string& mesg, Type type) noexcept
    +
    97  : std::runtime_error(mesg), m_type(type)
    +
    98  {
    +
    99  }
    +
    100 
    +
    101  explicit rpc_exception(const char* mesg, Type type) noexcept
    +
    102  : std::runtime_error(mesg), m_type(type)
    +
    103  {
    +
    104  }
    105 
    -
    106  template<typename C, typename R, typename... Args>
    -
    107  struct is_deserializable_base<C, R(Args...)>
    -
    108  {
    -
    109  private:
    -
    110  template<typename T>
    -
    111  static constexpr auto check(T*) noexcept ->
    -
    112  typename std::is_same<decltype(std::declval<T>().deserialize(std::declval<Args>()...)),
    -
    113  R>::type;
    -
    114 
    -
    115  template<typename>
    -
    116  static constexpr std::false_type check(...) noexcept;
    -
    117 
    -
    118  using type = decltype(check<C>(nullptr));
    +
    106  Type get_type() const noexcept { return m_type; }
    +
    107 
    +
    108  private:
    +
    109  Type m_type;
    +
    110  };
    +
    111 
    +
    112  class function_not_found : public rpc_exception
    +
    113  {
    +
    114  public:
    +
    115  explicit function_not_found(const std::string& mesg) noexcept
    +
    116  : rpc_exception(mesg, Type::FuncNotFound)
    +
    117  {
    +
    118  }
    119 
    -
    120  public:
    -
    121  static constexpr bool value = type::value;
    -
    122  };
    -
    123 
    -
    124  template<typename Serial, typename Value>
    -
    125  struct is_serializable
    -
    126  : std::integral_constant<bool,
    -
    127  is_serializable_base<Value, typename Serial::serial_t(const Value&)>::value
    -
    128  && is_deserializable_base<Value, Value(const typename Serial::serial_t&)>::value>
    -
    129  {
    -
    130  };
    -
    131 
    -
    132  template<typename Serial, typename Value>
    -
    133  inline constexpr bool is_serializable_v = is_serializable<Serial, Value>::value;
    -
    134 
    -
    135  template<typename C>
    -
    136  struct has_begin
    -
    137  {
    -
    138  private:
    -
    139  template<typename T>
    -
    140  static constexpr auto check(T*) noexcept ->
    -
    141  typename std::is_same<decltype(std::declval<T>().begin()), typename T::iterator>::type;
    -
    142 
    -
    143  template<typename>
    -
    144  static constexpr std::false_type check(...) noexcept;
    -
    145 
    -
    146  using type = decltype(check<C>(nullptr));
    +
    120  explicit function_not_found(const char* mesg) noexcept
    +
    121  : rpc_exception(mesg, Type::FuncNotFound)
    +
    122  {
    +
    123  }
    +
    124  };
    +
    125 
    +
    126  class remote_exec_error : public rpc_exception
    +
    127  {
    +
    128  public:
    +
    129  explicit remote_exec_error(const std::string& mesg) noexcept
    +
    130  : rpc_exception(mesg, Type::RemoteExec)
    +
    131  {
    +
    132  }
    +
    133 
    +
    134  explicit remote_exec_error(const char* mesg) noexcept
    +
    135  : rpc_exception(mesg, Type::RemoteExec)
    +
    136  {
    +
    137  }
    +
    138  };
    +
    139 
    +
    140  class serialization_error : public rpc_exception
    +
    141  {
    +
    142  public:
    +
    143  explicit serialization_error(const std::string& mesg) noexcept
    +
    144  : rpc_exception(mesg, Type::Serialization)
    +
    145  {
    +
    146  }
    147 
    -
    148  public:
    -
    149  static constexpr bool value = type::value;
    -
    150  };
    -
    151 
    -
    152  template<typename C>
    -
    153  struct has_end
    -
    154  {
    -
    155  private:
    -
    156  template<typename T>
    -
    157  static constexpr auto check(T*) noexcept ->
    -
    158  typename std::is_same<decltype(std::declval<T>().end()), typename T::iterator>::type;
    -
    159 
    -
    160  template<typename>
    -
    161  static constexpr std::false_type check(...) noexcept;
    -
    162 
    -
    163  using type = decltype(check<C>(nullptr));
    -
    164 
    -
    165  public:
    -
    166  static constexpr bool value = type::value;
    -
    167  };
    -
    168 
    -
    169  template<typename C>
    -
    170  struct has_size
    -
    171  {
    -
    172  private:
    -
    173  template<typename T>
    -
    174  static constexpr auto check(T*) noexcept ->
    -
    175  typename std::is_same<decltype(std::declval<T>().size()), size_t>::type;
    -
    176 
    -
    177  template<typename>
    -
    178  static constexpr std::false_type check(...) noexcept;
    -
    179 
    -
    180  using type = decltype(check<C>(nullptr));
    +
    148  explicit serialization_error(const char* mesg) noexcept
    +
    149  : rpc_exception(mesg, Type::Serialization)
    +
    150  {
    +
    151  }
    +
    152  };
    +
    153 
    +
    154  class deserialization_error : public rpc_exception
    +
    155  {
    +
    156  public:
    +
    157  explicit deserialization_error(const std::string& mesg) noexcept
    +
    158  : rpc_exception(mesg, Type::DeSerialization)
    +
    159  {
    +
    160  }
    +
    161 
    +
    162  explicit deserialization_error(const char* mesg) noexcept
    +
    163  : rpc_exception(mesg, Type::DeSerialization)
    +
    164  {
    +
    165  }
    +
    166  };
    +
    167 
    +
    168  class function_mismatch : public rpc_exception
    +
    169  {
    +
    170  public:
    +
    171  explicit function_mismatch(const std::string& mesg) noexcept
    +
    172  : rpc_exception(mesg, Type::SignatureMismatch)
    +
    173  {
    +
    174  }
    +
    175 
    +
    176  explicit function_mismatch(const char* mesg) noexcept
    +
    177  : rpc_exception(mesg, Type::SignatureMismatch)
    +
    178  {
    +
    179  }
    +
    180  };
    181 
    -
    182  public:
    -
    183  static constexpr bool value = type::value;
    -
    184  };
    -
    185 
    -
    186  template<typename C>
    -
    187  struct is_container : std::integral_constant<bool,
    -
    188  has_size<C>::value && has_begin<C>::value && has_end<C>::value>
    -
    189  {
    -
    190  };
    -
    191 
    -
    192  template<typename C>
    -
    193  inline constexpr bool is_container_v = is_container<C>::value;
    -
    194 
    -
    195  template<typename F, typename... Ts, size_t... Is>
    -
    196  constexpr void for_each_tuple(
    -
    197  const std::tuple<Ts...>& tuple, const F& func, [[maybe_unused]] std::index_sequence<Is...>)
    -
    198  {
    -
    199  using expander = int[];
    -
    200  (void)expander{ 0, ((void)func(std::get<Is>(tuple)), 0)... };
    -
    201  }
    -
    202 
    -
    203  template<typename F, typename... Ts>
    -
    204  constexpr void for_each_tuple(const std::tuple<Ts...>& tuple, const F& func)
    -
    205  {
    -
    206  for_each_tuple(tuple, func, std::make_index_sequence<sizeof...(Ts)>());
    -
    207  }
    -
    208 
    -
    209 # if defined(RPC_HPP_CLIENT_IMPL)
    -
    210  template<typename... Args, size_t... Is>
    -
    211  constexpr void tuple_bind(
    -
    212  const std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>& src,
    -
    213  std::index_sequence<Is...>, Args&&... dest)
    -
    214  {
    -
    215  using expander = int[];
    -
    216  (void)expander{ 0,
    -
    217  (
    -
    218  (void)[](auto&& x, auto&& y)
    -
    219  {
    -
    220  if constexpr (
    -
    221  std::is_reference_v<
    -
    222  decltype(x)> && !std::is_const_v<std::remove_reference_t<decltype(x)>>)
    -
    223  {
    -
    224  x = std::move(y);
    -
    225  }
    -
    226  }(dest, std::get<Is>(src)),
    -
    227  0)... };
    -
    228  }
    -
    229 
    -
    230  template<typename... Args>
    -
    231  constexpr void tuple_bind(
    -
    232  const std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>& src, Args&&... dest)
    -
    233  {
    -
    234  tuple_bind(src, std::make_index_sequence<sizeof...(Args)>(), std::forward<Args>(dest)...);
    -
    235  }
    -
    236 # endif
    -
    237 
    -
    238  template<typename... Args>
    -
    239  class packed_func_base
    -
    240  {
    -
    241  public:
    -
    242  using args_t = std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>;
    -
    243 
    -
    244  packed_func_base(std::string func_name, args_t args)
    -
    245  : m_func_name(std::move(func_name)), m_args(std::move(args))
    -
    246  {
    -
    247  }
    -
    248 
    -
    249  std::string get_err_mesg() const { return m_err_mesg; }
    -
    250  std::string get_func_name() const { return m_func_name; }
    -
    251 
    -
    252  void set_err_mesg(const std::string& mesg) & { m_err_mesg = mesg; }
    -
    253 
    -
    254  explicit operator bool() const { return m_err_mesg.empty(); }
    -
    255 
    -
    256  args_t get_args() const { return m_args; }
    -
    257  void set_args(const args_t& args) & { m_args = args; }
    +
    182  class client_send_error : public rpc_exception
    +
    183  {
    +
    184  public:
    +
    185  explicit client_send_error(const std::string& mesg) noexcept
    +
    186  : rpc_exception(mesg, Type::ClientSend)
    +
    187  {
    +
    188  }
    +
    189 
    +
    190  explicit client_send_error(const char* mesg) noexcept
    +
    191  : rpc_exception(mesg, Type::ClientSend)
    +
    192  {
    +
    193  }
    +
    194  };
    +
    195 
    +
    196  class client_receive_error : public rpc_exception
    +
    197  {
    +
    198  public:
    +
    199  explicit client_receive_error(const std::string& mesg) noexcept
    +
    200  : rpc_exception(mesg, Type::ClientReceive)
    +
    201  {
    +
    202  }
    +
    203 
    +
    204  explicit client_receive_error(const char* mesg) noexcept
    +
    205  : rpc_exception(mesg, Type::ClientReceive)
    +
    206  {
    +
    207  }
    +
    208  };
    +
    209 
    +
    210  class server_send_error : public rpc_exception
    +
    211  {
    +
    212  public:
    +
    213  explicit server_send_error(const std::string& mesg) noexcept
    +
    214  : rpc_exception(mesg, Type::ServerSend)
    +
    215  {
    +
    216  }
    +
    217 
    +
    218  explicit server_send_error(const char* mesg) noexcept
    +
    219  : rpc_exception(mesg, Type::ServerSend)
    +
    220  {
    +
    221  }
    +
    222  };
    +
    223 
    +
    224  class server_receive_error : public rpc_exception
    +
    225  {
    +
    226  public:
    +
    227  explicit server_receive_error(const std::string& mesg) noexcept
    +
    228  : rpc_exception(mesg, Type::ServerReceive)
    +
    229  {
    +
    230  }
    +
    231 
    +
    232  explicit server_receive_error(const char* mesg) noexcept
    +
    233  : rpc_exception(mesg, Type::ServerReceive)
    +
    234  {
    +
    235  }
    +
    236  };
    +
    237 } // namespace exceptions
    +
    238 
    +
    240 namespace details
    +
    241 {
    +
    242 #if !defined(RPC_HPP_DOXYGEN_GEN)
    +
    243  template<typename, typename T>
    +
    244  struct is_serializable_base
    +
    245  {
    +
    246  static_assert(std::integral_constant<T, false>::value,
    +
    247  "Second template parameter needs to be of function type");
    +
    248  };
    +
    249 
    +
    250  template<typename C, typename R, typename... Args>
    +
    251  struct is_serializable_base<C, R(Args...)>
    +
    252  {
    +
    253  private:
    +
    254  template<typename T>
    +
    255  static constexpr auto check(T*) noexcept ->
    +
    256  typename std::is_same<decltype(std::declval<T>().serialize(std::declval<Args>()...)),
    +
    257  R>::type;
    258 
    -
    259  template<size_t Index>
    -
    260  auto get_arg() const
    -
    261  {
    -
    262  return std::get<Index>(m_args);
    -
    263  }
    -
    264 
    -
    265  private:
    -
    266  std::string m_func_name;
    -
    267  std::string m_err_mesg{};
    -
    268  args_t m_args;
    -
    269  };
    -
    270 
    -
    271  template<typename T_Serial, typename T_Bytes = std::string>
    -
    272  struct serial_adapter
    -
    273  {
    -
    274  using serial_t = T_Serial;
    -
    275  using bytes_t = T_Bytes;
    -
    276 
    -
    277  template<typename T>
    -
    278  static serial_t serialize(const T& val);
    -
    279 
    -
    280  template<typename T>
    -
    281  static T deserialize(const serial_t& serial_obj);
    -
    282 
    -
    283  static serial_t from_bytes(bytes_t bytes);
    -
    284  static bytes_t to_bytes(serial_t serial_obj);
    -
    285  };
    -
    286 #endif
    -
    287 } // namespace details
    +
    259  template<typename>
    +
    260  static constexpr std::false_type check(...) noexcept;
    +
    261 
    +
    262  using type = decltype(check<C>(nullptr));
    +
    263 
    +
    264  public:
    +
    265  static constexpr bool value = type::value;
    +
    266  };
    +
    267 
    +
    268  template<typename, typename T>
    +
    269  struct is_deserializable_base
    +
    270  {
    +
    271  static_assert(std::integral_constant<T, false>::value,
    +
    272  "Second template parameter needs to be of function type");
    +
    273  };
    +
    274 
    +
    275  template<typename C, typename R, typename... Args>
    +
    276  struct is_deserializable_base<C, R(Args...)>
    +
    277  {
    +
    278  private:
    +
    279  template<typename T>
    +
    280  static constexpr auto check(T*) noexcept ->
    +
    281  typename std::is_same<decltype(std::declval<T>().deserialize(std::declval<Args>()...)),
    +
    282  R>::type;
    +
    283 
    +
    284  template<typename>
    +
    285  static constexpr std::false_type check(...) noexcept;
    +
    286 
    +
    287  using type = decltype(check<C>(nullptr));
    288 
    -
    293 template<typename R, typename... Args>
    -
    294 class packed_func final : public details::packed_func_base<Args...>
    -
    295 {
    -
    296 public:
    -
    298  using result_t = R;
    -
    299 
    -
    301  using typename details::packed_func_base<Args...>::args_t;
    -
    302 
    -
    308  packed_func(std::string func_name, std::optional<result_t> result, args_t args)
    -
    309  : details::packed_func_base<Args...>(std::move(func_name), std::move(args)),
    -
    310  m_result(std::move(result))
    -
    311  {
    -
    312  }
    -
    313 
    -
    319  explicit operator bool() const
    -
    320  {
    -
    321  return m_result.has_value() && details::packed_func_base<Args...>::operator bool();
    -
    322  }
    -
    323 
    -
    327  R get_result() const
    -
    328  {
    -
    329  if (m_result.has_value())
    -
    330  {
    -
    331  return m_result.value();
    -
    332  }
    -
    333  else
    -
    334  {
    -
    335  throw std::runtime_error(this->get_err_mesg());
    -
    336  }
    -
    337  }
    -
    338 
    -
    342  void set_result(const R& value) & { m_result = value; }
    -
    343 
    -
    345  void clear_result() & { m_result = std::nullopt; }
    -
    346 
    -
    347 private:
    -
    348  std::optional<result_t> m_result{ std::nullopt };
    -
    349 };
    +
    289  public:
    +
    290  static constexpr bool value = type::value;
    +
    291  };
    +
    292 
    +
    293  template<typename Serial, typename Value>
    +
    294  struct is_serializable
    +
    295  : std::integral_constant<bool,
    +
    296  is_serializable_base<Value, typename Serial::serial_t(const Value&)>::value
    +
    297  && is_deserializable_base<Value, Value(const typename Serial::serial_t&)>::value>
    +
    298  {
    +
    299  };
    +
    300 
    +
    301  template<typename Serial, typename Value>
    +
    302  inline constexpr bool is_serializable_v = is_serializable<Serial, Value>::value;
    +
    303 
    +
    304  template<typename C>
    +
    305  struct has_begin
    +
    306  {
    +
    307  private:
    +
    308  template<typename T>
    +
    309  static constexpr auto check(T*) noexcept ->
    +
    310  typename std::is_same<decltype(std::declval<T>().begin()), typename T::iterator>::type;
    +
    311 
    +
    312  template<typename>
    +
    313  static constexpr std::false_type check(...) noexcept;
    +
    314 
    +
    315  using type = decltype(check<C>(nullptr));
    +
    316 
    +
    317  public:
    +
    318  static constexpr bool value = type::value;
    +
    319  };
    +
    320 
    +
    321  template<typename C>
    +
    322  struct has_end
    +
    323  {
    +
    324  private:
    +
    325  template<typename T>
    +
    326  static constexpr auto check(T*) noexcept ->
    +
    327  typename std::is_same<decltype(std::declval<T>().end()), typename T::iterator>::type;
    +
    328 
    +
    329  template<typename>
    +
    330  static constexpr std::false_type check(...) noexcept;
    +
    331 
    +
    332  using type = decltype(check<C>(nullptr));
    +
    333 
    +
    334  public:
    +
    335  static constexpr bool value = type::value;
    +
    336  };
    +
    337 
    +
    338  template<typename C>
    +
    339  struct has_size
    +
    340  {
    +
    341  private:
    +
    342  template<typename T>
    +
    343  static constexpr auto check(T*) noexcept ->
    +
    344  typename std::is_same<decltype(std::declval<T>().size()), size_t>::type;
    +
    345 
    +
    346  template<typename>
    +
    347  static constexpr std::false_type check(...) noexcept;
    +
    348 
    +
    349  using type = decltype(check<C>(nullptr));
    350 
    -
    354 template<typename... Args>
    -
    355 class packed_func<void, Args...> final : public details::packed_func_base<Args...>
    -
    356 {
    -
    357 public:
    -
    359  using result_t = void;
    +
    351  public:
    +
    352  static constexpr bool value = type::value;
    +
    353  };
    +
    354 
    +
    355  template<typename C>
    +
    356  struct is_container : std::integral_constant<bool,
    +
    357  has_size<C>::value && has_begin<C>::value && has_end<C>::value>
    +
    358  {
    +
    359  };
    360 
    -
    362  using typename details::packed_func_base<Args...>::args_t;
    +
    361  template<typename C>
    +
    362  inline constexpr bool is_container_v = is_container<C>::value;
    363 
    -
    368  packed_func(std::string func_name, args_t args)
    -
    369  : details::packed_func_base<Args...>(std::move(func_name), std::move(args))
    -
    370  {
    -
    371  }
    -
    372 };
    -
    373 
    -
    377 template<typename Serial>
    -
    378 class pack_adapter
    -
    379 {
    -
    380 public:
    -
    387  template<typename R, typename... Args>
    -
    388  static typename Serial::serial_t serialize_pack(const packed_func<R, Args...>& pack);
    -
    389 
    -
    396  template<typename R, typename... Args>
    -
    397  static packed_func<R, Args...> deserialize_pack(const typename Serial::serial_t& serial_obj);
    +
    364  template<typename F, typename... Ts, size_t... Is>
    +
    365  constexpr void for_each_tuple(const std::tuple<Ts...>& tuple, const F& func,
    +
    366  [[maybe_unused]] std::index_sequence<Is...> iseq)
    +
    367  {
    +
    368  using expander = int[];
    +
    369  std::ignore = expander{ 0, ((void)func(std::get<Is>(tuple)), 0)... };
    +
    370  }
    +
    371 
    +
    372  template<typename F, typename... Ts>
    +
    373  constexpr void for_each_tuple(const std::tuple<Ts...>& tuple, const F& func)
    +
    374  {
    +
    375  for_each_tuple(tuple, func, std::make_index_sequence<sizeof...(Ts)>());
    +
    376  }
    +
    377 
    +
    378 # if defined(RPC_HPP_CLIENT_IMPL)
    +
    379  template<typename... Args, size_t... Is>
    +
    380  constexpr void tuple_bind(
    +
    381  const std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>& src,
    +
    382  std::index_sequence<Is...>, Args&&... dest)
    +
    383  {
    +
    384  using expander = int[];
    +
    385  std::ignore = expander{ 0,
    +
    386  (
    +
    387  (void)[](auto&& x, auto&& y)
    +
    388  {
    +
    389  if constexpr (
    +
    390  std::is_reference_v<
    +
    391  decltype(x)> && !std::is_const_v<std::remove_reference_t<decltype(x)>>)
    +
    392  {
    +
    393  x = std::forward<decltype(y)>(y);
    +
    394  }
    +
    395  }(dest, std::get<Is>(src)),
    +
    396  0)... };
    +
    397  }
    398 
    -
    403  static std::string get_func_name(const typename Serial::serial_t& serial_obj);
    -
    404 
    -
    409  static void set_err_mesg(typename Serial::serial_t& serial_obj, std::string mesg);
    -
    410 };
    -
    411 
    -
    412 #if defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL)
    -
    416 inline namespace server
    -
    417 {
    -
    421  template<typename Serial>
    -
    422  class server_interface
    -
    423  {
    -
    424  public:
    -
    425  using adapter_t = Serial;
    -
    426 
    -
    427  virtual ~server_interface() = default;
    -
    428 
    -
    435  template<typename R, typename... Args>
    -
    436  static void run_callback(R (*func)(Args...), packed_func<R, Args...>& pack)
    -
    437  {
    -
    438  auto args = pack.get_args();
    +
    399  template<typename... Args>
    +
    400  constexpr void tuple_bind(
    +
    401  const std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>& src, Args&&... dest)
    +
    402  {
    +
    403  tuple_bind(src, std::make_index_sequence<sizeof...(Args)>(), std::forward<Args>(dest)...);
    +
    404  }
    +
    405 # endif
    +
    406 
    +
    407  template<typename... Args>
    +
    408  class packed_func_base
    +
    409  {
    +
    410  public:
    +
    411  using args_t = std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>;
    +
    412 
    +
    413  packed_func_base(std::string func_name, args_t args) noexcept
    +
    414  : m_func_name(std::move(func_name)), m_args(std::move(args))
    +
    415  {
    +
    416  RPC_HPP_POSTCONDITION(!m_func_name.empty());
    +
    417  }
    +
    418 
    +
    419  explicit operator bool() const noexcept { return m_except_type == exceptions::Type::None; }
    +
    420  const std::string& get_err_mesg() const noexcept { return m_err_mesg; }
    +
    421  const std::string& get_func_name() const noexcept { return m_func_name; }
    +
    422  exceptions::Type get_except_type() const noexcept { return m_except_type; }
    +
    423 
    +
    424  void set_exception(std::string&& mesg, exceptions::Type type) & noexcept
    +
    425  {
    +
    426  m_except_type = type;
    +
    427  m_err_mesg = std::move(mesg);
    +
    428  }
    +
    429 
    +
    430  const args_t& get_args() const noexcept { return m_args; }
    +
    431  args_t& get_args() noexcept { return m_args; }
    +
    432 
    +
    433  protected:
    +
    434  ~packed_func_base() noexcept = default;
    +
    435  packed_func_base(const packed_func_base&) = default;
    +
    436  packed_func_base(packed_func_base&&) noexcept = default;
    +
    437  packed_func_base& operator=(const packed_func_base&) & = default;
    +
    438  packed_func_base& operator=(packed_func_base&&) & noexcept = default;
    439 
    -
    440  if constexpr (std::is_void_v<R>)
    -
    441  {
    -
    442  std::apply(func, args);
    -
    443  pack.set_args(std::move(args));
    -
    444  }
    -
    445  else
    -
    446  {
    -
    447  auto result = std::apply(func, args);
    -
    448  pack.set_result(std::move(result));
    -
    449  pack.set_args(std::move(args));
    -
    450  }
    -
    451  }
    -
    452 
    -
    453 # if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE)
    -
    461  template<typename R, typename... Args>
    -
    462  static void dispatch_cached_func(R (*func)(Args...), typename Serial::serial_t& serial_obj)
    -
    463  {
    -
    464  static std::unordered_map<typename Serial::bytes_t, R> result_cache;
    -
    465 
    -
    466  auto pack = pack_adapter<Serial>::template deserialize_pack<R, Args...>(serial_obj);
    -
    467 
    -
    468  if constexpr (!std::is_void_v<R>)
    -
    469  {
    -
    470  auto bytes = Serial::to_bytes(std::move(serial_obj));
    -
    471 
    -
    472  const auto it = result_cache.find(bytes);
    -
    473 
    -
    474  if (it != result_cache.end())
    -
    475  {
    -
    476  pack.set_result(it->second);
    -
    477  serial_obj = pack_adapter<Serial>::template serialize_pack<R, Args...>(pack);
    +
    440  [[noreturn]] void throw_ex() const noexcept(false)
    +
    441  {
    +
    442  switch (m_except_type)
    +
    443  {
    +
    444  using namespace exceptions;
    +
    445 
    +
    446  case Type::FuncNotFound:
    +
    447  throw function_not_found(m_err_mesg);
    +
    448 
    +
    449  case Type::RemoteExec:
    +
    450  throw remote_exec_error(m_err_mesg);
    +
    451 
    +
    452  case Type::Serialization:
    +
    453  throw serialization_error(m_err_mesg);
    +
    454 
    +
    455  case Type::DeSerialization:
    +
    456  throw deserialization_error(m_err_mesg);
    +
    457 
    +
    458  case Type::SignatureMismatch:
    +
    459  throw function_mismatch(m_err_mesg);
    +
    460 
    +
    461  case Type::ClientSend:
    +
    462  throw client_send_error(m_err_mesg);
    +
    463 
    +
    464  case Type::ClientReceive:
    +
    465  throw client_receive_error(m_err_mesg);
    +
    466 
    +
    467  case Type::ServerSend:
    +
    468  throw server_send_error(m_err_mesg);
    +
    469 
    +
    470  case Type::ServerReceive:
    +
    471  throw server_receive_error(m_err_mesg);
    +
    472 
    +
    473  case Type::None:
    +
    474  default:
    +
    475  throw rpc_exception(m_err_mesg, Type::None);
    +
    476  }
    +
    477  }
    478 
    -
    479  return;
    -
    480  }
    -
    481 
    -
    482  run_callback(func, pack);
    -
    483  result_cache[std::move(bytes)] = pack.get_result();
    -
    484  }
    -
    485  else
    -
    486  {
    -
    487  run_callback(func, pack);
    -
    488  }
    -
    489 
    -
    490  serial_obj = pack_adapter<Serial>::template serialize_pack<R, Args...>(pack);
    -
    491  }
    -
    492 # endif
    -
    493 
    -
    500  template<typename R, typename... Args>
    -
    501  static void dispatch_func(R (*func)(Args...), typename Serial::serial_t& serial_obj)
    -
    502  {
    -
    503  auto pack = pack_adapter<Serial>::template deserialize_pack<R, Args...>(serial_obj);
    -
    504 
    -
    505  run_callback(func, pack);
    -
    506  serial_obj = pack_adapter<Serial>::template serialize_pack<R, Args...>(pack);
    -
    507  }
    -
    508 
    -
    512  virtual void dispatch_impl(typename Serial::serial_t& serial_obj) = 0;
    +
    479  private:
    +
    480  exceptions::Type m_except_type{ exceptions::Type::None };
    +
    481  std::string m_func_name;
    +
    482  std::string m_err_mesg{};
    +
    483  args_t m_args;
    +
    484  };
    +
    485 
    +
    486  template<typename T_Serial, typename T_Bytes = std::string>
    +
    487  struct serial_adapter
    +
    488  {
    +
    489  using serial_t = T_Serial;
    +
    490  using bytes_t = T_Bytes;
    +
    491 
    +
    492  // nodiscard because a potentially expensive parse and copy is being done
    +
    493  template<typename T>
    +
    494  [[nodiscard]] static serial_t serialize(const T& val);
    +
    495 
    +
    496  // nodiscard because a potentially expensive parse and copy is being done
    +
    497  template<typename T>
    +
    498  [[nodiscard]] static T deserialize(const serial_t& serial_obj);
    +
    499 
    +
    500  // nodiscard because input bytes are lost after conversion
    +
    501  [[nodiscard]] static serial_t from_bytes(bytes_t&& bytes);
    +
    502 
    +
    503  // nodiscard because input object is lost after conversion
    +
    504  [[nodiscard]] static bytes_t to_bytes(serial_t&& serial_obj);
    +
    505  };
    +
    506 
    +
    507  template<typename R, typename... Args>
    +
    508  class packed_func final : public packed_func_base<Args...>
    +
    509  {
    +
    510  public:
    +
    511  using result_t = R;
    +
    512  using typename packed_func_base<Args...>::args_t;
    513 
    -
    517  void dispatch(typename Serial::bytes_t& bytes)
    -
    518  {
    -
    519  auto serial_obj = Serial::from_bytes(std::move(bytes));
    -
    520 
    -
    521  try
    -
    522  {
    -
    523  dispatch_impl(serial_obj);
    -
    524  }
    -
    525  catch (const std::exception& ex)
    -
    526  {
    -
    527  pack_adapter<Serial>::set_err_mesg(serial_obj, ex.what());
    -
    528  }
    -
    529 
    -
    530  bytes = Serial::to_bytes(std::move(serial_obj));
    -
    531  }
    -
    532  };
    -
    533 } // namespace server
    -
    534 #endif
    +
    514  packed_func(std::string func_name, std::optional<result_t> result, args_t args) noexcept
    +
    515  : packed_func_base<Args...>(std::move(func_name), std::move(args)),
    +
    516  m_result(std::move(result))
    +
    517  {
    +
    518  }
    +
    519 
    +
    520  explicit operator bool() const noexcept
    +
    521  {
    +
    522  return m_result.has_value() && packed_func_base<Args...>::operator bool();
    +
    523  }
    +
    524 
    +
    525  const R& get_result() const
    +
    526  {
    +
    527  if (!static_cast<bool>(*this))
    +
    528  {
    +
    529  // throws exception based on except_type
    +
    530  this->throw_ex();
    +
    531  }
    +
    532 
    +
    533  return m_result.value();
    +
    534  }
    535 
    -
    536 #if defined(RPC_HPP_CLIENT_IMPL)
    -
    540 inline namespace client
    -
    541 {
    -
    545  template<typename Serial>
    -
    546  class client_interface
    -
    547  {
    -
    548  public:
    -
    549  virtual ~client_interface() = default;
    -
    550 
    -
    558  template<typename R = void, typename... Args>
    -
    559  R call_func(std::string func_name, Args&&... args)
    -
    560  {
    -
    561  packed_func<R, Args...> pack = [&]
    -
    562  {
    -
    563  if constexpr (std::is_void_v<R>)
    -
    564  {
    -
    565  return packed_func<void, Args...>{ std::move(func_name),
    -
    566  std::forward_as_tuple(args...) };
    -
    567  }
    -
    568  else
    -
    569  {
    -
    570  return packed_func<R, Args...>{ std::move(func_name), std::nullopt,
    -
    571  std::forward_as_tuple(args...) };
    -
    572  }
    -
    573  }();
    -
    574 
    -
    575  send(Serial::to_bytes(pack_adapter<Serial>::serialize_pack(pack)));
    -
    576 
    -
    577  pack = pack_adapter<Serial>::template deserialize_pack<R, Args...>(
    -
    578  Serial::from_bytes(receive()));
    -
    579 
    -
    580  // Assign values back to any (non-const) reference members
    -
    581  details::tuple_bind(pack.get_args(), std::forward<Args>(args)...);
    -
    582 
    -
    583  if constexpr (std::is_void_v<R>)
    -
    584  {
    -
    585  return;
    -
    586  }
    -
    587  else
    -
    588  {
    -
    589  return pack.get_result();
    -
    590  }
    -
    591  }
    -
    592 
    -
    593  protected:
    -
    597  virtual void send(const typename Serial::bytes_t& bytes) = 0;
    -
    598 
    -
    602  virtual typename Serial::bytes_t receive() = 0;
    -
    603  };
    -
    604 } // namespace client
    -
    605 #endif
    -
    606 } // namespace rpc
    -
    rpc::client::client_interface
    Class defining an interface for calling into an RPC server or module.
    Definition: rpc.hpp:547
    -
    rpc::client::client_interface::call_func
    R call_func(std::string func_name, Args &&... args)
    Sends an RPC call request to a server, waits for a response, then returns the result.
    Definition: rpc.hpp:559
    +
    536  void set_result(const R& value) & { m_result = value; }
    +
    537 
    +
    538  void set_result(R&& value) & noexcept(std::is_nothrow_move_assignable_v<R>)
    +
    539  {
    +
    540  m_result = std::move(value);
    +
    541  }
    +
    542 
    +
    543  void clear_result() & noexcept { m_result.reset(); }
    +
    544 
    +
    545  private:
    +
    546  std::optional<result_t> m_result{};
    +
    547  };
    +
    548 
    +
    549  template<typename... Args>
    +
    550  class packed_func<void, Args...> final : public packed_func_base<Args...>
    +
    551  {
    +
    552  public:
    +
    553  using result_t = void;
    +
    554  using typename packed_func_base<Args...>::args_t;
    +
    555  using packed_func_base<Args...>::packed_func_base;
    +
    556  using packed_func_base<Args...>::operator bool;
    +
    557 
    +
    558  void get_result() const
    +
    559  {
    +
    560  if (!static_cast<bool>(*this))
    +
    561  {
    +
    562  // throws exception based on except_type
    +
    563  this->throw_ex();
    +
    564  }
    +
    565  }
    +
    566  };
    +
    567 #endif
    +
    568 } // namespace details
    +
    569 
    +
    573 template<typename Serial>
    +
    574 class pack_adapter
    +
    575 {
    +
    576 public:
    +
    583 
    +
    584  // nodiscard because a potentially expensive parse and copy is being done
    +
    585  template<typename R, typename... Args>
    +
    586  [[nodiscard]] static typename Serial::serial_t serialize_pack(
    +
    587  const details::packed_func<R, Args...>& pack);
    +
    588 
    +
    595 
    +
    596  // nodiscard because a potentially expensive parse and copy is being done
    +
    597  template<typename R, typename... Args>
    +
    598  [[nodiscard]] static details::packed_func<R, Args...> deserialize_pack(
    +
    599  const typename Serial::serial_t& serial_obj);
    +
    600 
    +
    605 
    +
    606  // nodiscard because a potentially expensive parse and string allocation is being done
    +
    607  [[nodiscard]] static std::string get_func_name(const typename Serial::serial_t& serial_obj);
    +
    608 
    +
    609  static void set_exception(
    +
    610  typename Serial::serial_t& serial_obj, const exceptions::rpc_exception& ex);
    +
    611 };
    +
    612 
    +
    613 #if defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL)
    +
    617 inline namespace server
    +
    618 {
    +
    622  template<typename Serial>
    +
    623  class server_interface
    +
    624  {
    +
    625  public:
    +
    626  using adapter_t = Serial;
    +
    627 
    +
    628  virtual ~server_interface() noexcept = default;
    +
    629  server_interface() noexcept = default;
    +
    630 
    +
    631  server_interface(const server_interface&) = delete;
    +
    632  server_interface& operator=(const server_interface&) = delete;
    +
    633  server_interface& operator=(server_interface&&) = delete;
    +
    634 
    +
    635 # if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE)
    +
    636  template<typename Val>
    +
    637  std::unordered_map<typename Serial::bytes_t, Val>& get_func_cache(
    +
    638  const std::string& func_name)
    +
    639  {
    +
    640  RPC_HPP_PRECONDITION(!func_name.empty());
    +
    641 
    +
    642  update_all_cache<Val>(func_name);
    +
    643  return *static_cast<std::unordered_map<typename Serial::bytes_t, Val>*>(
    +
    644  m_cache_map.at(func_name));
    +
    645  }
    +
    646 
    +
    647  void clear_all_cache() noexcept { m_cache_map.clear(); }
    +
    648 # endif
    +
    649 
    +
    653  void dispatch(typename Serial::bytes_t& bytes)
    +
    654  {
    +
    655  auto serial_obj = Serial::from_bytes(std::move(bytes));
    +
    656 
    +
    657  try
    +
    658  {
    +
    659  dispatch_impl(serial_obj);
    +
    660  }
    +
    661  catch (const exceptions::rpc_exception& ex)
    +
    662  {
    +
    663  pack_adapter<Serial>::set_exception(serial_obj, ex);
    +
    664  }
    +
    665 
    +
    666  bytes = Serial::to_bytes(std::move(serial_obj));
    +
    667  }
    +
    668 
    +
    669  protected:
    +
    670  server_interface(server_interface&&) noexcept = default;
    +
    671 
    +
    672 # if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE)
    +
    680  template<typename R, typename... Args>
    +
    681  void dispatch_cached_func(R (*func)(Args...), typename Serial::serial_t& serial_obj)
    +
    682  {
    +
    683  RPC_HPP_PRECONDITION(func != nullptr);
    +
    684 
    +
    685  auto pack = [&serial_obj]
    +
    686  {
    +
    687  try
    +
    688  {
    +
    689  return pack_adapter<Serial>::template deserialize_pack<R, Args...>(serial_obj);
    +
    690  }
    +
    691  catch (const exceptions::rpc_exception&)
    +
    692  {
    +
    693  throw;
    +
    694  }
    +
    695  catch (const std::exception& ex)
    +
    696  {
    +
    697  throw exceptions::deserialization_error(ex.what());
    +
    698  }
    +
    699  }();
    +
    700 
    +
    701  auto& result_cache = get_func_cache<R>(pack.get_func_name());
    +
    702 
    +
    703  if constexpr (!std::is_void_v<R>)
    +
    704  {
    +
    705  auto bytes = Serial::to_bytes(std::move(serial_obj));
    +
    706 
    +
    707  const auto it = result_cache.find(bytes);
    +
    708 
    +
    709  if (it != result_cache.end())
    +
    710  {
    +
    711  pack.set_result(it->second);
    +
    712 
    +
    713  try
    +
    714  {
    +
    715  serial_obj =
    +
    716  pack_adapter<Serial>::template serialize_pack<R, Args...>(pack);
    +
    717  return;
    +
    718  }
    +
    719  catch (const exceptions::rpc_exception&)
    +
    720  {
    +
    721  throw;
    +
    722  }
    +
    723  catch (const std::exception& ex)
    +
    724  {
    +
    725  throw exceptions::serialization_error(ex.what());
    +
    726  }
    +
    727  }
    +
    728 
    +
    729  run_callback(func, pack);
    +
    730  result_cache[std::move(bytes)] = pack.get_result();
    +
    731  }
    +
    732  else
    +
    733  {
    +
    734  run_callback(func, pack);
    +
    735  }
    +
    736 
    +
    737  try
    +
    738  {
    +
    739  serial_obj = pack_adapter<Serial>::template serialize_pack<R, Args...>(pack);
    +
    740  }
    +
    741  catch (const exceptions::rpc_exception&)
    +
    742  {
    +
    743  throw;
    +
    744  }
    +
    745  catch (const std::exception& ex)
    +
    746  {
    +
    747  throw exceptions::serialization_error(ex.what());
    +
    748  }
    +
    749  }
    +
    750 
    +
    751 # else
    +
    752  template<typename R, typename... Args>
    +
    753  void dispatch_cached_func(R (*func)(Args...), typename Serial::serial_t& serial_obj)
    +
    754  {
    +
    755  RPC_HPP_PRECONDITION(func != nullptr);
    +
    756 
    +
    757  dispatch_func(func, serial_obj);
    +
    758  }
    +
    759 # endif
    +
    760 
    +
    767  template<typename R, typename... Args>
    +
    768  static void dispatch_func(R (*func)(Args...), typename Serial::serial_t& serial_obj)
    +
    769  {
    +
    770  RPC_HPP_PRECONDITION(func != nullptr);
    +
    771 
    +
    772  auto pack = [&serial_obj]
    +
    773  {
    +
    774  try
    +
    775  {
    +
    776  return pack_adapter<Serial>::template deserialize_pack<R, Args...>(serial_obj);
    +
    777  }
    +
    778  catch (const exceptions::rpc_exception&)
    +
    779  {
    +
    780  throw;
    +
    781  }
    +
    782  catch (const std::exception& ex)
    +
    783  {
    +
    784  throw exceptions::deserialization_error(ex.what());
    +
    785  }
    +
    786  }();
    +
    787 
    +
    788  run_callback(func, pack);
    +
    789 
    +
    790  try
    +
    791  {
    +
    792  serial_obj = pack_adapter<Serial>::template serialize_pack<R, Args...>(pack);
    +
    793  }
    +
    794  catch (const exceptions::rpc_exception&)
    +
    795  {
    +
    796  throw;
    +
    797  }
    +
    798  catch (const std::exception& ex)
    +
    799  {
    +
    800  throw exceptions::serialization_error(ex.what());
    +
    801  }
    +
    802  }
    +
    803 
    +
    804  private:
    +
    805  virtual void dispatch_impl(typename Serial::serial_t& serial_obj) = 0;
    +
    806 
    +
    813  template<typename R, typename... Args>
    +
    814  static void run_callback(R (*func)(Args...), details::packed_func<R, Args...>& pack)
    +
    815  {
    +
    816  RPC_HPP_PRECONDITION(func != nullptr);
    +
    817 
    +
    818  auto& args = pack.get_args();
    +
    819 
    +
    820  if constexpr (std::is_void_v<R>)
    +
    821  {
    +
    822  try
    +
    823  {
    +
    824  std::apply(func, args);
    +
    825  }
    +
    826  catch (const std::exception& ex)
    +
    827  {
    +
    828  throw exceptions::remote_exec_error(ex.what());
    +
    829  }
    +
    830  }
    +
    831  else
    +
    832  {
    +
    833  try
    +
    834  {
    +
    835  auto result = std::apply(func, args);
    +
    836  pack.set_result(std::move(result));
    +
    837  }
    +
    838  catch (const std::exception& ex)
    +
    839  {
    +
    840  throw exceptions::remote_exec_error(ex.what());
    +
    841  }
    +
    842  }
    +
    843  }
    +
    844 
    +
    845 # if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE)
    +
    846  template<typename Val>
    +
    847  static void* get_func_cache_impl(const std::string& func_name)
    +
    848  {
    +
    849  static std::unordered_map<std::string,
    +
    850  std::unordered_map<typename Serial::bytes_t, Val>>
    +
    851  cache{};
    +
    852 
    +
    853  return &cache[func_name];
    +
    854  }
    +
    855 
    +
    856  template<typename Val>
    +
    857  void update_all_cache(const std::string& func_name)
    +
    858  {
    +
    859  RPC_HPP_PRECONDITION(!func_name.empty());
    +
    860 
    +
    861  m_cache_map.insert_or_assign(func_name, get_func_cache_impl<Val>(func_name));
    +
    862  }
    +
    863 
    +
    864  std::unordered_map<std::string, void*> m_cache_map{};
    +
    865 # endif
    +
    866  };
    +
    867 } // namespace server
    +
    868 #endif
    +
    869 
    +
    870 #if defined(RPC_HPP_CLIENT_IMPL)
    +
    871 # define call_header_func(FUNCNAME, ...) call_header_func_impl(FUNCNAME, # FUNCNAME, __VA_ARGS__)
    +
    872 
    +
    876 inline namespace client
    +
    877 {
    +
    881  template<typename Serial>
    +
    882  class client_interface
    +
    883  {
    +
    884  public:
    +
    885  virtual ~client_interface() noexcept = default;
    +
    886  client_interface() noexcept = default;
    +
    887 
    +
    888  client_interface(const client_interface&) = delete;
    +
    889  client_interface(client_interface&&) noexcept = default;
    +
    890  client_interface& operator=(const client_interface&) = delete;
    +
    891  client_interface& operator=(client_interface&&) = delete;
    +
    892 
    +
    900 
    +
    901  // nodiscard because an expensive remote procedure call is being performed
    +
    902  template<typename R = void, typename... Args>
    +
    903  [[nodiscard]] R call_func(const std::string& func_name, Args&&... args)
    +
    904  {
    +
    905  RPC_HPP_PRECONDITION(!func_name.empty());
    +
    906 
    +
    907  details::packed_func<R, Args...> pack = [&]() noexcept
    +
    908  {
    +
    909  if constexpr (std::is_void_v<R>)
    +
    910  {
    +
    911  return details::packed_func<void, Args...>{ func_name,
    +
    912  std::forward_as_tuple(args...) };
    +
    913  }
    +
    914  else
    +
    915  {
    +
    916  return details::packed_func<R, Args...>{ func_name, std::nullopt,
    +
    917  std::forward_as_tuple(args...) };
    +
    918  }
    +
    919  }();
    +
    920 
    +
    921  auto serial_obj = [&pack]
    +
    922  {
    +
    923  try
    +
    924  {
    +
    925  return pack_adapter<Serial>::serialize_pack(pack);
    +
    926  }
    +
    927  catch (const exceptions::rpc_exception&)
    +
    928  {
    +
    929  throw;
    +
    930  }
    +
    931  catch (const std::exception& ex)
    +
    932  {
    +
    933  throw exceptions::serialization_error(ex.what());
    +
    934  }
    +
    935  }();
    +
    936 
    +
    937  auto bytes = Serial::to_bytes(std::move(serial_obj));
    +
    938 
    +
    939  try
    +
    940  {
    +
    941  send(std::move(bytes));
    +
    942  }
    +
    943  catch (const std::exception& ex)
    +
    944  {
    +
    945  throw exceptions::client_send_error(ex.what());
    +
    946  }
    +
    947 
    +
    948  try
    +
    949  {
    +
    950  bytes = receive();
    +
    951  }
    +
    952  catch (const std::exception& ex)
    +
    953  {
    +
    954  throw exceptions::client_receive_error(ex.what());
    +
    955  }
    +
    956 
    +
    957  serial_obj = Serial::from_bytes(std::move(bytes));
    +
    958 
    +
    959  try
    +
    960  {
    +
    961  pack = pack_adapter<Serial>::template deserialize_pack<R, Args...>(serial_obj);
    +
    962  }
    +
    963  catch (const exceptions::rpc_exception&)
    +
    964  {
    +
    965  throw;
    +
    966  }
    +
    967  catch (const std::exception& ex)
    +
    968  {
    +
    969  throw exceptions::deserialization_error(ex.what());
    +
    970  }
    +
    971 
    +
    972  // Assign values back to any (non-const) reference members
    +
    973  details::tuple_bind(pack.get_args(), std::forward<Args>(args)...);
    +
    974  return pack.get_result();
    +
    975  }
    +
    976 
    +
    984 
    +
    985  // nodiscard because an expensive remote procedure call is being performed
    +
    986  template<typename R = void, typename... Args>
    +
    987  [[nodiscard]] R call_func(std::string&& func_name, Args&&... args)
    +
    988  {
    +
    989  RPC_HPP_PRECONDITION(!func_name.empty());
    +
    990 
    +
    991  details::packed_func<R, Args...> pack = [&]() noexcept
    +
    992  {
    +
    993  if constexpr (std::is_void_v<R>)
    +
    994  {
    +
    995  return details::packed_func<void, Args...>{ std::move(func_name),
    +
    996  std::forward_as_tuple(args...) };
    +
    997  }
    +
    998  else
    +
    999  {
    +
    1000  return details::packed_func<R, Args...>{ std::move(func_name), std::nullopt,
    +
    1001  std::forward_as_tuple(args...) };
    +
    1002  }
    +
    1003  }();
    +
    1004 
    +
    1005  auto serial_obj = [&pack]
    +
    1006  {
    +
    1007  try
    +
    1008  {
    +
    1009  return pack_adapter<Serial>::serialize_pack(pack);
    +
    1010  }
    +
    1011  catch (const exceptions::rpc_exception&)
    +
    1012  {
    +
    1013  throw;
    +
    1014  }
    +
    1015  catch (const std::exception& ex)
    +
    1016  {
    +
    1017  throw exceptions::serialization_error(ex.what());
    +
    1018  }
    +
    1019  }();
    +
    1020 
    +
    1021  auto bytes = Serial::to_bytes(std::move(serial_obj));
    +
    1022 
    +
    1023  try
    +
    1024  {
    +
    1025  send(std::move(bytes));
    +
    1026  }
    +
    1027  catch (const std::exception& ex)
    +
    1028  {
    +
    1029  throw exceptions::client_send_error(ex.what());
    +
    1030  }
    +
    1031 
    +
    1032  try
    +
    1033  {
    +
    1034  bytes = receive();
    +
    1035  }
    +
    1036  catch (const std::exception& ex)
    +
    1037  {
    +
    1038  throw exceptions::client_receive_error(ex.what());
    +
    1039  }
    +
    1040 
    +
    1041  serial_obj = Serial::from_bytes(std::move(bytes));
    +
    1042 
    +
    1043  try
    +
    1044  {
    +
    1045  pack = pack_adapter<Serial>::template deserialize_pack<R, Args...>(serial_obj);
    +
    1046  }
    +
    1047  catch (const exceptions::rpc_exception&)
    +
    1048  {
    +
    1049  throw;
    +
    1050  }
    +
    1051  catch (const std::exception& ex)
    +
    1052  {
    +
    1053  throw exceptions::deserialization_error(ex.what());
    +
    1054  }
    +
    1055 
    +
    1056  // Assign values back to any (non-const) reference members
    +
    1057  details::tuple_bind(pack.get_args(), std::forward<Args>(args)...);
    +
    1058  return pack.get_result();
    +
    1059  }
    +
    1060 
    +
    1061  // nodiscard because an expensive remote procedure call is being performed
    +
    1062  template<typename R, typename... Args>
    +
    1063  [[nodiscard]] R call_header_func_impl(
    +
    1064  [[maybe_unused]] R (*func)(Args...), const std::string& func_name, Args&&... args)
    +
    1065  {
    +
    1066  RPC_HPP_PRECONDITION(!func_name.empty());
    +
    1067 
    +
    1068  return call_func<R, Args...>(func_name, std::forward<Args>(args)...);
    +
    1069  }
    +
    1070 
    +
    1071  // nodiscard because an expensive remote procedure call is being performed
    +
    1072  template<typename R, typename... Args>
    +
    1073  [[nodiscard]] R call_header_func_impl(
    +
    1074  [[maybe_unused]] R (*func)(Args...), std::string&& func_name, Args&&... args)
    +
    1075  {
    +
    1076  RPC_HPP_PRECONDITION(!func_name.empty());
    +
    1077 
    +
    1078  return call_func<R, Args...>(std::move(func_name), std::forward<Args>(args)...);
    +
    1079  }
    +
    1080 
    +
    1081  protected:
    +
    1085  virtual void send(const typename Serial::bytes_t& bytes) = 0;
    +
    1086 
    +
    1090  virtual void send(typename Serial::bytes_t&& bytes) = 0;
    +
    1091 
    +
    1095  virtual typename Serial::bytes_t receive() = 0;
    +
    1096  };
    +
    1097 } // namespace client
    +
    1098 #endif
    +
    1099 } // namespace rpc
    +
    rpc::client::client_interface
    Class defining an interface for calling into an RPC server or module.
    Definition: rpc.hpp:883
    +
    rpc::client::client_interface::call_func
    R call_func(const std::string &func_name, Args &&... args)
    Sends an RPC call request to a server, waits for a response, then returns the result.
    Definition: rpc.hpp:903
    +
    rpc::client::client_interface::call_func
    R call_func(std::string &&func_name, Args &&... args)
    Sends an RPC call request to a server, waits for a response, then returns the result.
    Definition: rpc.hpp:987
    rpc::client::client_interface::send
    virtual void send(const typename Serial::bytes_t &bytes)=0
    Sends serialized data to a server or module.
    rpc::client::client_interface::receive
    virtual Serial::bytes_t receive()=0
    Receives serialized data from a server or module.
    -
    rpc::pack_adapter
    Class collecting several functions for interoperating between serial objects and a packed_func.
    Definition: rpc.hpp:379
    -
    rpc::pack_adapter::deserialize_pack
    static packed_func< R, Args... > deserialize_pack(const typename Serial::serial_t &serial_obj)
    De-serializes a serial object to a packed_func.
    +
    rpc::client::client_interface::send
    virtual void send(typename Serial::bytes_t &&bytes)=0
    Sends serialized data to a server or module.
    +
    rpc::exceptions::client_receive_error
    Definition: rpc.hpp:197
    +
    rpc::exceptions::client_send_error
    Definition: rpc.hpp:183
    +
    rpc::exceptions::deserialization_error
    Definition: rpc.hpp:155
    +
    rpc::exceptions::function_mismatch
    Definition: rpc.hpp:169
    +
    rpc::exceptions::function_not_found
    Definition: rpc.hpp:113
    +
    rpc::exceptions::remote_exec_error
    Definition: rpc.hpp:127
    +
    rpc::exceptions::rpc_exception
    Definition: rpc.hpp:94
    +
    rpc::exceptions::serialization_error
    Definition: rpc.hpp:141
    +
    rpc::exceptions::server_receive_error
    Definition: rpc.hpp:225
    +
    rpc::exceptions::server_send_error
    Definition: rpc.hpp:211
    +
    rpc::pack_adapter
    Class collecting several functions for interoperating between serial objects and a packed_func.
    Definition: rpc.hpp:575
    +
    rpc::pack_adapter::deserialize_pack
    static details::packed_func< R, Args... > deserialize_pack(const typename Serial::serial_t &serial_obj)
    De-serializes a serial object to a packed_func.
    rpc::pack_adapter::get_func_name
    static std::string get_func_name(const typename Serial::serial_t &serial_obj)
    Extracts the function name of a serialized function call.
    -
    rpc::pack_adapter::serialize_pack
    static Serial::serial_t serialize_pack(const packed_func< R, Args... > &pack)
    Serializes a packed_func to a serial object.
    -
    rpc::pack_adapter::set_err_mesg
    static void set_err_mesg(typename Serial::serial_t &serial_obj, std::string mesg)
    Sets the error message for the serialized function call.
    -
    rpc::packed_func< void, Args... >::packed_func
    packed_func(std::string func_name, args_t args)
    Constructs a packed_func.
    Definition: rpc.hpp:368
    -
    rpc::packed_func< void, Args... >::result_t
    void result_t
    Type alias for the return type (void)
    Definition: rpc.hpp:359
    -
    rpc::packed_func
    Object representing a function call, including the function's name, arguments and result.
    Definition: rpc.hpp:295
    -
    rpc::packed_func::clear_result
    void clear_result() &
    Clears the result stored (sets it back to std::nullopt)
    Definition: rpc.hpp:345
    -
    rpc::packed_func::set_result
    void set_result(const R &value) &
    Sets the result to a value.
    Definition: rpc.hpp:342
    -
    rpc::packed_func::get_result
    R get_result() const
    Returns the result, throwing with the error message if it does not exist.
    Definition: rpc.hpp:327
    -
    rpc::packed_func::result_t
    R result_t
    Type alias for the return type.
    Definition: rpc.hpp:298
    -
    rpc::packed_func::packed_func
    packed_func(std::string func_name, std::optional< result_t > result, args_t args)
    Constructs a packed_func.
    Definition: rpc.hpp:308
    -
    rpc::server::server_interface
    Class defining an interface for serving functions via RPC.
    Definition: rpc.hpp:423
    -
    rpc::server::server_interface::dispatch_impl
    virtual void dispatch_impl(typename Serial::serial_t &serial_obj)=0
    Implementation component for the dispatch function.
    -
    rpc::server::server_interface::dispatch_func
    static void dispatch_func(R(*func)(Args...), typename Serial::serial_t &serial_obj)
    Deserializes the serial object to a packed_func, calls the callback function, then serializes the res...
    Definition: rpc.hpp:501
    -
    rpc::server::server_interface::dispatch
    void dispatch(typename Serial::bytes_t &bytes)
    Parses the received serialized data and determines which function to call.
    Definition: rpc.hpp:517
    -
    rpc::server::server_interface::dispatch_cached_func
    static void dispatch_cached_func(R(*func)(Args...), typename Serial::serial_t &serial_obj)
    Deserializes the serial object to a packed_func, calls the callback function, then serializes the res...
    Definition: rpc.hpp:462
    -
    rpc::server::server_interface::run_callback
    static void run_callback(R(*func)(Args...), packed_func< R, Args... > &pack)
    Runs the callback function and updates the result (and any changes to mutable arguments) in the packe...
    Definition: rpc.hpp:436
    -
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:69
    +
    rpc::pack_adapter::serialize_pack
    static Serial::serial_t serialize_pack(const details::packed_func< R, Args... > &pack)
    Serializes a packed_func to a serial object.
    +
    rpc::server::server_interface
    Class defining an interface for serving functions via RPC.
    Definition: rpc.hpp:624
    +
    rpc::server::server_interface::dispatch_func
    static void dispatch_func(R(*func)(Args...), typename Serial::serial_t &serial_obj)
    Deserializes the serial object to a packed_func, calls the callback function, then serializes the res...
    Definition: rpc.hpp:768
    +
    rpc::server::server_interface::dispatch
    void dispatch(typename Serial::bytes_t &bytes)
    Parses the received serialized data and determines which function to call.
    Definition: rpc.hpp:653
    +
    rpc::server::server_interface::dispatch_cached_func
    void dispatch_cached_func(R(*func)(Args...), typename Serial::serial_t &serial_obj)
    Deserializes the serial object to a packed_func, calls the callback function, then serializes the res...
    Definition: rpc.hpp:681
    +
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:73
    diff --git a/docs/rpc__bitsery_8hpp.html b/docs/rpc__bitsery_8hpp.html new file mode 100644 index 00000000..5b59bef9 --- /dev/null +++ b/docs/rpc__bitsery_8hpp.html @@ -0,0 +1,212 @@ + + + + + + + +rpc.hpp: include/rpc_adapters/rpc_bitsery.hpp File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Namespaces | +Typedefs | +Functions | +Variables
    +
    +
    rpc_bitsery.hpp File Reference
    +
    +
    + +

    Implementation of adapting Bitsery serialization (https://github.com/fraillt/bitsery) +More...

    +
    #include "../rpc.hpp"
    +#include <bitsery/bitsery.h>
    +#include <bitsery/adapter/buffer.h>
    +#include <bitsery/ext/std_tuple.h>
    +#include <bitsery/traits/array.h>
    +#include <bitsery/traits/string.h>
    +#include <bitsery/traits/vector.h>
    +#include <vector>
    +
    +Include dependency graph for rpc_bitsery.hpp:
    +
    +
    + + + + + + + + + + + + + + + + + + + + +
    +
    +

    Go to the source code of this file.

    + + + + + + + + + + + + + + + + +

    +Classes

    struct  std::hash< std::vector< uint8_t > >
     
    struct  rpc::adapters::bitsery::details::largest< T, 0 >
     
    struct  rpc::adapters::bitsery::details::largest< T, 3 >
     
    struct  rpc::adapters::bitsery::details::largest< T, 4 >
     
    struct  rpc::adapters::bitsery::details::largest< T, 6 >
     
    struct  rpc::adapters::bitsery::details::pack_helper< R, Args >
     
    struct  rpc::adapters::bitsery::details::pack_helper< void, Args... >
     
    + + + + +

    +Namespaces

     rpc
     Top-level namespace for rpc.hpp classes and functions.
     
    + + + + + + + + + + + + +

    +Typedefs

    +using rpc::adapters::bitsery_adapter = details::serial_adapter< std::vector< uint8_t >, std::vector< std::uint8_t > >
     
    +using rpc::adapters::bitsery::bit_buffer = std::vector< uint8_t >
     
    +using rpc::adapters::bitsery::details::output_adapter = ::bitsery::OutputBufferAdapter< bit_buffer >
     
    +using rpc::adapters::bitsery::details::input_adapter = ::bitsery::InputBufferAdapter< bit_buffer >
     
    +template<typename T >
    using rpc::adapters::bitsery::details::largest_t = typename largest< T >::type
     
    + + + + + + + + + + + + + + +

    +Functions

    +template<typename S , typename R , typename... Args>
    void rpc::adapters::bitsery::details::serialize (S &s, pack_helper< R, Args... > &o)
     
    +template<typename R , typename... Args>
    pack_helper< R, Args... > rpc::adapters::bitsery::details::to_helper (const ::rpc::details::packed_func< R, Args... > &pack)
     
    +template<typename R , typename... Args>
    ::rpc::details::packed_func< R, Args... > rpc::adapters::bitsery::details::from_helper (pack_helper< R, Args... > helper)
     
    +unsigned rpc::adapters::bitsery::details::extract_length (const bit_buffer &bytes, size_t &index)
     
    +void rpc::adapters::bitsery::details::write_length (bit_buffer &bytes, size_t size, size_t &index)
     
    + + + + + + + +

    +Variables

    +const uint64_t rpc::adapters::bitsery::config::max_func_name_size
     
    +const uint64_t rpc::adapters::bitsery::config::max_string_size
     
    +const uint64_t rpc::adapters::bitsery::config::max_container_size
     
    +

    Detailed Description

    +

    Implementation of adapting Bitsery serialization (https://github.com/fraillt/bitsery)

    +
    Author
    Jackson Harmer (jharm.nosp@m.er95.nosp@m.@gmai.nosp@m.l.co.nosp@m.m)
    +
    Copyright
    BSD 3-Clause License
    +

    Copyright (c) 2020-2021, Jackson Harmer All rights reserved.

    +

    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    +
      +
    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
      2. +
    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
      3. +
    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
      4. +
    +

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/rpc__bitsery_8hpp__incl.map b/docs/rpc__bitsery_8hpp__incl.map new file mode 100644 index 00000000..f3d3cf95 --- /dev/null +++ b/docs/rpc__bitsery_8hpp__incl.map @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/docs/rpc__bitsery_8hpp__incl.md5 b/docs/rpc__bitsery_8hpp__incl.md5 new file mode 100644 index 00000000..8b3339c2 --- /dev/null +++ b/docs/rpc__bitsery_8hpp__incl.md5 @@ -0,0 +1 @@ +05f7a832f992aafe9f962909ab790b7f \ No newline at end of file diff --git a/docs/rpc__bitsery_8hpp__incl.png b/docs/rpc__bitsery_8hpp__incl.png new file mode 100644 index 00000000..894dc872 Binary files /dev/null and b/docs/rpc__bitsery_8hpp__incl.png differ diff --git a/docs/rpc__bitsery_8hpp_source.html b/docs/rpc__bitsery_8hpp_source.html new file mode 100644 index 00000000..c8c41862 --- /dev/null +++ b/docs/rpc__bitsery_8hpp_source.html @@ -0,0 +1,576 @@ + + + + + + + +rpc.hpp: include/rpc_adapters/rpc_bitsery.hpp Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    rpc.hpp +  0.7.1 +
    +
    Simple RPC Header-Only Library
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    rpc_bitsery.hpp
    +
    +
    +Go to the documentation of this file.
    1 
    +
    37 #pragma once
    +
    38 
    +
    39 #include "../rpc.hpp"
    +
    40 
    +
    41 #include <bitsery/bitsery.h>
    +
    42 #include <bitsery/adapter/buffer.h>
    +
    43 #include <bitsery/ext/std_tuple.h>
    +
    44 #include <bitsery/traits/array.h>
    +
    45 #include <bitsery/traits/string.h>
    +
    46 #include <bitsery/traits/vector.h>
    +
    47 
    +
    48 #include <vector>
    +
    49 
    +
    50 #if defined(RPC_HPP_ENABLE_SERVER_CACHE)
    +
    51 template<>
    +
    52 struct std::hash<std::vector<uint8_t>>
    +
    53 {
    +
    54  [[nodiscard]] size_t operator()(const std::vector<uint8_t>& vec) const noexcept
    +
    55  {
    +
    56  size_t seed = vec.size();
    +
    57 
    +
    58  for (const auto i : vec)
    +
    59  {
    +
    60  seed ^= static_cast<size_t>(i) + size_t{ 0x9E3779B9UL } + (seed << 6) + (seed >> 2);
    +
    61  }
    +
    62 
    +
    63  return seed;
    +
    64  }
    +
    65 };
    +
    66 #endif
    +
    67 
    +
    68 namespace rpc
    +
    69 {
    +
    70 namespace adapters
    +
    71 {
    +
    72  using bitsery_adapter =
    +
    73  details::serial_adapter<std::vector<uint8_t>, std::vector<std::uint8_t>>;
    +
    74 
    +
    75  namespace bitsery
    +
    76  {
    +
    77  using bit_buffer = std::vector<uint8_t>;
    +
    78 
    +
    79  namespace config
    +
    80  {
    +
    81 #if defined(RPC_HPP_BITSERY_EXACT_SZ)
    +
    82  static constexpr bool use_exact_size = true;
    +
    83 #else
    +
    84  static constexpr bool use_exact_size = false;
    +
    85 #endif
    +
    86 
    +
    87  extern const uint64_t max_func_name_size;
    +
    88  extern const uint64_t max_string_size;
    +
    89  extern const uint64_t max_container_size;
    +
    90  } // namespace config
    +
    91 
    +
    92  namespace details
    +
    93  {
    +
    94  using output_adapter = ::bitsery::OutputBufferAdapter<bit_buffer>;
    +
    95  using input_adapter = ::bitsery::InputBufferAdapter<bit_buffer>;
    +
    96 
    +
    97  // NOTE: This jank can be replaced once C++20 is adopted
    +
    98  template<typename T,
    +
    99  int = std::is_arithmetic_v<T> + std::is_integral_v<T> * 2 + std::is_signed_v<T> * 3>
    +
    100  struct largest;
    +
    101 
    +
    102  template<typename T>
    +
    103  struct largest<T, 0>
    +
    104  {
    +
    105  using type = T;
    +
    106  };
    +
    107 
    +
    108  template<typename T>
    +
    109  struct largest<T, 3>
    +
    110  {
    +
    111  using type = uint64_t;
    +
    112  };
    +
    113 
    +
    114  template<typename T>
    +
    115  struct largest<T, 4>
    +
    116  {
    +
    117  static_assert(!std::is_same_v<T, long double>,
    +
    118  "long double is not supported for RPC bitsery serialization!");
    +
    119  using type = double;
    +
    120  };
    +
    121 
    +
    122  template<typename T>
    +
    123  struct largest<T, 6>
    +
    124  {
    +
    125  using type = int64_t;
    +
    126  };
    +
    127 
    +
    128  template<typename T>
    +
    129  using largest_t = typename largest<T>::type;
    +
    130 
    +
    131  template<typename R, typename... Args>
    +
    132  struct pack_helper
    +
    133  {
    +
    134  static_assert(!std::is_same_v<R, long double>,
    +
    135  "long double is not supported for RPC bitsery serialization!");
    +
    136 
    +
    137 #if defined(RPC_HPP_BITSERY_EXACT_SZ)
    +
    138  using args_t = std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>;
    +
    139 #else
    +
    140  using args_t =
    +
    141  std::tuple<largest_t<std::remove_cv_t<std::remove_reference_t<Args>>>...>;
    +
    142 #endif
    +
    143 
    +
    144  pack_helper() = default;
    +
    145 
    +
    146  int except_type{};
    +
    147  std::string func_name{};
    +
    148  std::string err_mesg{};
    +
    149  R result{};
    +
    150  args_t args{};
    +
    151  };
    +
    152 
    +
    153  template<typename... Args>
    +
    154  struct pack_helper<void, Args...>
    +
    155  {
    +
    156 #if defined(RPC_HPP_BITSERY_EXACT_SZ)
    +
    157  using args_t = std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>;
    +
    158 #else
    +
    159  using args_t =
    +
    160  std::tuple<largest_t<std::remove_cv_t<std::remove_reference_t<Args>>>...>;
    +
    161 #endif
    +
    162 
    +
    163  pack_helper() = default;
    +
    164 
    +
    165  int except_type{};
    +
    166  std::string func_name{};
    +
    167  std::string err_mesg{};
    +
    168  args_t args{};
    +
    169  };
    +
    170 
    +
    171  template<typename S, typename R, typename... Args>
    +
    172  void serialize(S& s, pack_helper<R, Args...>& o)
    +
    173  {
    +
    174  s.template value<sizeof(int)>(o.except_type);
    +
    175  s.text1b(o.func_name, config::max_func_name_size);
    +
    176  s.text1b(o.err_mesg, config::max_string_size);
    +
    177 
    +
    178  if constexpr (std::is_arithmetic_v<R>)
    +
    179  {
    +
    180  s.template value<sizeof(R)>(o.result);
    +
    181  }
    +
    182  else if constexpr (rpc::details::is_container_v<R>)
    +
    183  {
    +
    184  if constexpr (std::is_arithmetic_v<typename R::value_type>)
    +
    185  {
    +
    186  s.template container<sizeof(typename R::value_type)>(
    +
    187  o.result, config::max_container_size);
    +
    188  }
    +
    189  else
    +
    190  {
    +
    191  s.container(o.result, config::max_container_size);
    +
    192  }
    +
    193  }
    +
    194  else if constexpr (!std::is_void_v<R>)
    +
    195  {
    +
    196  s.object(o.result);
    +
    197  }
    +
    198 
    +
    199  s.ext(o.args,
    +
    200  ::bitsery::ext::StdTuple{ [](S& s2, std::string& str)
    +
    201  { s2.text1b(str, config::max_string_size); },
    +
    202  // Fallback serializer for integers, floats, and enums
    +
    203  [](auto& s2, auto& val)
    +
    204  {
    +
    205  using T = std::remove_cv_t<std::remove_reference_t<decltype(val)>>;
    +
    206 
    +
    207  if constexpr (std::is_arithmetic_v<T>)
    +
    208  {
    +
    209  if constexpr (config::use_exact_size)
    +
    210  {
    +
    211  s2.template value<sizeof(val)>(val);
    +
    212  }
    +
    213  else
    +
    214  {
    +
    215  s2.value8b(val);
    +
    216  }
    +
    217  }
    +
    218  else if constexpr (rpc::details::is_container_v<T>)
    +
    219  {
    +
    220  if constexpr (std::is_arithmetic_v<typename T::value_type>)
    +
    221  {
    +
    222  s2.template container<sizeof(typename T::value_type)>(
    +
    223  val, config::max_container_size);
    +
    224  }
    +
    225  else
    +
    226  {
    +
    227  s2.container(val, config::max_container_size);
    +
    228  }
    +
    229  }
    +
    230  else
    +
    231  {
    +
    232  s2.object(val);
    +
    233  }
    +
    234  } });
    +
    235  }
    +
    236 
    +
    237  // nodiscard because a potentially expensive copy and allocation is being done
    +
    238  template<typename R, typename... Args>
    +
    239  [[nodiscard]] pack_helper<R, Args...> to_helper(
    +
    240  const ::rpc::details::packed_func<R, Args...>& pack)
    +
    241  {
    +
    242  pack_helper<R, Args...> helper;
    +
    243 
    +
    244  if (!pack)
    +
    245  {
    +
    246  helper.except_type = static_cast<int>(pack.get_except_type());
    +
    247  helper.err_mesg = pack.get_err_mesg();
    +
    248  }
    +
    249  else
    +
    250  {
    +
    251  if constexpr (!std::is_void_v<R>)
    +
    252  {
    +
    253  helper.result = pack.get_result();
    +
    254  }
    +
    255  }
    +
    256 
    +
    257  helper.func_name = pack.get_func_name();
    +
    258  helper.args = pack.get_args();
    +
    259 
    +
    260  return helper;
    +
    261  }
    +
    262 
    +
    263 #if !defined(RPC_HPP_BITSERY_EXACT_SZ)
    +
    264 # if defined(_MSC_VER)
    +
    265 # pragma warning(push)
    +
    266 # pragma warning(disable : 4244)
    +
    267 # elif defined(__GNUC__)
    +
    268 # pragma GCC diagnostic push
    +
    269 # pragma GCC diagnostic ignored "-Wconversion"
    +
    270 # elif defined(__clang__)
    +
    271 # pragma clang diagnostic push
    +
    272 # pragma clang diagnostic ignored "-Wconversion"
    +
    273 # pragma clang diagnostic ignored "-Wshorten-64-to-32"
    +
    274 # endif
    +
    275 #endif
    +
    276 
    +
    277  // nodiscard because a potentially expensive copy and allocation is being done
    +
    278  template<typename R, typename... Args>
    +
    279  [[nodiscard]] ::rpc::details::packed_func<R, Args...> from_helper(
    +
    280  pack_helper<R, Args...> helper)
    +
    281  {
    +
    282  if constexpr (std::is_void_v<R>)
    +
    283  {
    +
    284  if (helper.except_type == 0)
    +
    285  {
    +
    286  return ::rpc::details::packed_func<void, Args...>{
    +
    287  std::move(helper.func_name), std::move(helper.args)
    +
    288  };
    +
    289  }
    +
    290 
    +
    291  ::rpc::details::packed_func<void, Args...> pack{ std::move(helper.func_name),
    +
    292  std::move(helper.args) };
    +
    293 
    +
    294  pack.set_exception(std::move(helper.err_mesg),
    +
    295  static_cast<exceptions::Type>(helper.except_type));
    +
    296  return pack;
    +
    297  }
    +
    298  else
    +
    299  {
    +
    300  if (helper.err_mesg.empty())
    +
    301  {
    +
    302  return ::rpc::details::packed_func<R, Args...>{ std::move(helper.func_name),
    +
    303  std::move(helper.result), std::move(helper.args) };
    +
    304  }
    +
    305 
    +
    306  ::rpc::details::packed_func<R, Args...> pack{ std::move(helper.func_name),
    +
    307  std::nullopt, std::move(helper.args) };
    +
    308 
    +
    309  pack.set_exception(std::move(helper.err_mesg),
    +
    310  static_cast<exceptions::Type>(helper.except_type));
    +
    311  return pack;
    +
    312  }
    +
    313  }
    +
    314 
    +
    315 #if !defined(RPC_HPP_BITSERY_EXACT_SZ)
    +
    316 # if defined(_MSC_VER)
    +
    317 # pragma warning(pop)
    +
    318 # elif defined(__GNUC__)
    +
    319 # pragma GCC diagnostic pop
    +
    320 # elif defined(__clang__)
    +
    321 # pragma clang diagnostic pop
    +
    322 # endif
    +
    323 #endif
    +
    324 
    +
    325  // Borrowed from Bitsery library for compatibility
    +
    326  inline unsigned extract_length(const bit_buffer& bytes, size_t& index)
    +
    327  {
    +
    328  assert(index < bytes.size());
    +
    329  const uint8_t hb = bytes[index++];
    +
    330 
    +
    331  if (hb < 0x80U)
    +
    332  {
    +
    333  return hb;
    +
    334  }
    +
    335 
    +
    336  assert(index < bytes.size());
    +
    337  const uint8_t lb = bytes[index++];
    +
    338 
    +
    339  if ((hb & 0x40U) != 0U)
    +
    340  {
    +
    341  assert(index < bytes.size());
    +
    342  const uint16_t lw = *reinterpret_cast<const uint16_t*>(&bytes[index++]);
    +
    343 
    +
    344  return ((((hb & 0x3FU) << 8) | lb) << 16) | lw;
    +
    345  }
    +
    346 
    +
    347  return ((hb & 0x7FU) << 8) | lb;
    +
    348  }
    +
    349 
    +
    350  // Borrowed from Bitsery library for compatibility
    +
    351  inline void write_length(bit_buffer& bytes, size_t size, size_t& index)
    +
    352  {
    +
    353  if (size < 0x80U)
    +
    354  {
    +
    355  assert(index < size);
    +
    356  assert(index <= std::numeric_limits<ptrdiff_t>::max());
    +
    357 
    +
    358  bytes.insert(bytes.begin() + static_cast<ptrdiff_t>(index++),
    +
    359  static_cast<uint8_t>(size));
    +
    360  }
    +
    361  else
    +
    362  {
    +
    363  if (size < 0x4000U)
    +
    364  {
    +
    365  bytes.insert(bytes.begin() + static_cast<ptrdiff_t>(index++),
    +
    366  static_cast<uint8_t>((size >> 8) | 0x80U));
    +
    367 
    +
    368  bytes.insert(bytes.begin() + static_cast<ptrdiff_t>(index++),
    +
    369  static_cast<uint8_t>(size));
    +
    370  }
    +
    371  else
    +
    372  {
    +
    373  assert(size < 0x40000000U);
    +
    374 
    +
    375  bytes.insert(bytes.begin() + static_cast<ptrdiff_t>(index++),
    +
    376  static_cast<uint8_t>((size >> 24) | 0xC0U));
    +
    377 
    +
    378  bytes.insert(bytes.begin() + static_cast<ptrdiff_t>(index++),
    +
    379  static_cast<uint8_t>(size >> 16));
    +
    380 
    +
    381  bytes.insert(bytes.begin() + static_cast<ptrdiff_t>(index++),
    +
    382  *reinterpret_cast<const uint8_t*>(&size));
    +
    383 
    +
    384  bytes.insert(bytes.begin() + static_cast<ptrdiff_t>(index++),
    +
    385  *reinterpret_cast<const uint8_t*>(&size) + 1);
    +
    386  }
    +
    387  }
    +
    388  }
    +
    389  } // namespace details
    +
    390  } // namespace bitsery
    +
    391 } // namespace adapters
    +
    392 
    +
    393 template<>
    +
    394 [[nodiscard]] inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::to_bytes(
    +
    395  adapters::bitsery::bit_buffer&& serial_obj)
    +
    396 {
    +
    397  return std::move(serial_obj);
    +
    398 }
    +
    399 
    +
    400 template<>
    +
    401 [[nodiscard]] inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::from_bytes(
    +
    402  adapters::bitsery::bit_buffer&& bytes)
    +
    403 {
    +
    404  return std::move(bytes);
    +
    405 }
    +
    406 
    +
    407 template<>
    +
    408 template<typename R, typename... Args>
    +
    409 [[nodiscard]] adapters::bitsery::bit_buffer pack_adapter<adapters::bitsery_adapter>::serialize_pack(
    +
    410  const ::rpc::details::packed_func<R, Args...>& pack)
    +
    411 {
    +
    412  using namespace adapters::bitsery;
    +
    413 
    +
    414  const auto helper = adapters::bitsery::details::to_helper(pack);
    +
    415 
    +
    416  bit_buffer buffer{};
    +
    417  buffer.reserve(64);
    +
    418 
    +
    419  const auto bytes_written =
    +
    420  bitsery::quickSerialization<adapters::bitsery::details::output_adapter>(buffer, helper);
    +
    421 
    +
    422  buffer.resize(bytes_written);
    +
    423  return buffer;
    +
    424 }
    +
    425 
    +
    426 template<>
    +
    427 template<typename R, typename... Args>
    +
    428 [[nodiscard]] ::rpc::details::packed_func<R, Args...> pack_adapter<
    +
    429  adapters::bitsery_adapter>::deserialize_pack(const adapters::bitsery::bit_buffer& serial_obj)
    +
    430 {
    +
    431  using namespace adapters::bitsery;
    +
    432 
    +
    433  adapters::bitsery::details::pack_helper<R, Args...> helper;
    +
    434 
    +
    435  const auto [error, success] = bitsery::quickDeserialization(
    +
    436  adapters::bitsery::details::input_adapter{ serial_obj.begin(), serial_obj.size() }, helper);
    +
    437 
    +
    438  if (error != bitsery::ReaderError::NoError)
    +
    439  {
    +
    440  switch (error)
    +
    441  {
    +
    442  case bitsery::ReaderError::ReadingError:
    +
    443  throw rpc::exceptions::deserialization_error(
    +
    444  "Bitsery deserialization failed due to a reading error");
    +
    445 
    +
    446  case bitsery::ReaderError::DataOverflow:
    +
    447  throw rpc::exceptions::function_mismatch(
    +
    448  "Bitsery deserialization failed due to data overflow (likely mismatched "
    +
    449  "function signature)");
    +
    450 
    +
    451  case bitsery::ReaderError::InvalidData:
    +
    452  throw rpc::exceptions::deserialization_error(
    +
    453  "Bitsery deserialization failed due to a invalid data");
    +
    454 
    +
    455  case bitsery::ReaderError::InvalidPointer:
    +
    456  throw rpc::exceptions::deserialization_error(
    +
    457  "Bitsery deserialization failed due to an invalid pointer");
    +
    458 
    +
    459  case bitsery::ReaderError::NoError:
    +
    460  default:
    +
    461  throw rpc::exceptions::deserialization_error(
    +
    462  "Bitsery deserialization failed due to extra data on the end");
    +
    463  }
    +
    464  }
    +
    465 
    +
    466  return adapters::bitsery::details::from_helper(helper);
    +
    467 }
    +
    468 
    +
    469 template<>
    +
    470 [[nodiscard]] inline std::string pack_adapter<adapters::bitsery_adapter>::get_func_name(
    +
    471  const adapters::bitsery::bit_buffer& serial_obj)
    +
    472 {
    +
    473  size_t index = sizeof(int);
    +
    474  const auto len = adapters::bitsery::details::extract_length(serial_obj, index);
    +
    475 
    +
    476  assert(index < serial_obj.size());
    +
    477  assert(index <= std::numeric_limits<ptrdiff_t>::max());
    +
    478  return { serial_obj.begin() + static_cast<ptrdiff_t>(index),
    +
    479  serial_obj.begin() + static_cast<ptrdiff_t>(index + len) };
    +
    480 }
    +
    481 
    +
    482 template<>
    +
    483 inline void pack_adapter<adapters::bitsery_adapter>::set_exception(
    +
    484  adapters::bitsery::bit_buffer& serial_obj, const rpc::exceptions::rpc_exception& ex)
    +
    485 {
    +
    486  // copy except_type into buffer
    +
    487  const int ex_type = static_cast<int>(ex.get_type());
    +
    488  memcpy(&serial_obj[0], &ex_type, sizeof(int));
    +
    489 
    +
    490  const std::string_view mesg = ex.what();
    +
    491 
    +
    492  size_t index = sizeof(int);
    +
    493  const auto name_len = adapters::bitsery::details::extract_length(serial_obj, index);
    +
    494  const size_t name_sz_len = index;
    +
    495 
    +
    496  index += name_len;
    +
    497  const auto err_len = adapters::bitsery::details::extract_length(serial_obj, index);
    +
    498  const auto new_err_len = static_cast<unsigned>(mesg.size());
    +
    499 
    +
    500  if (new_err_len != err_len)
    +
    501  {
    +
    502  if (err_len != 0)
    +
    503  {
    +
    504  assert(index < serial_obj.size());
    +
    505  assert(index <= std::numeric_limits<ptrdiff_t>::max());
    +
    506 
    +
    507  serial_obj.erase(serial_obj.begin() + static_cast<ptrdiff_t>(name_sz_len)
    +
    508  + static_cast<ptrdiff_t>(name_len),
    +
    509  serial_obj.begin() + static_cast<ptrdiff_t>(index + err_len));
    +
    510  }
    +
    511 
    +
    512  index = name_sz_len + name_len;
    +
    513  adapters::bitsery::details::write_length(serial_obj, new_err_len, index);
    +
    514  }
    +
    515 
    +
    516  for (unsigned i = 0; i < new_err_len; ++i)
    +
    517  {
    +
    518  assert(index < serial_obj.size());
    +
    519  assert(index <= std::numeric_limits<ptrdiff_t>::max());
    +
    520 
    +
    521  serial_obj.insert(serial_obj.begin() + static_cast<ptrdiff_t>(index++),
    +
    522  static_cast<unsigned char>(mesg[i]));
    +
    523  }
    +
    524 }
    +
    525 } // namespace rpc
    +
    rpc::exceptions::deserialization_error
    Definition: rpc.hpp:155
    +
    rpc::exceptions::function_mismatch
    Definition: rpc.hpp:169
    +
    rpc::exceptions::rpc_exception
    Definition: rpc.hpp:94
    +
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:73
    +
    rpc::adapters::bitsery::details::largest
    Definition: rpc_bitsery.hpp:100
    +
    rpc::adapters::bitsery::details::pack_helper
    Definition: rpc_bitsery.hpp:133
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/rpc__boost__json_8hpp.html b/docs/rpc__boost__json_8hpp.html index b99af990..d230087b 100644 --- a/docs/rpc__boost__json_8hpp.html +++ b/docs/rpc__boost__json_8hpp.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -86,18 +86,18 @@
    - - - - - - - - - - - - + + + + + + + + + + + +
    @@ -111,26 +111,41 @@ - - - - - - + + + + + +

    Typedefs

    -using rpc::adapters::bjson_obj = bjson::object
     
    -using rpc::adapters::bjson_val = bjson::value
     
    -using rpc::adapters::bjson_adapter = details::serial_adapter< bjson_val, std::string >
     
    +using rpc::adapters::boost_json_adapter = rpc::details::serial_adapter< boost::json::value, std::string >
     
    +using rpc::adapters::boost_json::object_t = boost::json::object
     
    +using rpc::adapters::boost_json::value_t = boost::json::value
     
    - - - - + + + + - - + + + + + + + + + + +

    Functions

    +
    template<typename T >
    void rpc::adapters::push_arg (T &&arg, bjson::array &arg_arr)
     
    +
    constexpr bool rpc::adapters::boost_json::details::validate_arg (const value_t &arg)
     
    +void rpc::adapters::boost_json::details::throw_mismatch (std::string &&expect_type, const value_t &obj) noexcept(false)
     
    template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::parse_arg (const bjson_val &arg_arr, unsigned &index)
     
    void rpc::adapters::boost_json::details::push_args (T &&arg, boost::json::array &obj)
     
    +template<typename T >
    void rpc::adapters::boost_json::details::push_arg (T &&arg, value_t &obj)
     
    +template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::boost_json::details::parse_args (const value_t &arg_arr, unsigned &index)
     
    +template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::boost_json::details::parse_arg (const value_t &arg)
     

    Detailed Description

    Implementation of adapting Boost.JSON (https://github.com/boostorg/json)

    diff --git a/docs/rpc__boost__json_8hpp__incl.map b/docs/rpc__boost__json_8hpp__incl.map index 79b4ec54..7f960d3b 100644 --- a/docs/rpc__boost__json_8hpp__incl.map +++ b/docs/rpc__boost__json_8hpp__incl.map @@ -1,14 +1,14 @@ - - - - - - - - - - - - + + + + + + + + + + + + diff --git a/docs/rpc__boost__json_8hpp__incl.md5 b/docs/rpc__boost__json_8hpp__incl.md5 index 423d0ad5..850d5edc 100644 --- a/docs/rpc__boost__json_8hpp__incl.md5 +++ b/docs/rpc__boost__json_8hpp__incl.md5 @@ -1 +1 @@ -20b7c1aaa333ab396df95350f3fda74d \ No newline at end of file +57e8aab1689cd159565d946f03dc64df \ No newline at end of file diff --git a/docs/rpc__boost__json_8hpp__incl.png b/docs/rpc__boost__json_8hpp__incl.png index 1e6ae377..0fb27cbc 100644 Binary files a/docs/rpc__boost__json_8hpp__incl.png and b/docs/rpc__boost__json_8hpp__incl.png differ diff --git a/docs/rpc__boost__json_8hpp_source.html b/docs/rpc__boost__json_8hpp_source.html index d83d6a38..424bc9f2 100644 --- a/docs/rpc__boost__json_8hpp_source.html +++ b/docs/rpc__boost__json_8hpp_source.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -74,277 +74,333 @@ Go to the documentation of this file.
    1 
    37 #pragma once
    38 
    -
    39 #if !defined(RPC_HPP_ENABLE_BOOST_JSON)
    -
    40 # error 'rpc_boost_json' was included without defining 'RPC_HPP_ENABLE_BOOST_JSON' Please define this macro or do not include this header!
    -
    41 #endif
    +
    39 #include "../rpc.hpp"
    +
    40 
    +
    41 #include <cassert>
    42 
    -
    43 #include "../rpc.hpp"
    +
    43 #include <boost/json/src.hpp>
    44 
    -
    45 #include <cassert>
    -
    46 
    -
    47 #include <boost/json/src.hpp>
    -
    48 
    -
    49 namespace rpc
    -
    50 {
    -
    51 namespace adapters
    -
    52 {
    -
    53  namespace bjson = boost::json;
    -
    54  using bjson_obj = bjson::object;
    -
    55  using bjson_val = bjson::value;
    -
    56  using bjson_adapter = details::serial_adapter<bjson_val, std::string>;
    -
    57 
    -
    58  template<typename T>
    -
    59  void push_arg(T&& arg, bjson::array& arg_arr)
    -
    60  {
    -
    61  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    -
    62 
    -
    63  if constexpr (std::is_arithmetic_v<no_ref_t>)
    -
    64  {
    -
    65  arg_arr.push_back(std::forward<T>(arg));
    -
    66  }
    -
    67  else if constexpr (std::is_same_v<no_ref_t, std::string>)
    -
    68  {
    -
    69  arg_arr.push_back(bjson::string{ arg.c_str() });
    -
    70  }
    -
    71  else if constexpr (details::is_container_v<no_ref_t>)
    -
    72  {
    -
    73  bjson::array arr;
    -
    74 
    -
    75  for (auto&& val : arg)
    -
    76  {
    -
    77  push_arg(std::forward<decltype(val)>(val), arr);
    -
    78  }
    -
    79 
    -
    80  arg_arr.push_back(arr);
    -
    81  }
    -
    82  else if constexpr (details::is_serializable_v<bjson_adapter, no_ref_t>)
    -
    83  {
    -
    84  arg_arr.push_back(no_ref_t::template serialize<bjson_adapter>(std::forward<T>(arg)));
    -
    85  }
    -
    86  else
    -
    87  {
    -
    88  arg_arr.push_back(bjson_adapter::template serialize<no_ref_t>(std::forward<T>(arg)));
    -
    89  }
    -
    90  }
    -
    91 
    -
    92  template<typename T>
    -
    93  std::remove_cv_t<std::remove_reference_t<T>> parse_arg(
    -
    94  const bjson_val& arg_arr, unsigned& index)
    -
    95  {
    -
    96  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    -
    97 
    -
    98  const auto& arg = arg_arr.is_array() ? arg_arr.as_array().at(index++) : arg_arr;
    -
    99 
    -
    100  if constexpr (std::is_arithmetic_v<no_ref_t> || std::is_same_v<no_ref_t, std::string>)
    -
    101  {
    -
    102  return bjson::value_to<no_ref_t>(arg);
    -
    103  }
    -
    104  else if constexpr (details::is_container_v<no_ref_t>)
    -
    105  {
    -
    106  using value_t = typename no_ref_t::value_type;
    -
    107 
    -
    108  auto& arr = arg.as_array();
    -
    109  no_ref_t container;
    -
    110  container.reserve(arr.size());
    -
    111 
    -
    112  unsigned j = 0;
    -
    113 
    -
    114  for (const auto& val : arr)
    -
    115  {
    -
    116  container.push_back(parse_arg<value_t>(val, j));
    -
    117  }
    +
    45 namespace rpc
    +
    46 {
    +
    47 namespace adapters
    +
    48 {
    +
    49  using boost_json_adapter = rpc::details::serial_adapter<boost::json::value, std::string>;
    +
    50 
    +
    51  namespace boost_json
    +
    52  {
    +
    53  using object_t = boost::json::object;
    +
    54  using value_t = boost::json::value;
    +
    55 
    +
    56  namespace details
    +
    57  {
    +
    58  template<typename T>
    +
    59  [[nodiscard]] constexpr bool validate_arg(const value_t& arg)
    +
    60  {
    +
    61  if constexpr (std::is_same_v<T, bool>)
    +
    62  {
    +
    63  return arg.is_bool();
    +
    64  }
    +
    65  else if constexpr (std::is_integral_v<T>)
    +
    66  {
    +
    67  if constexpr (std::is_signed_v<T>)
    +
    68  {
    +
    69  return arg.is_int64();
    +
    70  }
    +
    71  else
    +
    72  {
    +
    73  return arg.is_uint64();
    +
    74  }
    +
    75  }
    +
    76  else if constexpr (std::is_floating_point_v<T>)
    +
    77  {
    +
    78  return arg.is_double();
    +
    79  }
    +
    80  else if constexpr (std::is_same_v<T, std::string>)
    +
    81  {
    +
    82  return arg.is_string();
    +
    83  }
    +
    84  else if constexpr (rpc::details::is_container_v<T>)
    +
    85  {
    +
    86  return arg.is_array();
    +
    87  }
    +
    88  else
    +
    89  {
    +
    90  return !arg.is_null();
    +
    91  }
    +
    92  }
    +
    93 
    +
    94  [[noreturn]] inline void throw_mismatch(
    +
    95  std::string&& expect_type, const value_t& obj) noexcept(false)
    +
    96  {
    +
    97  std::string type_str = [&obj]
    +
    98  {
    +
    99  switch (obj.kind())
    +
    100  {
    +
    101  case boost::json::kind::bool_:
    +
    102  return "bool";
    +
    103 
    +
    104  case boost::json::kind::int64:
    +
    105  return "int64";
    +
    106 
    +
    107  case boost::json::kind::uint64:
    +
    108  return "uint64";
    +
    109 
    +
    110  case boost::json::kind::double_:
    +
    111  return "double";
    +
    112 
    +
    113  case boost::json::kind::string:
    +
    114  return "string";
    +
    115 
    +
    116  case boost::json::kind::array:
    +
    117  return "array";
    118 
    -
    119  return container;
    -
    120  }
    -
    121  else if constexpr (details::is_serializable_v<bjson_adapter, no_ref_t>)
    -
    122  {
    -
    123  return no_ref_t::template deserialize<bjson_adapter>(arg);
    -
    124  }
    -
    125  else
    -
    126  {
    -
    127  return bjson_adapter::template deserialize<no_ref_t>(arg);
    -
    128  }
    -
    129  }
    -
    130 } // namespace adapters
    +
    119  case boost::json::kind::object:
    +
    120  return "object";
    +
    121 
    +
    122  default:
    +
    123  case boost::json::kind::null:
    +
    124  return "null";
    +
    125  }
    +
    126  }();
    +
    127 
    +
    128  throw exceptions::function_mismatch("Boost.JSON expected type: "
    +
    129  + std::move(expect_type) + ", got type: " + std::move(type_str));
    +
    130  }
    131 
    -
    132 template<>
    -
    133 inline std::string adapters::bjson_adapter::to_bytes(adapters::bjson_val serial_obj)
    -
    134 {
    -
    135  return adapters::bjson::serialize(std::move(serial_obj));
    -
    136 }
    -
    137 
    -
    138 template<>
    -
    139 inline adapters::bjson_val adapters::bjson_adapter::from_bytes(std::string bytes)
    -
    140 {
    -
    141  return adapters::bjson::parse(std::move(bytes));
    -
    142 }
    -
    143 
    -
    144 template<>
    -
    145 template<typename R, typename... Args>
    -
    146 adapters::bjson_val pack_adapter<adapters::bjson_adapter>::serialize_pack(
    -
    147  const packed_func<R, Args...>& pack)
    -
    148 {
    -
    149  using namespace adapters;
    -
    150 
    -
    151  bjson_obj ret_j;
    -
    152 
    -
    153  ret_j["func_name"] = pack.get_func_name();
    -
    154 
    -
    155  const auto err_mesg = pack.get_err_mesg();
    -
    156 
    -
    157  if (!err_mesg.empty())
    -
    158  {
    -
    159  ret_j["err_mesg"] = err_mesg;
    -
    160  }
    -
    161 
    -
    162  if constexpr (!std::is_void_v<R>)
    -
    163  {
    -
    164  ret_j["result"] = nullptr;
    -
    165  auto& result = ret_j["result"];
    -
    166 
    -
    167  if (pack)
    -
    168  {
    -
    169  if constexpr (std::is_arithmetic_v<R> || std::is_same_v<R, std::string>)
    -
    170  {
    -
    171  result = pack.get_result();
    -
    172  }
    -
    173  else if constexpr (details::is_container_v<R>)
    +
    132  template<typename T>
    +
    133  void push_args(T&& arg, boost::json::array& obj);
    +
    134 
    +
    135  template<typename T>
    +
    136  void push_arg(T&& arg, value_t& obj)
    +
    137  {
    +
    138  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    +
    139 
    +
    140  if constexpr (std::is_arithmetic_v<no_ref_t>)
    +
    141  {
    +
    142  obj = std::forward<T>(arg);
    +
    143  }
    +
    144  else if constexpr (std::is_same_v<no_ref_t, std::string>)
    +
    145  {
    +
    146  obj = boost::json::string{ arg.c_str() };
    +
    147  }
    +
    148  else if constexpr (rpc::details::is_container_v<no_ref_t>)
    +
    149  {
    +
    150  obj = boost::json::array{};
    +
    151  auto& arr = obj.as_array();
    +
    152  arr.reserve(arg.size());
    +
    153 
    +
    154  for (auto&& val : arg)
    +
    155  {
    +
    156  push_args(std::forward<decltype(val)>(val), arr);
    +
    157  }
    +
    158  }
    +
    159  else if constexpr (rpc::details::is_serializable_v<adapters::boost_json_adapter,
    +
    160  no_ref_t>)
    +
    161  {
    +
    162  obj = no_ref_t::template serialize<adapters::boost_json_adapter>(
    +
    163  std::forward<T>(arg));
    +
    164  }
    +
    165  else
    +
    166  {
    +
    167  obj = adapters::boost_json_adapter::template serialize<no_ref_t>(
    +
    168  std::forward<T>(arg));
    +
    169  }
    +
    170  }
    +
    171 
    +
    172  template<typename T>
    +
    173  void push_args(T&& arg, boost::json::array& obj_arr)
    174  {
    -
    175  result = bjson::array{};
    -
    176  const auto container = pack.get_result();
    -
    177 
    -
    178  for (const auto& val : container)
    -
    179  {
    -
    180  result.as_array().push_back(val);
    -
    181  }
    -
    182  }
    -
    183  else if constexpr (details::is_serializable_v<bjson_adapter, R>)
    -
    184  {
    -
    185  result = R::template serialize<bjson_adapter>(pack.get_result());
    -
    186  }
    -
    187  else
    -
    188  {
    -
    189  result = bjson_adapter::template serialize<R>(pack.get_result());
    -
    190  }
    -
    191  }
    -
    192  }
    +
    175  value_t tmp{};
    +
    176  push_arg(std::forward<T>(arg), tmp);
    +
    177  obj_arr.push_back(std::move(tmp));
    +
    178  }
    +
    179 
    +
    180  template<typename T>
    +
    181  std::remove_cv_t<std::remove_reference_t<T>> parse_args(
    +
    182  const value_t& arg_arr, unsigned& index);
    +
    183 
    +
    184  template<typename T>
    +
    185  [[nodiscard]] std::remove_cv_t<std::remove_reference_t<T>> parse_arg(const value_t& arg)
    +
    186  {
    +
    187  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    +
    188 
    +
    189  if (!validate_arg<T>(arg))
    +
    190  {
    +
    191  throw_mismatch(typeid(no_ref_t).name(), arg);
    +
    192  }
    193 
    -
    194  bjson::array args{};
    -
    195 
    -
    196  const auto& argTup = pack.get_args();
    -
    197  details::for_each_tuple(
    -
    198  argTup, [&args](auto&& x) { push_arg(std::forward<decltype(x)>(x), args); });
    -
    199 
    -
    200  ret_j["args"] = std::move(args);
    -
    201  return ret_j;
    -
    202 }
    -
    203 
    -
    204 template<>
    -
    205 template<typename R, typename... Args>
    -
    206 packed_func<R, Args...> pack_adapter<adapters::bjson_adapter>::deserialize_pack(
    -
    207  const adapters::bjson_val& serial_obj)
    -
    208 {
    -
    209  using namespace adapters;
    -
    210 
    -
    211  assert(serial_obj.is_object());
    -
    212  const auto& obj = serial_obj.as_object();
    -
    213  [[maybe_unused]] unsigned i = 0;
    -
    214 
    -
    215  auto& args_val = obj.at("args");
    -
    216 
    -
    217  typename packed_func<R, Args...>::args_t args{ parse_arg<Args>(args_val, i)... };
    -
    218 
    -
    219  if constexpr (std::is_void_v<R>)
    -
    220  {
    -
    221  packed_func<void, Args...> pack(obj.at("func_name").get_string().c_str(), std::move(args));
    -
    222 
    -
    223  if (obj.contains("err_mesg"))
    -
    224  {
    -
    225  pack.set_err_mesg(obj.at("err_mesg").get_string().c_str());
    -
    226  }
    -
    227 
    -
    228  return pack;
    -
    229  }
    -
    230  else
    -
    231  {
    -
    232  if (obj.contains("result") && !obj.at("result").is_null())
    -
    233  {
    -
    234  const auto& result = obj.at("result");
    +
    194  if constexpr (std::is_arithmetic_v<
    +
    195  no_ref_t> || std::is_same_v<no_ref_t, std::string>)
    +
    196  {
    +
    197  return boost::json::value_to<no_ref_t>(arg);
    +
    198  }
    +
    199  else if constexpr (rpc::details::is_container_v<no_ref_t>)
    +
    200  {
    +
    201  using subvalue_t = typename no_ref_t::value_type;
    +
    202 
    +
    203  auto& arr = arg.as_array();
    +
    204  no_ref_t container{};
    +
    205  container.reserve(arr.size());
    +
    206 
    +
    207  unsigned j = 0;
    +
    208 
    +
    209  for (const auto& val : arr)
    +
    210  {
    +
    211  container.push_back(parse_args<subvalue_t>(val, j));
    +
    212  }
    +
    213 
    +
    214  return container;
    +
    215  }
    +
    216  else if constexpr (rpc::details::is_serializable_v<adapters::boost_json_adapter,
    +
    217  no_ref_t>)
    +
    218  {
    +
    219  return no_ref_t::template deserialize<adapters::boost_json_adapter>(arg);
    +
    220  }
    +
    221  else
    +
    222  {
    +
    223  return adapters::boost_json_adapter::template deserialize<no_ref_t>(arg);
    +
    224  }
    +
    225  }
    +
    226 
    +
    227  template<typename T>
    +
    228  [[nodiscard]] std::remove_cv_t<std::remove_reference_t<T>> parse_args(
    +
    229  const value_t& arg_arr, unsigned& index)
    +
    230  {
    +
    231  if (index >= arg_arr.as_array().size())
    +
    232  {
    +
    233  throw exceptions::function_mismatch("Argument count mismatch");
    +
    234  }
    235 
    -
    236  if constexpr (std::is_arithmetic_v<R>)
    -
    237  {
    -
    238  return packed_func<R, Args...>(obj.at("func_name").get_string().c_str(),
    -
    239  bjson::value_to<R>(result), std::move(args));
    -
    240  }
    -
    241  else if constexpr (std::is_same_v<R, std::string>)
    -
    242  {
    -
    243  return packed_func<R, Args...>(obj.at("func_name").get_string().c_str(),
    -
    244  result.get_string().c_str(), std::move(args));
    -
    245  }
    -
    246  else if constexpr (details::is_container_v<R>)
    -
    247  {
    -
    248  using value_t = typename R::value_type;
    +
    236  const auto& arg = arg_arr.is_array() ? arg_arr.as_array().at(index++) : arg_arr;
    +
    237  return parse_arg<T>(arg);
    +
    238  }
    +
    239  } // namespace details
    +
    240  } // namespace boost_json
    +
    241 } // namespace adapters
    +
    242 
    +
    243 template<>
    +
    244 [[nodiscard]] inline std::string adapters::boost_json_adapter::to_bytes(
    +
    245  adapters::boost_json::value_t&& serial_obj)
    +
    246 {
    +
    247  return boost::json::serialize(std::move(serial_obj));
    +
    248 }
    249 
    -
    250  auto& arr = result.as_array();
    -
    251  R container;
    -
    252  container.reserve(arr.size());
    -
    253 
    -
    254  unsigned j = 0;
    -
    255 
    -
    256  for (const auto& val : arr)
    -
    257  {
    -
    258  container.push_back(parse_arg<value_t>(val, j));
    -
    259  }
    -
    260 
    -
    261  return packed_func<R, Args...>(
    -
    262  obj.at("func_name").get_string().c_str(), container, std::move(args));
    -
    263  }
    -
    264  else if constexpr (details::is_serializable_v<bjson_adapter, R>)
    -
    265  {
    -
    266  return packed_func<R, Args...>(obj.at("func_name").get_string().c_str(),
    -
    267  R::template deserialize<bjson_adapter>(result), std::move(args));
    -
    268  }
    -
    269  else
    -
    270  {
    -
    271  return packed_func<R, Args...>(obj.at("func_name").get_string().c_str(),
    -
    272  bjson_adapter::template deserialize<R>(result), std::move(args));
    -
    273  }
    -
    274  }
    -
    275 
    -
    276  packed_func<R, Args...> pack(
    -
    277  obj.at("func_name").get_string().c_str(), std::nullopt, std::move(args));
    -
    278 
    -
    279  if (obj.contains("err_mesg"))
    -
    280  {
    -
    281  pack.set_err_mesg(obj.at("err_mesg").get_string().c_str());
    -
    282  }
    -
    283 
    -
    284  return pack;
    -
    285  }
    -
    286 }
    -
    287 
    -
    288 template<>
    -
    289 inline std::string pack_adapter<adapters::bjson_adapter>::get_func_name(
    -
    290  const adapters::bjson_val& serial_obj)
    -
    291 {
    -
    292  assert(serial_obj.is_object());
    -
    293  return serial_obj.at("func_name").get_string().c_str();
    -
    294 }
    -
    295 
    -
    296 template<>
    -
    297 inline void pack_adapter<adapters::bjson_adapter>::set_err_mesg(
    -
    298  adapters::bjson_val& serial_obj, std::string mesg)
    -
    299 {
    -
    300  assert(serial_obj.is_object());
    -
    301  auto& obj = serial_obj.as_object();
    -
    302  obj["err_mesg"] = std::move(mesg);
    -
    303 }
    -
    304 } // namespace rpc
    -
    rpc::pack_adapter::deserialize_pack
    static packed_func< R, Args... > deserialize_pack(const typename Serial::serial_t &serial_obj)
    De-serializes a serial object to a packed_func.
    +
    250 template<>
    +
    251 [[nodiscard]] inline adapters::boost_json::value_t adapters::boost_json_adapter::from_bytes(
    +
    252  std::string&& bytes)
    +
    253 {
    +
    254  return boost::json::parse(std::move(bytes));
    +
    255 }
    +
    256 
    +
    257 template<>
    +
    258 template<typename R, typename... Args>
    +
    259 [[nodiscard]] adapters::boost_json::value_t pack_adapter<adapters::boost_json_adapter>::
    +
    260  serialize_pack(const ::rpc::details::packed_func<R, Args...>& pack)
    +
    261 {
    +
    262  using namespace adapters::boost_json;
    +
    263 
    +
    264  object_t obj{};
    +
    265  obj["func_name"] = pack.get_func_name();
    +
    266 
    +
    267  auto& args = obj["args"].emplace_array();
    +
    268  args.reserve(sizeof...(Args));
    +
    269 
    +
    270  const auto& argTup = pack.get_args();
    +
    271  rpc::details::for_each_tuple(argTup,
    +
    272  [&args](auto&& x)
    +
    273  { adapters::boost_json::details::push_args(std::forward<decltype(x)>(x), args); });
    +
    274 
    +
    275  if (!pack)
    +
    276  {
    +
    277  obj["except_type"] = static_cast<int>(pack.get_except_type());
    +
    278  obj["err_mesg"] = pack.get_err_mesg();
    +
    279  }
    +
    280  else
    +
    281  {
    +
    282  if constexpr (!std::is_void_v<R>)
    +
    283  {
    +
    284  obj["result"] = {};
    +
    285  adapters::boost_json::details::push_arg(pack.get_result(), obj.at("result"));
    +
    286  }
    +
    287  }
    +
    288 
    +
    289  return obj;
    +
    290 }
    +
    291 
    +
    292 template<>
    +
    293 template<typename R, typename... Args>
    +
    294 [[nodiscard]] ::rpc::details::packed_func<R, Args...> pack_adapter<
    +
    295  adapters::boost_json_adapter>::deserialize_pack(const adapters::boost_json::value_t& serial_obj)
    +
    296 {
    +
    297  using namespace adapters::boost_json;
    +
    298 
    +
    299  RPC_HPP_PRECONDITION(serial_obj.is_object());
    +
    300 
    +
    301  const auto& obj = serial_obj.get_object();
    +
    302  [[maybe_unused]] unsigned i = 0;
    +
    303 
    +
    304  auto& args_val = obj.at("args");
    +
    305 
    +
    306  if constexpr (std::is_void_v<R>)
    +
    307  {
    +
    308  ::rpc::details::packed_func<void, Args...> pack(obj.at("func_name").get_string().c_str(),
    +
    309  { adapters::boost_json::details::parse_args<Args>(args_val, i)... });
    +
    310 
    +
    311  if (obj.contains("except_type"))
    +
    312  {
    +
    313  pack.set_exception(obj.at("err_mesg").get_string().c_str(),
    +
    314  static_cast<exceptions::Type>(obj.at("except_type").get_int64()));
    +
    315  }
    +
    316 
    +
    317  return pack;
    +
    318  }
    +
    319  else
    +
    320  {
    +
    321  if (obj.contains("result") && !obj.at("result").is_null())
    +
    322  {
    +
    323  return ::rpc::details::packed_func<R, Args...>(obj.at("func_name").get_string().c_str(),
    +
    324  adapters::boost_json::details::parse_arg<R>(obj.at("result")),
    +
    325  { adapters::boost_json::details::parse_args<Args>(obj.at("args"), i)... });
    +
    326  }
    +
    327 
    +
    328  ::rpc::details::packed_func<R, Args...> pack(obj.at("func_name").get_string().c_str(),
    +
    329  std::nullopt,
    +
    330  { adapters::boost_json::details::parse_args<Args>(obj.at("args"), i)... });
    +
    331 
    +
    332  if (obj.contains("except_type"))
    +
    333  {
    +
    334  pack.set_exception(obj.at("err_mesg").get_string().c_str(),
    +
    335  static_cast<exceptions::Type>(obj.at("except_type").get_int64()));
    +
    336  }
    +
    337 
    +
    338  return pack;
    +
    339  }
    +
    340 }
    +
    341 
    +
    342 template<>
    +
    343 [[nodiscard]] inline std::string pack_adapter<adapters::boost_json_adapter>::get_func_name(
    +
    344  const adapters::boost_json::value_t& serial_obj)
    +
    345 {
    +
    346  RPC_HPP_PRECONDITION(serial_obj.is_object());
    +
    347 
    +
    348  return { serial_obj.at("func_name").get_string().c_str() };
    +
    349 }
    +
    350 
    +
    351 template<>
    +
    352 inline void pack_adapter<adapters::boost_json_adapter>::set_exception(
    +
    353  adapters::boost_json::value_t& serial_obj, const rpc::exceptions::rpc_exception& ex)
    +
    354 {
    +
    355  RPC_HPP_PRECONDITION(serial_obj.is_object());
    +
    356 
    +
    357  auto& obj = serial_obj.get_object();
    +
    358  obj["except_type"] = static_cast<int>(ex.get_type());
    +
    359  obj["err_mesg"] = boost::json::string{ ex.what() };
    +
    360 }
    +
    361 } // namespace rpc
    +
    rpc::exceptions::rpc_exception
    Definition: rpc.hpp:94
    rpc::pack_adapter::get_func_name
    static std::string get_func_name(const typename Serial::serial_t &serial_obj)
    Extracts the function name of a serialized function call.
    -
    rpc::pack_adapter::serialize_pack
    static Serial::serial_t serialize_pack(const packed_func< R, Args... > &pack)
    Serializes a packed_func to a serial object.
    -
    rpc::pack_adapter::set_err_mesg
    static void set_err_mesg(typename Serial::serial_t &serial_obj, std::string mesg)
    Sets the error message for the serialized function call.
    -
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:69
    +
    rpc::pack_adapter::serialize_pack
    static Serial::serial_t serialize_pack(const details::packed_func< R, Args... > &pack)
    Serializes a packed_func to a serial object.
    +
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:73
    diff --git a/docs/rpc__dispatch__helper_8hpp.html b/docs/rpc__dispatch__helper_8hpp.html index e981f5e4..959ca0da 100644 --- a/docs/rpc__dispatch__helper_8hpp.html +++ b/docs/rpc__dispatch__helper_8hpp.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -67,8 +67,6 @@
    -
    -Macros
    rpc_dispatch_helper.hpp File Reference
    @@ -78,46 +76,6 @@ More...

    Go to the source code of this file.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    -Macros

    -#define RPC_ATTACH_FUNC(FUNCNAME)   if (func_name == #FUNCNAME) { return this->dispatch_func(FUNCNAME, serial_obj); }
     Attaches function (provided by FUNCNAME) to the server dispatch function.
     
    -#define RPC_ATTACH_FUNCS(FUNCNAME, ...)   EXPAND(RPC_FOR_EACH(RPC_ATTACH_FUNC, FUNCNAME, __VA_ARGS__))
     Attaches multiple functions to the server dispatch function.
     
    -#define RPC_ATTACH_CACHED_FUNC(FUNCNAME)   if (func_name == #FUNCNAME) { return this->dispatch_cached_func(FUNCNAME, serial_obj); }
     Attaches function (provided by FUNCNAME) to the server dispatch funciton with server-side caching.
     
    -#define RPC_ATTACH_CACHED_FUNCS(FUNCNAME, ...)   EXPAND(RPC_FOR_EACH(RPC_ATTACH_CACHED_FUNC, FUNCNAME, __VA_ARGS__))
     Attaches multiple functions to the server dispatch function with server-side caching.
     
    -#define RPC_ALIAS_FUNC(FUNCNAME, FUNC_ALIAS)   if (func_name == #FUNC_ALIAS) { return this->dispatch_func(FUNCNAME, serial_obj); }
     Attaches function (provided by FUNCNAME) to the server dispatch function with a different function name (provided by FUNC_ALIAS)
     
    -#define RPC_MULTI_ALIAS_FUNC(FUNCNAME, FUNC_ALIAS, ...)   EXPAND(RPC_FOR_EACH2(RPC_ALIAS_FUNC, FUNCNAME, FUNC_ALIAS, __VA_ARGS__))
     Attaches function (provided by FUNCNAME) to the server dispatch function with multiple different function names.
     
    -#define RPC_ALIAS_CACHED_FUNC(FUNCNAME, FUNC_ALIAS)   if (func_name == #FUNC_ALIAS) { return this->dispatch_cached_func(FUNCNAME, serial_obj); }
     Attaches function (provided by FUNCNAME) to the server dispatch function with a different function name (provided by FUNC_ALIAS) and server-side caching.
     
    -#define RPC_MULTI_ALIAS_CACHED_FUNC(FUNCNAME, FUNC_ALIAS, ...)   EXPAND(RPC_FOR_EACH2(RPC_ALIAS_CACHED_FUNC, FUNCNAME, FUNC_ALIAS, __VA_ARGS__))
     Attaches function (provided by FUNCNAME) to the server dispatch function with multiple different function names and server-side caching.
     
    -#define RPC_DEFAULT_DISPATCH(FUNCNAME, ...)   EXPAND(const auto func_name = rpc::pack_adapter<adapter_t>::get_func_name(serial_obj); RPC_ATTACH_FUNCS(FUNCNAME, __VA_ARGS__) throw std::runtime_error("RPC error: Called function: "" + func_name + "" not found!");)
     Implements the rpc::server::dispatch_impl function for you and attaches the listed functions.
     

    Detailed Description

    Helper macros for server dispatching of remote function calls.

    Author
    Jackson Harmer (jharm.nosp@m.er95.nosp@m.@gmai.nosp@m.l.co.nosp@m.m)
    diff --git a/docs/rpc__dispatch__helper_8hpp_source.html b/docs/rpc__dispatch__helper_8hpp_source.html index dcc34064..1cafaed1 100644 --- a/docs/rpc__dispatch__helper_8hpp_source.html +++ b/docs/rpc__dispatch__helper_8hpp_source.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -74,7 +74,7 @@ Go to the documentation of this file.
    1 
    37 #pragma once
    38 
    -
    39 #if !defined(RPC_HPP_DOXYGEN_GEN)
    +
    39 #if !defined(RPC_HPP_DOXYGEN_GEN) && (defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL))
    40 #define EXPAND(x) x
    41 
    42 #define RPC_FE_0(WHAT)
    @@ -146,23 +146,31 @@
    108 #define RPC_FOR_EACH2(ACTION, ...) EXPAND(RPC_GET_MACRO(_0, __VA_ARGS__, RPC_FE2_30, RPC_FE2_29, RPC_FE2_28, RPC_FE2_27, RPC_FE2_26, RPC_FE2_25, RPC_FE2_24, RPC_FE2_23, RPC_FE2_22, RPC_FE2_21, RPC_FE2_20, RPC_FE2_19, RPC_FE2_18, RPC_FE2_17, RPC_FE2_16, RPC_FE2_15, RPC_FE2_14, RPC_FE2_13, RPC_FE2_12, RPC_FE2_11, RPC_FE2_10, RPC_FE2_9, RPC_FE2_8, RPC_FE2_7, RPC_FE2_6, RPC_FE2_5, RPC_FE2_4, RPC_FE2_3, RPC_FE2_2, RPC_FE2_1, RPC_FE2_0)(ACTION, __VA_ARGS__))
    109 #endif
    110 
    -
    112 #define RPC_ATTACH_FUNC(FUNCNAME) if (func_name == #FUNCNAME) { return this->dispatch_func(FUNCNAME, serial_obj); }
    -
    113 
    -
    115 #define RPC_ATTACH_FUNCS(FUNCNAME, ...) EXPAND(RPC_FOR_EACH(RPC_ATTACH_FUNC, FUNCNAME, __VA_ARGS__))
    +
    111 #if defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL)
    +
    112 # define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) extern RETURN (* const FUNCNAME)(__VA_ARGS__)
    +
    113 #elif defined(RPC_HPP_CLIENT_IMPL)
    +
    114 # define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) inline RETURN (* const FUNCNAME)(__VA_ARGS__) = nullptr
    +
    115 #endif
    116 
    -
    118 #define RPC_ATTACH_CACHED_FUNC(FUNCNAME) if (func_name == #FUNCNAME) { return this->dispatch_cached_func(FUNCNAME, serial_obj); }
    -
    119 
    -
    121 #define RPC_ATTACH_CACHED_FUNCS(FUNCNAME, ...) EXPAND(RPC_FOR_EACH(RPC_ATTACH_CACHED_FUNC, FUNCNAME, __VA_ARGS__))
    -
    122 
    -
    124 #define RPC_ALIAS_FUNC(FUNCNAME, FUNC_ALIAS) if (func_name == #FUNC_ALIAS) { return this->dispatch_func(FUNCNAME, serial_obj); }
    -
    125 
    -
    127 #define RPC_MULTI_ALIAS_FUNC(FUNCNAME, FUNC_ALIAS,...) EXPAND(RPC_FOR_EACH2(RPC_ALIAS_FUNC, FUNCNAME, FUNC_ALIAS, __VA_ARGS__))
    -
    128 
    -
    130 #define RPC_ALIAS_CACHED_FUNC(FUNCNAME, FUNC_ALIAS) if (func_name == #FUNC_ALIAS) { return this->dispatch_cached_func(FUNCNAME, serial_obj); }
    -
    131 
    -
    133 #define RPC_MULTI_ALIAS_CACHED_FUNC(FUNCNAME, FUNC_ALIAS,...) EXPAND(RPC_FOR_EACH2(RPC_ALIAS_CACHED_FUNC, FUNCNAME, FUNC_ALIAS, __VA_ARGS__))
    -
    134 
    -
    136 #define RPC_DEFAULT_DISPATCH(FUNCNAME, ...) EXPAND(const auto func_name = rpc::pack_adapter<adapter_t>::get_func_name(serial_obj); RPC_ATTACH_FUNCS(FUNCNAME, __VA_ARGS__) throw std::runtime_error("RPC error: Called function: "" + func_name + "" not found!");)
    +
    117 #if defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL)
    +
    119 #define RPC_ATTACH_FUNC(FUNCNAME) if (func_name == #FUNCNAME) { return this->dispatch_func(FUNCNAME, serial_obj); }
    +
    120 
    +
    122 #define RPC_ATTACH_FUNCS(FUNCNAME, ...) EXPAND(RPC_FOR_EACH(RPC_ATTACH_FUNC, FUNCNAME, __VA_ARGS__))
    +
    123 
    +
    125 #define RPC_ATTACH_CACHED_FUNC(FUNCNAME) if (func_name == #FUNCNAME) { return this->dispatch_cached_func(FUNCNAME, serial_obj); }
    +
    126 
    +
    128 #define RPC_ATTACH_CACHED_FUNCS(FUNCNAME, ...) EXPAND(RPC_FOR_EACH(RPC_ATTACH_CACHED_FUNC, FUNCNAME, __VA_ARGS__))
    +
    129 
    +
    131 #define RPC_ALIAS_FUNC(FUNCNAME, FUNC_ALIAS) if (func_name == #FUNC_ALIAS) { return this->dispatch_func(FUNCNAME, serial_obj); }
    +
    132 
    +
    134 #define RPC_MULTI_ALIAS_FUNC(FUNCNAME, FUNC_ALIAS,...) EXPAND(RPC_FOR_EACH2(RPC_ALIAS_FUNC, FUNCNAME, FUNC_ALIAS, __VA_ARGS__))
    +
    135 
    +
    137 #define RPC_ALIAS_CACHED_FUNC(FUNCNAME, FUNC_ALIAS) if (func_name == #FUNC_ALIAS) { return this->dispatch_cached_func(FUNCNAME, serial_obj); }
    +
    138 
    +
    140 #define RPC_MULTI_ALIAS_CACHED_FUNC(FUNCNAME, FUNC_ALIAS,...) EXPAND(RPC_FOR_EACH2(RPC_ALIAS_CACHED_FUNC, FUNCNAME, FUNC_ALIAS, __VA_ARGS__))
    +
    141 
    +
    143 #define RPC_DEFAULT_DISPATCH(FUNCNAME, ...) EXPAND(const auto func_name = rpc::pack_adapter<adapter_t>::get_func_name(serial_obj); RPC_ATTACH_FUNCS(FUNCNAME, __VA_ARGS__) throw std::runtime_error("RPC error: Called function: "" + func_name + "" not found!");)
    +
    144 #endif
    diff --git a/docs/rpc__njson_8hpp.html b/docs/rpc__njson_8hpp.html index cbc1c9e2..b923d6c9 100644 --- a/docs/rpc__njson_8hpp.html +++ b/docs/rpc__njson_8hpp.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -85,17 +85,18 @@
    - - - - - - - - - - - + + + + + + + + + + + +
    @@ -109,23 +110,35 @@ - - - - + + + +

    Typedefs

    -using rpc::adapters::njson = nlohmann::json
     
    -using rpc::adapters::njson_adapter = details::serial_adapter< njson, std::string >
     
    +using rpc::adapters::njson_adapter = details::serial_adapter< nlohmann::json, std::string >
     
    +using rpc::adapters::njson::njson_t = nlohmann::json
     
    - - - - + + - - + + + + + + + + + + +

    Functions

    +
    template<typename T >
    void rpc::adapters::push_arg (T &&arg, njson &arg_arr)
     
    +
    constexpr bool rpc::adapters::njson::details::validate_arg (const njson_t &arg)
     
    template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::parse_arg (const njson &arg_arr, unsigned &index)
     
    void rpc::adapters::njson::details::push_args (T &&arg, njson_t &obj_arr)
     
    +template<typename T >
    void rpc::adapters::njson::details::push_arg (T &&arg, njson_t &obj)
     
    +template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::njson::details::parse_args (const njson_t &arg_arr, unsigned &index)
     
    +template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::njson::details::parse_arg (const njson_t &arg)
     

    Detailed Description

    Implementation of adapting nlohmann's JSON library (https://github.com/nlohmann/json)

    diff --git a/docs/rpc__njson_8hpp__incl.map b/docs/rpc__njson_8hpp__incl.map index 0857b672..d12d12ee 100644 --- a/docs/rpc__njson_8hpp__incl.map +++ b/docs/rpc__njson_8hpp__incl.map @@ -1,13 +1,14 @@ - - - - - - - - - - - + + + + + + + + + + + + diff --git a/docs/rpc__njson_8hpp__incl.md5 b/docs/rpc__njson_8hpp__incl.md5 index 0c698b33..130ce7f4 100644 --- a/docs/rpc__njson_8hpp__incl.md5 +++ b/docs/rpc__njson_8hpp__incl.md5 @@ -1 +1 @@ -533b38ffcc411c69925d87c91d683f79 \ No newline at end of file +66fbe008bf3dac3479b4de490a4350ed \ No newline at end of file diff --git a/docs/rpc__njson_8hpp__incl.png b/docs/rpc__njson_8hpp__incl.png index c918e8e4..f8bdaa71 100644 Binary files a/docs/rpc__njson_8hpp__incl.png and b/docs/rpc__njson_8hpp__incl.png differ diff --git a/docs/rpc__njson_8hpp_source.html b/docs/rpc__njson_8hpp_source.html index a7d3c06c..83808d45 100644 --- a/docs/rpc__njson_8hpp_source.html +++ b/docs/rpc__njson_8hpp_source.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -74,195 +74,267 @@ Go to the documentation of this file.
    1 
    37 #pragma once
    38 
    -
    39 #if !defined(RPC_HPP_ENABLE_NJSON)
    -
    40 # error 'rpc_njson' was included without defining 'RPC_HPP_ENABLE_NJSON' Please define this macro or do not include this header!
    -
    41 #endif
    +
    39 #include "../rpc.hpp"
    +
    40 
    +
    41 #include <nlohmann/json.hpp>
    42 
    -
    43 #include "../rpc.hpp"
    -
    44 
    -
    45 #include <nlohmann/json.hpp>
    -
    46 
    -
    47 namespace rpc
    -
    48 {
    -
    49 namespace adapters
    -
    50 {
    -
    51  using njson = nlohmann::json;
    -
    52  using njson_adapter = details::serial_adapter<njson, std::string>;
    -
    53 
    -
    54  template<typename T>
    -
    55  void push_arg(T&& arg, njson& arg_arr)
    -
    56  {
    -
    57  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    -
    58 
    -
    59  if constexpr (std::is_arithmetic_v<no_ref_t> || std::is_same_v<no_ref_t, std::string>)
    -
    60  {
    -
    61  arg_arr.push_back(std::forward<T>(arg));
    -
    62  }
    -
    63  else if constexpr (details::is_container_v<no_ref_t>)
    -
    64  {
    -
    65  njson arr = njson::array();
    -
    66 
    -
    67  for (auto&& val : arg)
    -
    68  {
    -
    69  push_arg(std::forward<decltype(val)>(val), arr);
    -
    70  }
    -
    71 
    -
    72  arg_arr.push_back(std::move(arr));
    -
    73  }
    -
    74  else if constexpr (details::is_serializable_v<njson_adapter, no_ref_t>)
    -
    75  {
    -
    76  arg_arr.push_back(no_ref_t::template serialize<njson_adapter>(std::forward<T>(arg)));
    -
    77  }
    -
    78  else
    -
    79  {
    -
    80  arg_arr.push_back(njson_adapter::template serialize<no_ref_t>(std::forward<T>(arg)));
    -
    81  }
    -
    82  }
    +
    43 namespace rpc
    +
    44 {
    +
    45 namespace adapters
    +
    46 {
    +
    47  using njson_adapter = details::serial_adapter<nlohmann::json, std::string>;
    +
    48 
    +
    49  namespace njson
    +
    50  {
    +
    51  using njson_t = nlohmann::json;
    +
    52 
    +
    53  namespace details
    +
    54  {
    +
    55  template<typename T>
    +
    56  [[nodiscard]] constexpr bool validate_arg(const njson_t& arg)
    +
    57  {
    +
    58  if constexpr (std::is_same_v<T, bool>)
    +
    59  {
    +
    60  return arg.is_boolean();
    +
    61  }
    +
    62  else if constexpr (std::is_integral_v<T>)
    +
    63  {
    +
    64  return arg.is_number() && !arg.is_number_float();
    +
    65  }
    +
    66  else if constexpr (std::is_floating_point_v<T>)
    +
    67  {
    +
    68  return arg.is_number_float();
    +
    69  }
    +
    70  else if constexpr (std::is_same_v<T, std::string>)
    +
    71  {
    +
    72  return arg.is_string();
    +
    73  }
    +
    74  else if constexpr (rpc::details::is_container_v<T>)
    +
    75  {
    +
    76  return arg.is_array();
    +
    77  }
    +
    78  else
    +
    79  {
    +
    80  return !arg.is_null();
    +
    81  }
    +
    82  }
    83 
    -
    84  template<typename T>
    -
    85  std::remove_cv_t<std::remove_reference_t<T>> parse_arg(const njson& arg_arr, unsigned& index)
    -
    86  {
    -
    87  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    -
    88 
    -
    89  const auto& arg = arg_arr.is_array() ? arg_arr[index++] : arg_arr;
    -
    90 
    -
    91  if constexpr (std::is_arithmetic_v<no_ref_t> || std::is_same_v<no_ref_t, std::string>)
    -
    92  {
    -
    93  return arg.get<no_ref_t>();
    -
    94  }
    -
    95  else if constexpr (details::is_container_v<no_ref_t>)
    -
    96  {
    -
    97  using value_t = typename no_ref_t::value_type;
    -
    98 
    -
    99  no_ref_t container;
    -
    100  container.reserve(arg.size());
    +
    84  template<typename T>
    +
    85  void push_args(T&& arg, njson_t& obj_arr);
    +
    86 
    +
    87  template<typename T>
    +
    88  void push_arg(T&& arg, njson_t& obj)
    +
    89  {
    +
    90  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    +
    91 
    +
    92  if constexpr (std::is_arithmetic_v<
    +
    93  no_ref_t> || std::is_same_v<no_ref_t, std::string>)
    +
    94  {
    +
    95  obj = std::forward<T>(arg);
    +
    96  }
    +
    97  else if constexpr (rpc::details::is_container_v<no_ref_t>)
    +
    98  {
    +
    99  obj = njson_t::array();
    +
    100  obj.get_ref<njson_t::array_t&>().reserve(arg.size());
    101 
    -
    102  unsigned j = 0;
    -
    103 
    -
    104  for (const auto& val : arg)
    -
    105  {
    -
    106  container.push_back(parse_arg<value_t>(val, j));
    -
    107  }
    -
    108 
    -
    109  return container;
    -
    110  }
    -
    111  else if constexpr (details::is_serializable_v<njson_adapter, no_ref_t>)
    -
    112  {
    -
    113  return no_ref_t::template deserialize<njson_adapter>(arg);
    -
    114  }
    -
    115  else
    -
    116  {
    -
    117  return njson_adapter::template deserialize<no_ref_t>(arg);
    -
    118  }
    -
    119  }
    -
    120 } // namespace adapters
    -
    121 
    -
    122 template<>
    -
    123 inline std::string adapters::njson_adapter::to_bytes(adapters::njson serial_obj)
    -
    124 {
    -
    125  return std::move(serial_obj).dump();
    -
    126 }
    -
    127 
    -
    128 template<>
    -
    129 inline adapters::njson adapters::njson_adapter::from_bytes(std::string bytes)
    -
    130 {
    -
    131  return adapters::njson::parse(std::move(bytes));
    -
    132 }
    +
    102  for (auto&& val : arg)
    +
    103  {
    +
    104  push_args(std::forward<decltype(val)>(val), obj);
    +
    105  }
    +
    106  }
    +
    107  else if constexpr (rpc::details::is_serializable_v<njson_adapter, no_ref_t>)
    +
    108  {
    +
    109  obj = no_ref_t::template serialize<njson_adapter>(std::forward<T>(arg));
    +
    110  }
    +
    111  else
    +
    112  {
    +
    113  obj = njson_adapter::template serialize<no_ref_t>(std::forward<T>(arg));
    +
    114  }
    +
    115  }
    +
    116 
    +
    117  template<typename T>
    +
    118  void push_args(T&& arg, njson_t& obj_arr)
    +
    119  {
    +
    120  njson_t tmp{};
    +
    121  push_arg(std::forward<T>(arg), tmp);
    +
    122  obj_arr.push_back(std::move(tmp));
    +
    123  }
    +
    124 
    +
    125  template<typename T>
    +
    126  std::remove_cv_t<std::remove_reference_t<T>> parse_args(
    +
    127  const njson_t& arg_arr, unsigned& index);
    +
    128 
    +
    129  template<typename T>
    +
    130  [[nodiscard]] std::remove_cv_t<std::remove_reference_t<T>> parse_arg(const njson_t& arg)
    +
    131  {
    +
    132  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    133 
    -
    134 template<>
    -
    135 template<typename R, typename... Args>
    -
    136 adapters::njson pack_adapter<adapters::njson_adapter>::serialize_pack(
    -
    137  const packed_func<R, Args...>& pack)
    -
    138 {
    -
    139  using namespace adapters;
    +
    134  if (!validate_arg<T>(arg))
    +
    135  {
    +
    136  throw exceptions::function_mismatch(std::string{ "njson expected type: " }
    +
    137  + std::string{ typeid(no_ref_t).name() } + std::string{ ", got type: " }
    +
    138  + std::string{ arg.type_name() });
    +
    139  }
    140 
    -
    141  njson obj;
    -
    142 
    -
    143  obj["func_name"] = pack.get_func_name();
    -
    144 
    -
    145  auto arg_arr = njson::array();
    -
    146 
    -
    147  const auto argTup = pack.get_args();
    -
    148  details::for_each_tuple(
    -
    149  argTup, [&arg_arr](auto&& x) { push_arg(std::forward<decltype(x)>(x), arg_arr); });
    -
    150 
    -
    151  obj["args"] = std::move(arg_arr);
    +
    141  if constexpr (std::is_arithmetic_v<
    +
    142  no_ref_t> || std::is_same_v<no_ref_t, std::string>)
    +
    143  {
    +
    144  return arg.get<no_ref_t>();
    +
    145  }
    +
    146  else if constexpr (rpc::details::is_container_v<no_ref_t>)
    +
    147  {
    +
    148  using value_t = typename no_ref_t::value_type;
    +
    149 
    +
    150  no_ref_t container{};
    +
    151  container.reserve(arg.size());
    152 
    -
    153  if (!pack)
    -
    154  {
    -
    155  obj["err_mesg"] = pack.get_err_mesg();
    -
    156  }
    -
    157  else
    -
    158  {
    -
    159  if constexpr (!std::is_void_v<R>)
    -
    160  {
    -
    161  obj["result"] = pack.get_result();
    -
    162  }
    -
    163  }
    -
    164 
    -
    165  return obj;
    -
    166 }
    -
    167 
    -
    168 template<>
    -
    169 template<typename R, typename... Args>
    -
    170 packed_func<R, Args...> pack_adapter<adapters::njson_adapter>::deserialize_pack(
    -
    171  const adapters::njson& serial_obj)
    -
    172 {
    -
    173  using namespace adapters;
    -
    174 
    -
    175  [[maybe_unused]] unsigned i = 0;
    -
    176 
    -
    177  typename packed_func<R, Args...>::args_t args{ parse_arg<Args>(serial_obj["args"], i)... };
    -
    178 
    -
    179  if constexpr (std::is_void_v<R>)
    -
    180  {
    -
    181  packed_func<void, Args...> pack(serial_obj["func_name"], std::move(args));
    -
    182 
    -
    183  if (serial_obj.contains("err_mesg"))
    -
    184  {
    -
    185  pack.set_err_mesg(serial_obj["err_mesg"]);
    -
    186  }
    +
    153  unsigned j = 0;
    +
    154 
    +
    155  for (const auto& val : arg)
    +
    156  {
    +
    157  container.push_back(parse_args<value_t>(val, j));
    +
    158  }
    +
    159 
    +
    160  return container;
    +
    161  }
    +
    162  else if constexpr (rpc::details::is_serializable_v<njson_adapter, no_ref_t>)
    +
    163  {
    +
    164  return no_ref_t::template deserialize<njson_adapter>(arg);
    +
    165  }
    +
    166  else
    +
    167  {
    +
    168  return njson_adapter::template deserialize<no_ref_t>(arg);
    +
    169  }
    +
    170  }
    +
    171 
    +
    172  template<typename T>
    +
    173  [[nodiscard]] std::remove_cv_t<std::remove_reference_t<T>> parse_args(
    +
    174  const njson_t& arg_arr, unsigned& index)
    +
    175  {
    +
    176  if (index >= arg_arr.size())
    +
    177  {
    +
    178  throw exceptions::function_mismatch("Argument count mismatch");
    +
    179  }
    +
    180 
    +
    181  const auto& arg = arg_arr.is_array() ? arg_arr[index++] : arg_arr;
    +
    182  return parse_arg<T>(arg);
    +
    183  }
    +
    184  } // namespace details
    +
    185  } // namespace njson
    +
    186 } // namespace adapters
    187 
    -
    188  return pack;
    -
    189  }
    -
    190  else
    -
    191  {
    -
    192  if (serial_obj.contains("result") && !serial_obj["result"].is_null())
    -
    193  {
    -
    194  return packed_func<R, Args...>(
    -
    195  serial_obj["func_name"], serial_obj["result"].get<R>(), std::move(args));
    -
    196  }
    -
    197 
    -
    198  packed_func<R, Args...> pack(serial_obj["func_name"], std::nullopt, std::move(args));
    -
    199 
    -
    200  if (serial_obj.contains("err_mesg"))
    -
    201  {
    -
    202  pack.set_err_mesg(serial_obj["err_mesg"]);
    -
    203  }
    -
    204 
    -
    205  return pack;
    -
    206  }
    -
    207 }
    +
    188 template<>
    +
    189 [[nodiscard]] inline std::string adapters::njson_adapter::to_bytes(
    +
    190  adapters::njson::njson_t&& serial_obj)
    +
    191 {
    +
    192  return std::move(serial_obj).dump();
    +
    193 }
    +
    194 
    +
    195 template<>
    +
    196 [[nodiscard]] inline adapters::njson::njson_t adapters::njson_adapter::from_bytes(
    +
    197  std::string&& bytes)
    +
    198 {
    +
    199  return adapters::njson::njson_t::parse(std::move(bytes));
    +
    200 }
    +
    201 
    +
    202 template<>
    +
    203 template<typename R, typename... Args>
    +
    204 [[nodiscard]] adapters::njson::njson_t pack_adapter<adapters::njson_adapter>::serialize_pack(
    +
    205  const ::rpc::details::packed_func<R, Args...>& pack)
    +
    206 {
    +
    207  using namespace adapters::njson;
    208 
    -
    209 template<>
    -
    210 inline std::string pack_adapter<adapters::njson_adapter>::get_func_name(
    -
    211  const adapters::njson& serial_obj)
    -
    212 {
    -
    213  return serial_obj["func_name"];
    -
    214 }
    -
    215 
    -
    216 template<>
    -
    217 inline void pack_adapter<adapters::njson_adapter>::set_err_mesg(
    -
    218  adapters::njson& serial_obj, std::string mesg)
    -
    219 {
    -
    220  serial_obj["err_mesg"] = std::move(mesg);
    -
    221 }
    -
    222 } // namespace rpc
    -
    rpc::pack_adapter::deserialize_pack
    static packed_func< R, Args... > deserialize_pack(const typename Serial::serial_t &serial_obj)
    De-serializes a serial object to a packed_func.
    +
    209  njson_t obj{};
    +
    210  obj["func_name"] = pack.get_func_name();
    +
    211  obj["args"] = njson_t::array();
    +
    212  auto& arg_arr = obj["args"];
    +
    213  arg_arr.get_ref<njson_t::array_t&>().reserve(sizeof...(Args));
    +
    214 
    +
    215  const auto& argTup = pack.get_args();
    +
    216  rpc::details::for_each_tuple(argTup,
    +
    217  [&arg_arr](auto&& x)
    +
    218  { adapters::njson::details::push_args(std::forward<decltype(x)>(x), arg_arr); });
    +
    219 
    +
    220  if (!pack)
    +
    221  {
    +
    222  obj["except_type"] = pack.get_except_type();
    +
    223  obj["err_mesg"] = pack.get_err_mesg();
    +
    224  }
    +
    225  else
    +
    226  {
    +
    227  if constexpr (!std::is_void_v<R>)
    +
    228  {
    +
    229  obj["result"] = {};
    +
    230  adapters::njson::details::push_arg(pack.get_result(), obj["result"]);
    +
    231  }
    +
    232  }
    +
    233 
    +
    234  return obj;
    +
    235 }
    +
    236 
    +
    237 template<>
    +
    238 template<typename R, typename... Args>
    +
    239 [[nodiscard]] ::rpc::details::packed_func<R, Args...> pack_adapter<
    +
    240  adapters::njson_adapter>::deserialize_pack(const adapters::njson::njson_t& serial_obj)
    +
    241 {
    +
    242  using namespace adapters::njson;
    +
    243 
    +
    244  [[maybe_unused]] unsigned i = 0;
    +
    245 
    +
    246  if constexpr (std::is_void_v<R>)
    +
    247  {
    +
    248  ::rpc::details::packed_func<void, Args...> pack(serial_obj["func_name"],
    +
    249  { adapters::njson::details::parse_args<Args>(serial_obj["args"], i)... });
    +
    250 
    +
    251  if (serial_obj.contains("except_type"))
    +
    252  {
    +
    253  pack.set_exception(
    +
    254  serial_obj["err_mesg"], static_cast<exceptions::Type>(serial_obj["except_type"]));
    +
    255  }
    +
    256 
    +
    257  return pack;
    +
    258  }
    +
    259  else
    +
    260  {
    +
    261  if (serial_obj.contains("result") && !serial_obj["result"].is_null())
    +
    262  {
    +
    263  return ::rpc::details::packed_func<R, Args...>(serial_obj["func_name"],
    +
    264  adapters::njson::details::parse_arg<R>(serial_obj["result"]),
    +
    265  { adapters::njson::details::parse_args<Args>(serial_obj["args"], i)... });
    +
    266  }
    +
    267 
    +
    268  ::rpc::details::packed_func<R, Args...> pack(serial_obj["func_name"], std::nullopt,
    +
    269  { adapters::njson::details::parse_args<Args>(serial_obj["args"], i)... });
    +
    270 
    +
    271  if (serial_obj.contains("except_type"))
    +
    272  {
    +
    273  pack.set_exception(
    +
    274  serial_obj["err_mesg"], static_cast<exceptions::Type>(serial_obj["except_type"]));
    +
    275  }
    +
    276 
    +
    277  return pack;
    +
    278  }
    +
    279 }
    +
    280 
    +
    281 template<>
    +
    282 [[nodiscard]] inline std::string pack_adapter<adapters::njson_adapter>::get_func_name(
    +
    283  const adapters::njson::njson_t& serial_obj)
    +
    284 {
    +
    285  return serial_obj["func_name"];
    +
    286 }
    +
    287 
    +
    288 template<>
    +
    289 inline void pack_adapter<adapters::njson_adapter>::set_exception(
    +
    290  adapters::njson::njson_t& serial_obj, const rpc::exceptions::rpc_exception& ex)
    +
    291 {
    +
    292  serial_obj["except_type"] = ex.get_type();
    +
    293  serial_obj["err_mesg"] = ex.what();
    +
    294 }
    +
    295 } // namespace rpc
    +
    rpc::exceptions::rpc_exception
    Definition: rpc.hpp:94
    rpc::pack_adapter::get_func_name
    static std::string get_func_name(const typename Serial::serial_t &serial_obj)
    Extracts the function name of a serialized function call.
    -
    rpc::pack_adapter::serialize_pack
    static Serial::serial_t serialize_pack(const packed_func< R, Args... > &pack)
    Serializes a packed_func to a serial object.
    -
    rpc::pack_adapter::set_err_mesg
    static void set_err_mesg(typename Serial::serial_t &serial_obj, std::string mesg)
    Sets the error message for the serialized function call.
    -
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:69
    +
    rpc::pack_adapter::serialize_pack
    static Serial::serial_t serialize_pack(const details::packed_func< R, Args... > &pack)
    Serializes a packed_func to a serial object.
    +
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:73
    diff --git a/docs/rpc__rapidjson_8hpp.html b/docs/rpc__rapidjson_8hpp.html index f89bd7ff..7bdca2b8 100644 --- a/docs/rpc__rapidjson_8hpp.html +++ b/docs/rpc__rapidjson_8hpp.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -87,19 +87,20 @@
    - - - - - - - - - - - - - + + + + + + + + + + + + + +
    @@ -113,26 +114,41 @@ - - - - - - + + + + + +

    Typedefs

    -using rpc::adapters::rapidjson_doc = rapidjson::Document
     
    -using rpc::adapters::rapidjson_val = rapidjson::Value
     
    -using rpc::adapters::rapidjson_adapter = details::serial_adapter< rapidjson_doc, std::string >
     
    +using rpc::adapters::rapidjson_adapter = details::serial_adapter< rapidjson::Document, std::string >
     
    +using rpc::adapters::rapidjson::doc_t = ::rapidjson::Document
     
    +using rpc::adapters::rapidjson::value_t = ::rapidjson::Value
     
    - - - - + + + + - - + + + + + + + + + + +

    Functions

    +
    template<typename T >
    void rpc::adapters::push_arg (T &&arg, rapidjson_val &arg_arr, rapidjson::MemoryPoolAllocator<> &alloc)
     
    +
    constexpr bool rpc::adapters::rapidjson::details::validate_arg (const value_t &arg)
     
    +void rpc::adapters::rapidjson::details::throw_mismatch (std::string &&expect_type, const value_t &obj) noexcept(false)
     
    template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::parse_arg (const rapidjson_val &arg_arr, unsigned &index)
     
    void rpc::adapters::rapidjson::details::push_args (T &&arg, value_t &obj_arr, ::rapidjson::MemoryPoolAllocator<> &alloc)
     
    +template<typename T >
    void rpc::adapters::rapidjson::details::push_arg (T &&arg, value_t &obj, ::rapidjson::MemoryPoolAllocator<> &alloc)
     
    +template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::rapidjson::details::parse_args (const value_t &arg_arr, unsigned &index)
     
    +template<typename T >
    std::remove_cv_t< std::remove_reference_t< T > > rpc::adapters::rapidjson::details::parse_arg (const value_t &arg)
     

    Detailed Description

    Implementation of adapting rapidjson (https://github.com/Tencent/rapidjson)

    diff --git a/docs/rpc__rapidjson_8hpp__incl.map b/docs/rpc__rapidjson_8hpp__incl.map index fd076fb7..e73af12b 100644 --- a/docs/rpc__rapidjson_8hpp__incl.map +++ b/docs/rpc__rapidjson_8hpp__incl.map @@ -1,15 +1,16 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + + diff --git a/docs/rpc__rapidjson_8hpp__incl.md5 b/docs/rpc__rapidjson_8hpp__incl.md5 index 1d7a8595..dbdc73f7 100644 --- a/docs/rpc__rapidjson_8hpp__incl.md5 +++ b/docs/rpc__rapidjson_8hpp__incl.md5 @@ -1 +1 @@ -bba952ab17b2736ee8f10f5c0e200d13 \ No newline at end of file +0d3650e6173cedaaed912da957882b75 \ No newline at end of file diff --git a/docs/rpc__rapidjson_8hpp__incl.png b/docs/rpc__rapidjson_8hpp__incl.png index a93afc1c..793f2255 100644 Binary files a/docs/rpc__rapidjson_8hpp__incl.png and b/docs/rpc__rapidjson_8hpp__incl.png differ diff --git a/docs/rpc__rapidjson_8hpp_source.html b/docs/rpc__rapidjson_8hpp_source.html index d09579a9..d45d8fd5 100644 --- a/docs/rpc__rapidjson_8hpp_source.html +++ b/docs/rpc__rapidjson_8hpp_source.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -74,354 +74,462 @@ Go to the documentation of this file.
    1 
    37 #pragma once
    38 
    -
    39 #if !defined(RPC_HPP_ENABLE_RAPIDJSON)
    -
    40 # error 'rpc_rapidjson' was included without defining 'RPC_HPP_ENABLE_RAPIDJSON' Please define this macro or do not include this header!
    -
    41 #endif
    -
    42 
    -
    43 #include "../rpc.hpp"
    +
    39 #include "../rpc.hpp"
    +
    40 
    +
    41 #include <rapidjson/document.h>
    +
    42 #include <rapidjson/stringbuffer.h>
    +
    43 #include <rapidjson/writer.h>
    44 
    -
    45 #include <rapidjson/document.h>
    -
    46 #include <rapidjson/stringbuffer.h>
    -
    47 #include <rapidjson/writer.h>
    -
    48 
    -
    49 namespace rpc
    -
    50 {
    -
    51 namespace adapters
    -
    52 {
    -
    53  using rapidjson_doc = rapidjson::Document;
    -
    54  using rapidjson_val = rapidjson::Value;
    -
    55  using rapidjson_adapter = details::serial_adapter<rapidjson_doc, std::string>;
    -
    56 
    -
    57  template<typename T>
    -
    58  void push_arg(T&& arg, rapidjson_val& arg_arr, rapidjson::MemoryPoolAllocator<>& alloc)
    -
    59  {
    -
    60  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    -
    61 
    -
    62  if constexpr (std::is_same_v<no_ref_t, std::string>)
    -
    63  {
    -
    64  arg_arr.PushBack(rapidjson_val{}.SetString(arg.c_str(), alloc), alloc);
    -
    65  }
    -
    66  else if constexpr (std::is_arithmetic_v<no_ref_t>)
    -
    67  {
    -
    68  // Rapidjson is silly and does not have generic support for 8/16 bit numbers, so upgrade to 32-bit
    -
    69  if constexpr (
    -
    70  std::is_same_v<no_ref_t,
    -
    71  char> || std::is_same_v<no_ref_t, int8_t> || std::is_same_v<no_ref_t, int16_t>)
    -
    72  {
    -
    73  arg_arr.PushBack(rapidjson_val().SetInt(arg), alloc);
    -
    74  }
    -
    75  else if constexpr (std::is_same_v<no_ref_t,
    -
    76  uint8_t> || std::is_same_v<no_ref_t, uint16_t>)
    -
    77  {
    -
    78  arg_arr.PushBack(rapidjson_val().SetUint(arg), alloc);
    -
    79  }
    -
    80  else
    -
    81  {
    -
    82  arg_arr.PushBack(rapidjson_val().Set<no_ref_t>(arg), alloc);
    -
    83  }
    -
    84  }
    -
    85  else if constexpr (rpc::details::is_container_v<no_ref_t>)
    -
    86  {
    -
    87  rapidjson_val sub_arr;
    -
    88  sub_arr.SetArray();
    -
    89 
    -
    90  for (auto&& val : arg)
    -
    91  {
    -
    92  push_arg(std::forward<decltype(val)>(val), sub_arr, alloc);
    -
    93  }
    -
    94 
    -
    95  arg_arr.PushBack(sub_arr, alloc);
    -
    96  }
    -
    97  else if constexpr (rpc::details::is_serializable_v<rapidjson_adapter, no_ref_t>)
    -
    98  {
    -
    99  rapidjson_doc serialized =
    -
    100  no_ref_t::template serialize<rapidjson_adapter>(std::forward<T>(arg));
    -
    101  rapidjson_val arr_val;
    -
    102  arr_val.CopyFrom(serialized, alloc);
    -
    103  arg_arr.PushBack(arr_val, alloc);
    -
    104  }
    -
    105  else
    -
    106  {
    -
    107  rapidjson_doc serialized =
    -
    108  rapidjson_adapter::template serialize<no_ref_t>(std::forward<T>(arg));
    -
    109  rapidjson_val arr_val;
    -
    110  arr_val.CopyFrom(serialized, alloc);
    -
    111  arg_arr.PushBack(arr_val, alloc);
    -
    112  }
    -
    113  }
    -
    114 
    -
    115  template<typename T>
    -
    116  std::remove_cv_t<std::remove_reference_t<T>> parse_arg(
    -
    117  const rapidjson_val& arg_arr, unsigned& index)
    -
    118  {
    -
    119  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    -
    120 
    -
    121  const rapidjson_val& arg = arg_arr.IsArray() ? arg_arr.GetArray()[index++] : arg_arr;
    -
    122 
    -
    123  if constexpr (std::is_same_v<no_ref_t, std::string>)
    -
    124  {
    -
    125  return arg.GetString();
    -
    126  }
    -
    127  else if constexpr (std::is_arithmetic_v<no_ref_t>)
    -
    128  {
    -
    129  // Rapidjson is silly and does not have generic support for 8/16 bit numbers, so upgrade to 32-bit
    -
    130  if constexpr (
    -
    131  std::is_same_v<no_ref_t,
    -
    132  char> || std::is_same_v<no_ref_t, int8_t> || std::is_same_v<no_ref_t, int16_t>)
    -
    133  {
    -
    134  return arg.GetInt();
    -
    135  }
    -
    136  else if constexpr (std::is_same_v<no_ref_t,
    -
    137  uint8_t> || std::is_same_v<no_ref_t, uint16_t>)
    -
    138  {
    -
    139  return arg.GetUint();
    -
    140  }
    -
    141  else
    -
    142  {
    -
    143  return arg.Get<no_ref_t>();
    -
    144  }
    -
    145  }
    -
    146  else if constexpr (details::is_container_v<no_ref_t>)
    -
    147  {
    -
    148  using value_t = typename no_ref_t::value_type;
    -
    149  no_ref_t container;
    -
    150  container.reserve(arg.Size());
    +
    45 namespace rpc
    +
    46 {
    +
    47 namespace adapters
    +
    48 {
    +
    49  using rapidjson_adapter = details::serial_adapter<rapidjson::Document, std::string>;
    +
    50 
    +
    51  namespace rapidjson
    +
    52  {
    +
    53  using doc_t = ::rapidjson::Document;
    +
    54  using value_t = ::rapidjson::Value;
    +
    55 
    +
    56  namespace details
    +
    57  {
    +
    58  template<typename T>
    +
    59  [[nodiscard]] constexpr bool validate_arg(const value_t& arg)
    +
    60  {
    +
    61  if constexpr (std::is_same_v<T, bool>)
    +
    62  {
    +
    63  return arg.IsBool();
    +
    64  }
    +
    65  else if constexpr (std::is_integral_v<T>)
    +
    66  {
    +
    67  if constexpr (std::is_signed_v<T>)
    +
    68  {
    +
    69  if constexpr (sizeof(T) < 8)
    +
    70  {
    +
    71  return arg.IsInt();
    +
    72  }
    +
    73  else
    +
    74  {
    +
    75  return arg.IsInt64();
    +
    76  }
    +
    77  }
    +
    78  else
    +
    79  {
    +
    80  if constexpr (sizeof(T) < 8)
    +
    81  {
    +
    82  return arg.IsUint();
    +
    83  }
    +
    84  else
    +
    85  {
    +
    86  return arg.IsUint64();
    +
    87  }
    +
    88  }
    +
    89  }
    +
    90  else if constexpr (std::is_same_v<T, float>)
    +
    91  {
    +
    92  return arg.IsFloat();
    +
    93  }
    +
    94  else if constexpr (std::is_same_v<T, double>)
    +
    95  {
    +
    96  return arg.IsDouble();
    +
    97  }
    +
    98  else if constexpr (std::is_same_v<T, std::string>)
    +
    99  {
    +
    100  return arg.IsString();
    +
    101  }
    +
    102  else if constexpr (rpc::details::is_container_v<T>)
    +
    103  {
    +
    104  return arg.IsArray();
    +
    105  }
    +
    106  else
    +
    107  {
    +
    108  return !arg.IsNull();
    +
    109  }
    +
    110  }
    +
    111 
    +
    112  [[noreturn]] inline void throw_mismatch(
    +
    113  std::string&& expect_type, const value_t& obj) noexcept(false)
    +
    114  {
    +
    115  std::string type_str = [&obj]
    +
    116  {
    +
    117  if (obj.IsNull())
    +
    118  {
    +
    119  return "null";
    +
    120  }
    +
    121 
    +
    122  if (obj.IsInt64())
    +
    123  {
    +
    124  return "int64";
    +
    125  }
    +
    126 
    +
    127  if (obj.IsInt())
    +
    128  {
    +
    129  return "int";
    +
    130  }
    +
    131 
    +
    132  if (obj.IsUint64())
    +
    133  {
    +
    134  return "uint64";
    +
    135  }
    +
    136 
    +
    137  if (obj.IsUint())
    +
    138  {
    +
    139  return "uint";
    +
    140  }
    +
    141 
    +
    142  if (obj.IsDouble())
    +
    143  {
    +
    144  return "double";
    +
    145  }
    +
    146 
    +
    147  if (obj.IsFloat())
    +
    148  {
    +
    149  return "float";
    +
    150  }
    151 
    -
    152  unsigned j = 0;
    -
    153 
    -
    154  for (const auto& val : arg.GetArray())
    -
    155  {
    -
    156  container.push_back(parse_arg<value_t>(val, j));
    -
    157  }
    -
    158 
    -
    159  return container;
    -
    160  }
    -
    161  else if constexpr (details::is_serializable_v<rapidjson_adapter, no_ref_t>)
    -
    162  {
    -
    163  rapidjson_doc d;
    -
    164  d.CopyFrom(arg, d.GetAllocator());
    -
    165  return no_ref_t::template deserialize<rapidjson_adapter>(d);
    -
    166  }
    -
    167  else
    -
    168  {
    -
    169  rapidjson_doc d;
    -
    170  d.CopyFrom(arg, d.GetAllocator());
    -
    171  return rapidjson_adapter::template deserialize<no_ref_t>(d);
    -
    172  }
    -
    173  }
    -
    174 } // namespace adapters
    -
    175 
    -
    176 template<>
    -
    177 inline std::string adapters::rapidjson_adapter::to_bytes(adapters::rapidjson_doc serial_obj)
    -
    178 {
    -
    179  rapidjson::StringBuffer buffer;
    -
    180  rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
    -
    181  std::move(serial_obj).Accept(writer);
    -
    182  return buffer.GetString();
    -
    183 }
    -
    184 
    -
    185 template<>
    -
    186 inline adapters::rapidjson_doc adapters::rapidjson_adapter::from_bytes(std::string bytes)
    -
    187 {
    -
    188  adapters::rapidjson_doc d;
    -
    189  d.SetObject();
    -
    190  d.Parse(std::move(bytes).c_str());
    -
    191  return d;
    -
    192 }
    -
    193 
    -
    194 template<>
    -
    195 template<typename R, typename... Args>
    -
    196 adapters::rapidjson_doc pack_adapter<adapters::rapidjson_adapter>::serialize_pack(
    -
    197  const packed_func<R, Args...>& pack)
    -
    198 {
    -
    199  using namespace adapters;
    -
    200 
    -
    201  rapidjson_doc d;
    -
    202  auto& alloc = d.GetAllocator();
    -
    203  d.SetObject();
    -
    204 
    -
    205  d.AddMember("func_name", rapidjson_val{}.SetString(pack.get_func_name().c_str(), alloc), alloc);
    -
    206 
    -
    207  if constexpr (!std::is_void_v<R>)
    -
    208  {
    -
    209  rapidjson_val result;
    -
    210 
    -
    211  if (pack)
    -
    212  {
    -
    213  if constexpr (std::is_arithmetic_v<R>)
    -
    214  {
    -
    215  result.Set<R>(pack.get_result());
    -
    216  }
    -
    217  else if constexpr (std::is_same_v<R, std::string>)
    -
    218  {
    -
    219  result.SetString(pack.get_result().c_str(), alloc);
    -
    220  }
    -
    221  else if constexpr (details::is_container_v<R>)
    -
    222  {
    -
    223  const R container = pack.get_result();
    -
    224  result.SetArray();
    -
    225 
    -
    226  for (const auto& val : container)
    -
    227  {
    -
    228  result.PushBack(val, alloc);
    -
    229  }
    -
    230  }
    -
    231  else if constexpr (details::is_serializable_v<rapidjson_adapter, R>)
    -
    232  {
    -
    233  rapidjson_doc tmp = R::template serialize<rapidjson_adapter>(pack.get_result());
    -
    234  result.CopyFrom(tmp, alloc);
    -
    235  }
    -
    236  else
    -
    237  {
    -
    238  rapidjson_doc tmp = rapidjson_adapter::template serialize<R>(pack.get_result());
    -
    239  result.CopyFrom(tmp, alloc);
    -
    240  }
    -
    241  }
    -
    242  else
    -
    243  {
    -
    244  result.SetNull();
    -
    245  }
    -
    246 
    -
    247  d.AddMember("result", result, alloc);
    -
    248  }
    -
    249 
    -
    250  rapidjson_val args;
    -
    251  args.SetArray();
    +
    152  if (obj.IsBool())
    +
    153  {
    +
    154  return "bool";
    +
    155  }
    +
    156 
    +
    157  if (obj.IsString())
    +
    158  {
    +
    159  return "string";
    +
    160  }
    +
    161 
    +
    162  if (obj.IsArray())
    +
    163  {
    +
    164  return "array";
    +
    165  }
    +
    166 
    +
    167  if (obj.IsObject())
    +
    168  {
    +
    169  return "object";
    +
    170  }
    +
    171 
    +
    172  return "unknown";
    +
    173  }();
    +
    174 
    +
    175  throw exceptions::function_mismatch("rapidjson expected type: "
    +
    176  + std::move(expect_type) + ", got type: " + std::move(type_str));
    +
    177  }
    +
    178 
    +
    179  template<typename T>
    +
    180  void push_args(T&& arg, value_t& obj_arr, ::rapidjson::MemoryPoolAllocator<>& alloc);
    +
    181 
    +
    182  template<typename T>
    +
    183  void push_arg(T&& arg, value_t& obj, ::rapidjson::MemoryPoolAllocator<>& alloc)
    +
    184  {
    +
    185  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    +
    186 
    +
    187  if constexpr (std::is_same_v<no_ref_t, std::string>)
    +
    188  {
    +
    189  obj.SetString(arg.c_str(), alloc);
    +
    190  }
    +
    191  else if constexpr (std::is_arithmetic_v<no_ref_t>)
    +
    192  {
    +
    193  // Rapidjson is silly and does not have generic support for 8/16 bit numbers, so upgrade to 32-bit
    +
    194  if constexpr (
    +
    195  std::is_same_v<no_ref_t,
    +
    196  char> || std::is_same_v<no_ref_t, int8_t> || std::is_same_v<no_ref_t, int16_t>)
    +
    197  {
    +
    198  obj.SetInt(arg);
    +
    199  }
    +
    200  else if constexpr (std::is_same_v<no_ref_t,
    +
    201  uint8_t> || std::is_same_v<no_ref_t, uint16_t>)
    +
    202  {
    +
    203  obj.SetUint(arg);
    +
    204  }
    +
    205  else
    +
    206  {
    +
    207  obj.Set<no_ref_t>(arg);
    +
    208  }
    +
    209  }
    +
    210  else if constexpr (rpc::details::is_container_v<no_ref_t>)
    +
    211  {
    +
    212  obj.SetArray();
    +
    213  obj.Reserve(static_cast<::rapidjson::SizeType>(arg.size()), alloc);
    +
    214 
    +
    215  for (auto&& val : arg)
    +
    216  {
    +
    217  push_args(std::forward<decltype(val)>(val), obj, alloc);
    +
    218  }
    +
    219  }
    +
    220  else if constexpr (rpc::details::is_serializable_v<rapidjson_adapter, no_ref_t>)
    +
    221  {
    +
    222  doc_t serialized =
    +
    223  no_ref_t::template serialize<rapidjson_adapter>(std::forward<T>(arg));
    +
    224 
    +
    225  obj.CopyFrom(serialized, alloc);
    +
    226  }
    +
    227  else
    +
    228  {
    +
    229  doc_t serialized =
    +
    230  rapidjson_adapter::template serialize<no_ref_t>(std::forward<T>(arg));
    +
    231 
    +
    232  obj.CopyFrom(serialized, alloc);
    +
    233  }
    +
    234  }
    +
    235 
    +
    236  template<typename T>
    +
    237  void push_args(T&& arg, value_t& obj_arr, ::rapidjson::MemoryPoolAllocator<>& alloc)
    +
    238  {
    +
    239  value_t tmp{};
    +
    240  push_arg(std::forward<T>(arg), tmp, alloc);
    +
    241  obj_arr.PushBack(std::move(tmp), alloc);
    +
    242  }
    +
    243 
    +
    244  template<typename T>
    +
    245  [[nodiscard]] std::remove_cv_t<std::remove_reference_t<T>> parse_args(
    +
    246  const value_t& arg_arr, unsigned& index);
    +
    247 
    +
    248  template<typename T>
    +
    249  [[nodiscard]] std::remove_cv_t<std::remove_reference_t<T>> parse_arg(const value_t& arg)
    +
    250  {
    +
    251  using no_ref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    252 
    -
    253  const auto argTup = pack.get_args();
    -
    254  details::for_each_tuple(
    -
    255  argTup, [&args, &alloc](auto&& x) { push_arg(std::forward<decltype(x)>(x), args, alloc); });
    -
    256 
    -
    257  d.AddMember("args", args, alloc);
    -
    258  return d;
    -
    259 }
    -
    260 
    -
    261 template<>
    -
    262 template<typename R, typename... Args>
    -
    263 packed_func<R, Args...> pack_adapter<adapters::rapidjson_adapter>::deserialize_pack(
    -
    264  const adapters::rapidjson_doc& serial_obj)
    -
    265 {
    -
    266  using namespace adapters;
    -
    267 
    -
    268  [[maybe_unused]] unsigned i = 0;
    -
    269 
    -
    270  typename packed_func<R, Args...>::args_t args{ parse_arg<Args>(serial_obj["args"], i)... };
    -
    271 
    -
    272  if constexpr (std::is_void_v<R>)
    -
    273  {
    -
    274  packed_func<void, Args...> pack(serial_obj["func_name"].GetString(), std::move(args));
    -
    275 
    -
    276  if (serial_obj.HasMember("err_mesg"))
    -
    277  {
    -
    278  pack.set_err_mesg(serial_obj["err_mesg"].GetString());
    -
    279  }
    -
    280 
    -
    281  return pack;
    -
    282  }
    -
    283  else
    -
    284  {
    -
    285  if (serial_obj.HasMember("result") && !serial_obj["result"].IsNull())
    -
    286  {
    -
    287  const rapidjson_val& result = serial_obj["result"];
    +
    253  if (!validate_arg<no_ref_t>(arg))
    +
    254  {
    +
    255  throw_mismatch(typeid(no_ref_t).name(), arg);
    +
    256  }
    +
    257 
    +
    258  if constexpr (std::is_same_v<no_ref_t, std::string>)
    +
    259  {
    +
    260  return arg.GetString();
    +
    261  }
    +
    262  else if constexpr (std::is_arithmetic_v<no_ref_t>)
    +
    263  {
    +
    264  // Rapidjson is silly and does not have generic support for 8/16 bit numbers, so upgrade to 32-bit
    +
    265  if constexpr (
    +
    266  std::is_same_v<no_ref_t,
    +
    267  char> || std::is_same_v<no_ref_t, int8_t> || std::is_same_v<no_ref_t, int16_t>)
    +
    268  {
    +
    269  return static_cast<no_ref_t>(arg.GetInt());
    +
    270  }
    +
    271  else if constexpr (std::is_same_v<no_ref_t,
    +
    272  uint8_t> || std::is_same_v<no_ref_t, uint16_t>)
    +
    273  {
    +
    274  return static_cast<no_ref_t>(arg.GetUint());
    +
    275  }
    +
    276  else
    +
    277  {
    +
    278  return arg.Get<no_ref_t>();
    +
    279  }
    +
    280  }
    +
    281  else if constexpr (rpc::details::is_container_v<no_ref_t>)
    +
    282  {
    +
    283  using subvalue_t = typename no_ref_t::value_type;
    +
    284 
    +
    285  no_ref_t container{};
    +
    286  container.reserve(arg.Size());
    +
    287  unsigned j = 0;
    288 
    -
    289  if constexpr (std::is_same_v<R, std::string>)
    -
    290  {
    -
    291  return packed_func<R, Args...>(
    -
    292  serial_obj["func_name"].GetString(), result.GetString(), std::move(args));
    -
    293  }
    -
    294  else if constexpr (details::is_container_v<R>)
    -
    295  {
    -
    296  using value_t = typename R::value_type;
    -
    297  R container;
    -
    298  container.reserve(result.Size());
    -
    299 
    -
    300  unsigned j = 0;
    -
    301 
    -
    302  for (const auto& val : result.GetArray())
    +
    289  for (const auto& val : arg.GetArray())
    +
    290  {
    +
    291  container.push_back(parse_args<subvalue_t>(val, j));
    +
    292  }
    +
    293 
    +
    294  return container;
    +
    295  }
    +
    296  else if constexpr (rpc::details::is_serializable_v<rapidjson_adapter, no_ref_t>)
    +
    297  {
    +
    298  doc_t d{};
    +
    299  d.CopyFrom(arg, d.GetAllocator());
    +
    300  return no_ref_t::template deserialize<rapidjson_adapter>(d);
    +
    301  }
    +
    302  else
    303  {
    -
    304  container.push_back(parse_arg<value_t>(val, j));
    -
    305  }
    -
    306 
    -
    307  return packed_func<R, Args...>(
    -
    308  serial_obj["func_name"].GetString(), container, std::move(args));
    -
    309  }
    -
    310  else if constexpr (std::is_arithmetic_v<R>)
    -
    311  {
    -
    312  if constexpr (std::is_same_v<R,
    -
    313  char> || std::is_same_v<R, int8_t> || std::is_same_v<R, int16_t>)
    -
    314  {
    -
    315  return packed_func<R, Args...>(
    -
    316  serial_obj["func_name"].GetString(), result.GetInt(), std::move(args));
    +
    304  doc_t d{};
    +
    305  d.CopyFrom(arg, d.GetAllocator());
    +
    306  return rapidjson_adapter::template deserialize<no_ref_t>(d);
    +
    307  }
    +
    308  }
    +
    309 
    +
    310  template<typename T>
    +
    311  [[nodiscard]] std::remove_cv_t<std::remove_reference_t<T>> parse_args(
    +
    312  const value_t& arg_arr, unsigned& index)
    +
    313  {
    +
    314  if (arg_arr.IsArray() && index >= arg_arr.GetArray().Size())
    +
    315  {
    +
    316  throw exceptions::function_mismatch("Argument count mismatch");
    317  }
    -
    318  else if constexpr (std::is_same_v<R, uint8_t> || std::is_same_v<R, uint16_t>)
    -
    319  {
    -
    320  return packed_func<R, Args...>(
    -
    321  serial_obj["func_name"].GetString(), result.GetUint(), std::move(args));
    -
    322  }
    -
    323  else
    -
    324  {
    -
    325  return packed_func<R, Args...>(
    -
    326  serial_obj["func_name"].GetString(), result.Get<R>(), std::move(args));
    -
    327  }
    -
    328  }
    -
    329  else if constexpr (details::is_serializable_v<rapidjson_adapter, R>)
    -
    330  {
    -
    331  rapidjson_doc d;
    -
    332  d.CopyFrom(result, d.GetAllocator());
    -
    333  return packed_func<R, Args...>(serial_obj["func_name"].GetString(),
    -
    334  R::template deserialize<rapidjson_adapter>(d), std::move(args));
    -
    335  }
    -
    336  else
    -
    337  {
    -
    338  rapidjson_doc d;
    -
    339  d.CopyFrom(result, d.GetAllocator());
    -
    340  return packed_func<R, Args...>(serial_obj["func_name"].GetString(),
    -
    341  rapidjson_adapter::template deserialize<R>(d), args);
    -
    342  }
    -
    343  }
    -
    344 
    -
    345  packed_func<R, Args...> pack(
    -
    346  serial_obj["func_name"].GetString(), std::nullopt, std::move(args));
    -
    347 
    -
    348  if (serial_obj.HasMember("err_mesg"))
    -
    349  {
    -
    350  pack.set_err_mesg(serial_obj["err_mesg"].GetString());
    -
    351  }
    +
    318 
    +
    319  const value_t& arg = arg_arr.IsArray() ? arg_arr.GetArray()[index++] : arg_arr;
    +
    320  return parse_arg<T>(arg);
    +
    321  }
    +
    322  } // namespace details
    +
    323  } // namespace rapidjson
    +
    324 } // namespace adapters
    +
    325 
    +
    326 template<>
    +
    327 [[nodiscard]] inline std::string adapters::rapidjson_adapter::to_bytes(
    +
    328  adapters::rapidjson::doc_t&& serial_obj)
    +
    329 {
    +
    330  rapidjson::StringBuffer buffer{};
    +
    331  rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
    +
    332  std::move(serial_obj).Accept(writer);
    +
    333  return buffer.GetString();
    +
    334 }
    +
    335 
    +
    336 template<>
    +
    337 [[nodiscard]] inline adapters::rapidjson::doc_t adapters::rapidjson_adapter::from_bytes(
    +
    338  std::string&& bytes)
    +
    339 {
    +
    340  adapters::rapidjson::doc_t d{};
    +
    341  d.SetObject();
    +
    342  d.Parse(std::move(bytes).c_str());
    +
    343  return d;
    +
    344 }
    +
    345 
    +
    346 template<>
    +
    347 template<typename R, typename... Args>
    +
    348 [[nodiscard]] adapters::rapidjson::doc_t pack_adapter<adapters::rapidjson_adapter>::serialize_pack(
    +
    349  const ::rpc::details::packed_func<R, Args...>& pack)
    +
    350 {
    +
    351  using namespace adapters::rapidjson;
    352 
    -
    353  return pack;
    -
    354  }
    -
    355 }
    +
    353  doc_t d{};
    +
    354  auto& alloc = d.GetAllocator();
    +
    355  d.SetObject();
    356 
    -
    357 template<>
    -
    358 inline std::string pack_adapter<adapters::rapidjson_adapter>::get_func_name(
    -
    359  const adapters::rapidjson_doc& serial_obj)
    -
    360 {
    -
    361  return serial_obj["func_name"].GetString();
    -
    362 }
    -
    363 
    -
    364 template<>
    -
    365 inline void pack_adapter<adapters::rapidjson_adapter>::set_err_mesg(
    -
    366  adapters::rapidjson_doc& serial_obj, std::string mesg)
    -
    367 {
    -
    368  auto& alloc = serial_obj.GetAllocator();
    -
    369 
    -
    370  if (serial_obj.HasMember("err_mesg"))
    -
    371  {
    -
    372  serial_obj["HasMember"].SetString(std::move(mesg).c_str(), alloc);
    -
    373  }
    -
    374  else
    -
    375  {
    -
    376  adapters::rapidjson_val v;
    -
    377  v.SetString(std::move(mesg).c_str(), alloc);
    -
    378  serial_obj.AddMember("err_mesg", v, alloc);
    -
    379  }
    -
    380 }
    -
    381 } // namespace rpc
    -
    rpc::pack_adapter::deserialize_pack
    static packed_func< R, Args... > deserialize_pack(const typename Serial::serial_t &serial_obj)
    De-serializes a serial object to a packed_func.
    +
    357  d.AddMember("func_name", value_t{}.SetString(pack.get_func_name().c_str(), alloc), alloc);
    +
    358 
    +
    359  if constexpr (!std::is_void_v<R>)
    +
    360  {
    +
    361  value_t result{};
    +
    362 
    +
    363  if (pack)
    +
    364  {
    +
    365  if constexpr (std::is_arithmetic_v<R>)
    +
    366  {
    +
    367  result.Set<R>(pack.get_result());
    +
    368  }
    +
    369  else if constexpr (std::is_same_v<R, std::string>)
    +
    370  {
    +
    371  result.SetString(pack.get_result().c_str(), alloc);
    +
    372  }
    +
    373  else if constexpr (rpc::details::is_container_v<R>)
    +
    374  {
    +
    375  const auto& container = pack.get_result();
    +
    376  result.SetArray();
    +
    377  result.Reserve(static_cast<::rapidjson::SizeType>(container.size()), alloc);
    +
    378 
    +
    379  for (const auto& val : container)
    +
    380  {
    +
    381  result.PushBack(val, alloc);
    +
    382  }
    +
    383  }
    +
    384  else if constexpr (rpc::details::is_serializable_v<adapters::rapidjson_adapter, R>)
    +
    385  {
    +
    386  doc_t tmp = R::template serialize<adapters::rapidjson_adapter>(pack.get_result());
    +
    387  result.CopyFrom(tmp, alloc);
    +
    388  }
    +
    389  else
    +
    390  {
    +
    391  doc_t tmp = adapters::rapidjson_adapter::template serialize<R>(pack.get_result());
    +
    392  result.CopyFrom(tmp, alloc);
    +
    393  }
    +
    394  }
    +
    395  else
    +
    396  {
    +
    397  result.SetNull();
    +
    398  }
    +
    399 
    +
    400  d.AddMember("result", result, alloc);
    +
    401  }
    +
    402 
    +
    403  value_t args{};
    +
    404  args.SetArray();
    +
    405  args.Reserve(static_cast<::rapidjson::SizeType>(sizeof...(Args)), alloc);
    +
    406  const auto& argTup = pack.get_args();
    +
    407 
    +
    408  rpc::details::for_each_tuple(argTup,
    +
    409  [&args, &alloc](auto&& x)
    +
    410  { adapters::rapidjson::details::push_args(std::forward<decltype(x)>(x), args, alloc); });
    +
    411 
    +
    412  d.AddMember("args", std::move(args), alloc);
    +
    413  return d;
    +
    414 }
    +
    415 
    +
    416 template<>
    +
    417 template<typename R, typename... Args>
    +
    418 [[nodiscard]] ::rpc::details::packed_func<R, Args...> pack_adapter<
    +
    419  adapters::rapidjson_adapter>::deserialize_pack(const adapters::rapidjson::doc_t& serial_obj)
    +
    420 {
    +
    421  using namespace adapters::rapidjson;
    +
    422 
    +
    423  [[maybe_unused]] unsigned i = 0;
    +
    424 
    +
    425  typename ::rpc::details::packed_func<R, Args...>::args_t args{
    +
    426  adapters::rapidjson::details::parse_args<Args>(serial_obj["args"], i)...
    +
    427  };
    +
    428 
    +
    429  if constexpr (std::is_void_v<R>)
    +
    430  {
    +
    431  ::rpc::details::packed_func<void, Args...> pack(
    +
    432  serial_obj["func_name"].GetString(), std::move(args));
    +
    433 
    +
    434  if (serial_obj.HasMember("except_type"))
    +
    435  {
    +
    436  pack.set_exception(serial_obj["err_mesg"].GetString(),
    +
    437  static_cast<rpc::exceptions::Type>(serial_obj["except_type"].GetInt()));
    +
    438  }
    +
    439 
    +
    440  return pack;
    +
    441  }
    +
    442  else
    +
    443  {
    +
    444  if (serial_obj.HasMember("result") && !serial_obj["result"].IsNull())
    +
    445  {
    +
    446  const value_t& result = serial_obj["result"];
    +
    447 
    +
    448  return ::rpc::details::packed_func<R, Args...>(serial_obj["func_name"].GetString(),
    +
    449  adapters::rapidjson::details::parse_arg<R>(result), std::move(args));
    +
    450  }
    +
    451 
    +
    452  ::rpc::details::packed_func<R, Args...> pack(
    +
    453  serial_obj["func_name"].GetString(), std::nullopt, std::move(args));
    +
    454 
    +
    455  if (serial_obj.HasMember("except_type"))
    +
    456  {
    +
    457  pack.set_exception(serial_obj["err_mesg"].GetString(),
    +
    458  static_cast<rpc::exceptions::Type>(serial_obj["except_type"].GetInt()));
    +
    459  }
    +
    460 
    +
    461  return pack;
    +
    462  }
    +
    463 }
    +
    464 
    +
    465 template<>
    +
    466 [[nodiscard]] inline std::string pack_adapter<adapters::rapidjson_adapter>::get_func_name(
    +
    467  const adapters::rapidjson::doc_t& serial_obj)
    +
    468 {
    +
    469  return serial_obj["func_name"].GetString();
    +
    470 }
    +
    471 
    +
    472 template<>
    +
    473 inline void pack_adapter<adapters::rapidjson_adapter>::set_exception(
    +
    474  adapters::rapidjson::doc_t& serial_obj, const rpc::exceptions::rpc_exception& ex)
    +
    475 {
    +
    476  auto& alloc = serial_obj.GetAllocator();
    +
    477 
    +
    478  if (serial_obj.HasMember("except_type"))
    +
    479  {
    +
    480  serial_obj["except_type"].SetInt(static_cast<int>(ex.get_type()));
    +
    481  serial_obj["err_mesg"].SetString(ex.what(), alloc);
    +
    482  }
    +
    483  else
    +
    484  {
    +
    485  serial_obj.AddMember("except_type", static_cast<int>(ex.get_type()), alloc);
    +
    486  serial_obj.AddMember(
    +
    487  "err_mesg", adapters::rapidjson::value_t{}.SetString(ex.what(), alloc), alloc);
    +
    488  }
    +
    489 }
    +
    490 } // namespace rpc
    +
    rpc::exceptions::rpc_exception
    Definition: rpc.hpp:94
    rpc::pack_adapter::get_func_name
    static std::string get_func_name(const typename Serial::serial_t &serial_obj)
    Extracts the function name of a serialized function call.
    -
    rpc::pack_adapter::serialize_pack
    static Serial::serial_t serialize_pack(const packed_func< R, Args... > &pack)
    Serializes a packed_func to a serial object.
    -
    rpc::pack_adapter::set_err_mesg
    static void set_err_mesg(typename Serial::serial_t &serial_obj, std::string mesg)
    Sets the error message for the serialized function call.
    -
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:69
    +
    rpc::pack_adapter::serialize_pack
    static Serial::serial_t serialize_pack(const details::packed_func< R, Args... > &pack)
    Serializes a packed_func to a serial object.
    +
    rpc
    Top-level namespace for rpc.hpp classes and functions.
    Definition: rpc.hpp:73
    diff --git a/docs/search/all_0.js b/docs/search/all_0.js index c37d868a..cd68393e 100644 --- a/docs/search/all_0.js +++ b/docs/search/all_0.js @@ -1,6 +1,8 @@ var searchData= [ - ['call_5ffunc_0',['call_func',['../classrpc_1_1client_1_1client__interface.html#a5cc7a0f8b893f4eefd5157b8e76573f4',1,'rpc::client::client_interface']]], - ['clear_5fresult_1',['clear_result',['../classrpc_1_1packed__func.html#a69918d28c9baea0291c735df6f0865f4',1,'rpc::packed_func']]], - ['client_5finterface_2',['client_interface',['../classrpc_1_1client_1_1client__interface.html',1,'rpc::client::client_interface< Serial >'],['../classrpc_1_1client_1_1client__interface.html',1,'rpc::client_interface< Serial >']]] + ['call_5ffunc_0',['call_func',['../classrpc_1_1client_1_1client__interface.html#a13cb1ee5075bba41f2a26d6cf3b420b3',1,'rpc::client::client_interface::call_func(const std::string &func_name, Args &&... args)'],['../classrpc_1_1client_1_1client__interface.html#a61ef1336c96e7c6a4740391665b1c198',1,'rpc::client::client_interface::call_func(std::string &&func_name, Args &&... args)']]], + ['client_5finterface_1',['client_interface',['../classrpc_1_1client_1_1client__interface.html',1,'rpc::client::client_interface< Serial >'],['../classrpc_1_1client_1_1client__interface.html',1,'rpc::client_interface< Serial >']]], + ['client_5freceive_5ferror_2',['client_receive_error',['../classrpc_1_1exceptions_1_1client__receive__error.html',1,'rpc::exceptions']]], + ['client_5fsend_5ferror_3',['client_send_error',['../classrpc_1_1exceptions_1_1client__send__error.html',1,'rpc::exceptions']]], + ['contributor_20covenant_20code_20of_20conduct_4',['Contributor Covenant Code of Conduct',['../md__c_o_d_e__o_f__c_o_n_d_u_c_t.html',1,'']]] ]; diff --git a/docs/search/all_1.js b/docs/search/all_1.js index 98c0480c..3534f994 100644 --- a/docs/search/all_1.js +++ b/docs/search/all_1.js @@ -1,8 +1,8 @@ var searchData= [ - ['deserialize_5fpack_3',['deserialize_pack',['../classrpc_1_1pack__adapter.html#a3b42b493777bc20d6973ad082b9d29f2',1,'rpc::pack_adapter']]], - ['dispatch_4',['dispatch',['../classrpc_1_1server_1_1server__interface.html#a8052947e620688b4b2bde4dabfa0c8f0',1,'rpc::server::server_interface']]], - ['dispatch_5fcached_5ffunc_5',['dispatch_cached_func',['../classrpc_1_1server_1_1server__interface.html#a9043fffe7bdcbb3681f6fd26eb048507',1,'rpc::server::server_interface']]], - ['dispatch_5ffunc_6',['dispatch_func',['../classrpc_1_1server_1_1server__interface.html#a3c4b127d19f2c7b96d9518e57f0a93ce',1,'rpc::server::server_interface']]], - ['dispatch_5fimpl_7',['dispatch_impl',['../classrpc_1_1server_1_1server__interface.html#a301cab7ee170a066603b9e655c5f2d43',1,'rpc::server::server_interface']]] + ['deserialization_5ferror_5',['deserialization_error',['../classrpc_1_1exceptions_1_1deserialization__error.html',1,'rpc::exceptions']]], + ['deserialize_5fpack_6',['deserialize_pack',['../classrpc_1_1pack__adapter.html#a734a7928c5648972adf40008a6bc09d0',1,'rpc::pack_adapter']]], + ['dispatch_7',['dispatch',['../classrpc_1_1server_1_1server__interface.html#a8052947e620688b4b2bde4dabfa0c8f0',1,'rpc::server::server_interface']]], + ['dispatch_5fcached_5ffunc_8',['dispatch_cached_func',['../classrpc_1_1server_1_1server__interface.html#ab6055dff21bc516eff7956117488184f',1,'rpc::server::server_interface']]], + ['dispatch_5ffunc_9',['dispatch_func',['../classrpc_1_1server_1_1server__interface.html#a3c4b127d19f2c7b96d9518e57f0a93ce',1,'rpc::server::server_interface']]] ]; diff --git a/docs/search/all_2.js b/docs/search/all_2.js index 5a4a304c..5e70a4c7 100644 --- a/docs/search/all_2.js +++ b/docs/search/all_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['get_5ffunc_5fname_8',['get_func_name',['../classrpc_1_1pack__adapter.html#a97335816daece357925dadcd95ebbfde',1,'rpc::pack_adapter']]], - ['get_5fresult_9',['get_result',['../classrpc_1_1packed__func.html#a806c046cd6e9f2301da0a37c78f8e2d7',1,'rpc::packed_func']]] + ['function_5fmismatch_10',['function_mismatch',['../classrpc_1_1exceptions_1_1function__mismatch.html',1,'rpc::exceptions']]], + ['function_5fnot_5ffound_11',['function_not_found',['../classrpc_1_1exceptions_1_1function__not__found.html',1,'rpc::exceptions']]] ]; diff --git a/docs/search/all_3.js b/docs/search/all_3.js index f2c274c9..97c8d6b7 100644 --- a/docs/search/all_3.js +++ b/docs/search/all_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['operator_20bool_10',['operator bool',['../classrpc_1_1packed__func.html#a7b6b3a5073fbecabe4420f78603adf4f',1,'rpc::packed_func']]] + ['get_5ffunc_5fname_12',['get_func_name',['../classrpc_1_1pack__adapter.html#a97335816daece357925dadcd95ebbfde',1,'rpc::pack_adapter']]] ]; diff --git a/docs/search/all_4.js b/docs/search/all_4.js index 4deae585..caf3df3d 100644 --- a/docs/search/all_4.js +++ b/docs/search/all_4.js @@ -1,6 +1,5 @@ var searchData= [ - ['pack_5fadapter_11',['pack_adapter',['../classrpc_1_1pack__adapter.html',1,'rpc']]], - ['packed_5ffunc_12',['packed_func',['../classrpc_1_1packed__func.html#aef4285a1e20b28b275ccf3947ed65d31',1,'rpc::packed_func::packed_func()'],['../classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html#a6d8d040cbd7755f7491887ba0fa9bc6f',1,'rpc::packed_func< void, Args... >::packed_func()'],['../classrpc_1_1packed__func.html',1,'rpc::packed_func< R, Args >']]], - ['packed_5ffunc_3c_20void_2c_20args_2e_2e_2e_20_3e_13',['packed_func< void, Args... >',['../classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html',1,'rpc']]] + ['hash_3c_20std_3a_3avector_3c_20uint8_5ft_20_3e_20_3e_13',['hash< std::vector< uint8_t > >',['../structstd_1_1hash_3_01std_1_1vector_3_01uint8__t_01_4_01_4.html',1,'std']]], + ['how_20to_20contribute_14',['How to Contribute',['../md__c_o_n_t_r_i_b_u_t_i_n_g.html',1,'']]] ]; diff --git a/docs/search/all_5.js b/docs/search/all_5.js index ef9e79a3..2bf90229 100644 --- a/docs/search/all_5.js +++ b/docs/search/all_5.js @@ -1,28 +1,4 @@ var searchData= [ - ['client_14',['client',['../namespacerpc_1_1client.html',1,'rpc']]], - ['details_15',['details',['../namespacerpc_1_1details.html',1,'rpc']]], - ['receive_16',['receive',['../classrpc_1_1client_1_1client__interface.html#ac183a72ae42949d1995d919e248909bd',1,'rpc::client::client_interface']]], - ['result_5ft_17',['result_t',['../classrpc_1_1packed__func.html#ae2485fe8827883a17c8c8e6d8876c510',1,'rpc::packed_func::result_t()'],['../classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html#a8b8df53d5d47247870a289ff077d3b09',1,'rpc::packed_func< void, Args... >::result_t()']]], - ['rpc_18',['rpc',['../namespacerpc.html',1,'']]], - ['rpc_2ehpp_19',['rpc.hpp',['../rpc_8hpp.html',1,'']]], - ['rpc_5falias_5fcached_5ffunc_20',['RPC_ALIAS_CACHED_FUNC',['../rpc__dispatch__helper_8hpp.html#a3d26fb2bdbdaf4a07cb3db322438a535',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5falias_5ffunc_21',['RPC_ALIAS_FUNC',['../rpc__dispatch__helper_8hpp.html#a53c1701bdc48f45cf816f719c31c459d',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fattach_5fcached_5ffunc_22',['RPC_ATTACH_CACHED_FUNC',['../rpc__dispatch__helper_8hpp.html#a1fd97337976f1caa9eb2e40d4783a981',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fattach_5fcached_5ffuncs_23',['RPC_ATTACH_CACHED_FUNCS',['../rpc__dispatch__helper_8hpp.html#ab2f290069829c2a1888c6bdf879f80de',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fattach_5ffunc_24',['RPC_ATTACH_FUNC',['../rpc__dispatch__helper_8hpp.html#a8c550cde657b130fbf88587ec4c8807a',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fattach_5ffuncs_25',['RPC_ATTACH_FUNCS',['../rpc__dispatch__helper_8hpp.html#ac5e4f21a2987e073f9009cf683c1c34e',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fboost_5fjson_2ehpp_26',['rpc_boost_json.hpp',['../rpc__boost__json_8hpp.html',1,'']]], - ['rpc_5fdefault_5fdispatch_27',['RPC_DEFAULT_DISPATCH',['../rpc__dispatch__helper_8hpp.html#af644f9b75ee44bf766427b50557dce70',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fdispatch_5fhelper_2ehpp_28',['rpc_dispatch_helper.hpp',['../rpc__dispatch__helper_8hpp.html',1,'']]], - ['rpc_5fhpp_5fclient_5fimpl_29',['RPC_HPP_CLIENT_IMPL',['../rpc_8hpp.html#af56044a2d07e951cbf315821dd3f1a41',1,'rpc.hpp']]], - ['rpc_5fhpp_5fenable_5fserver_5fcache_30',['RPC_HPP_ENABLE_SERVER_CACHE',['../rpc_8hpp.html#aa68fe684faf759e42e530ec4584f09fa',1,'rpc.hpp']]], - ['rpc_5fhpp_5fmodule_5fimpl_31',['RPC_HPP_MODULE_IMPL',['../rpc_8hpp.html#ae19f6e09c9f97b2789404cc054dd8811',1,'rpc.hpp']]], - ['rpc_5fhpp_5fserver_5fimpl_32',['RPC_HPP_SERVER_IMPL',['../rpc_8hpp.html#a036051135b9379ac43ff4d6023827325',1,'rpc.hpp']]], - ['rpc_5fmulti_5falias_5fcached_5ffunc_33',['RPC_MULTI_ALIAS_CACHED_FUNC',['../rpc__dispatch__helper_8hpp.html#a3538fd2178d5c87d931cec226063e956',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fmulti_5falias_5ffunc_34',['RPC_MULTI_ALIAS_FUNC',['../rpc__dispatch__helper_8hpp.html#a946963e302f5510f1459de088880a28f',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fnjson_2ehpp_35',['rpc_njson.hpp',['../rpc__njson_8hpp.html',1,'']]], - ['rpc_5frapidjson_2ehpp_36',['rpc_rapidjson.hpp',['../rpc__rapidjson_8hpp.html',1,'']]], - ['run_5fcallback_37',['run_callback',['../classrpc_1_1server_1_1server__interface.html#ac5d9e8286cff4d1c0183f8bf089ab8aa',1,'rpc::server::server_interface']]], - ['server_38',['server',['../namespacerpc_1_1server.html',1,'rpc']]] + ['installation_20guide_15',['Installation Guide',['../md__i_n_s_t_a_l_l.html',1,'']]] ]; diff --git a/docs/search/all_6.js b/docs/search/all_6.js index 2d84401f..41e35afa 100644 --- a/docs/search/all_6.js +++ b/docs/search/all_6.js @@ -1,8 +1,8 @@ var searchData= [ - ['send_39',['send',['../classrpc_1_1client_1_1client__interface.html#aa7c513e73a82d7c5ef0bf1401b3acd4a',1,'rpc::client::client_interface']]], - ['serialize_5fpack_40',['serialize_pack',['../classrpc_1_1pack__adapter.html#aa2b0dc1bb016265f0dc367a56ff31208',1,'rpc::pack_adapter']]], - ['server_5finterface_41',['server_interface',['../classrpc_1_1server_1_1server__interface.html',1,'rpc::server::server_interface< Serial >'],['../classrpc_1_1server_1_1server__interface.html',1,'rpc::server_interface< Serial >']]], - ['set_5ferr_5fmesg_42',['set_err_mesg',['../classrpc_1_1pack__adapter.html#ac5569c012b082665157f2033f4c39a75',1,'rpc::pack_adapter']]], - ['set_5fresult_43',['set_result',['../classrpc_1_1packed__func.html#a7fd739d3cf02f83a81e9dbbac39ce187',1,'rpc::packed_func']]] + ['largest_16',['largest',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest.html',1,'rpc::adapters::bitsery::details']]], + ['largest_3c_20t_2c_200_20_3e_17',['largest< T, 0 >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_010_01_4.html',1,'rpc::adapters::bitsery::details']]], + ['largest_3c_20t_2c_203_20_3e_18',['largest< T, 3 >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_013_01_4.html',1,'rpc::adapters::bitsery::details']]], + ['largest_3c_20t_2c_204_20_3e_19',['largest< T, 4 >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_014_01_4.html',1,'rpc::adapters::bitsery::details']]], + ['largest_3c_20t_2c_206_20_3e_20',['largest< T, 6 >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_016_01_4.html',1,'rpc::adapters::bitsery::details']]] ]; diff --git a/docs/search/typedefs_0.html b/docs/search/all_7.html similarity index 95% rename from docs/search/typedefs_0.html rename to docs/search/all_7.html index a4684c4a..8ddbf6c8 100644 --- a/docs/search/typedefs_0.html +++ b/docs/search/all_7.html @@ -4,7 +4,7 @@ - + diff --git a/docs/search/all_7.js b/docs/search/all_7.js new file mode 100644 index 00000000..3df26697 --- /dev/null +++ b/docs/search/all_7.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['pack_5fadapter_21',['pack_adapter',['../classrpc_1_1pack__adapter.html',1,'rpc']]], + ['pack_5fhelper_22',['pack_helper',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper.html',1,'rpc::adapters::bitsery::details']]], + ['pack_5fhelper_3c_20void_2c_20args_2e_2e_2e_20_3e_23',['pack_helper< void, Args... >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper_3_01void_00_01_args_8_8_8_01_4.html',1,'rpc::adapters::bitsery::details']]] +]; diff --git a/docs/search/functions_5.html b/docs/search/all_8.html similarity index 95% rename from docs/search/functions_5.html rename to docs/search/all_8.html index 9301d6b9..83c55ae2 100644 --- a/docs/search/functions_5.html +++ b/docs/search/all_8.html @@ -4,7 +4,7 @@ - + diff --git a/docs/search/all_8.js b/docs/search/all_8.js new file mode 100644 index 00000000..e722c6db --- /dev/null +++ b/docs/search/all_8.js @@ -0,0 +1,21 @@ +var searchData= +[ + ['client_24',['client',['../namespacerpc_1_1client.html',1,'rpc']]], + ['details_25',['details',['../namespacerpc_1_1details.html',1,'rpc']]], + ['receive_26',['receive',['../classrpc_1_1client_1_1client__interface.html#ac183a72ae42949d1995d919e248909bd',1,'rpc::client::client_interface']]], + ['remote_5fexec_5ferror_27',['remote_exec_error',['../classrpc_1_1exceptions_1_1remote__exec__error.html',1,'rpc::exceptions']]], + ['rpc_28',['rpc',['../namespacerpc.html',1,'']]], + ['rpc_2ehpp_29',['rpc.hpp',['../rpc_8hpp.html',1,'']]], + ['rpc_2ehpp_20security_20policy_30',['rpc.hpp Security Policy',['../md__s_e_c_u_r_i_t_y.html',1,'']]], + ['rpc_5fbitsery_2ehpp_31',['rpc_bitsery.hpp',['../rpc__bitsery_8hpp.html',1,'']]], + ['rpc_5fboost_5fjson_2ehpp_32',['rpc_boost_json.hpp',['../rpc__boost__json_8hpp.html',1,'']]], + ['rpc_5fdispatch_5fhelper_2ehpp_33',['rpc_dispatch_helper.hpp',['../rpc__dispatch__helper_8hpp.html',1,'']]], + ['rpc_5fexception_34',['rpc_exception',['../classrpc_1_1exceptions_1_1rpc__exception.html',1,'rpc::exceptions']]], + ['rpc_5fhpp_5fclient_5fimpl_35',['RPC_HPP_CLIENT_IMPL',['../rpc_8hpp.html#af56044a2d07e951cbf315821dd3f1a41',1,'rpc.hpp']]], + ['rpc_5fhpp_5fenable_5fserver_5fcache_36',['RPC_HPP_ENABLE_SERVER_CACHE',['../rpc_8hpp.html#aa68fe684faf759e42e530ec4584f09fa',1,'rpc.hpp']]], + ['rpc_5fhpp_5fmodule_5fimpl_37',['RPC_HPP_MODULE_IMPL',['../rpc_8hpp.html#ae19f6e09c9f97b2789404cc054dd8811',1,'rpc.hpp']]], + ['rpc_5fhpp_5fserver_5fimpl_38',['RPC_HPP_SERVER_IMPL',['../rpc_8hpp.html#a036051135b9379ac43ff4d6023827325',1,'rpc.hpp']]], + ['rpc_5fnjson_2ehpp_39',['rpc_njson.hpp',['../rpc__njson_8hpp.html',1,'']]], + ['rpc_5frapidjson_2ehpp_40',['rpc_rapidjson.hpp',['../rpc__rapidjson_8hpp.html',1,'']]], + ['server_41',['server',['../namespacerpc_1_1server.html',1,'rpc']]] +]; diff --git a/docs/search/functions_6.html b/docs/search/all_9.html similarity index 95% rename from docs/search/functions_6.html rename to docs/search/all_9.html index 9c4f5fc6..1e263c13 100644 --- a/docs/search/functions_6.html +++ b/docs/search/all_9.html @@ -4,7 +4,7 @@ - + diff --git a/docs/search/all_9.js b/docs/search/all_9.js new file mode 100644 index 00000000..2418d332 --- /dev/null +++ b/docs/search/all_9.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['send_42',['send',['../classrpc_1_1client_1_1client__interface.html#aa7c513e73a82d7c5ef0bf1401b3acd4a',1,'rpc::client::client_interface::send(const typename Serial::bytes_t &bytes)=0'],['../classrpc_1_1client_1_1client__interface.html#acb339a35647fe87c7efd269bd626a76c',1,'rpc::client::client_interface::send(typename Serial::bytes_t &&bytes)=0']]], + ['serialization_5ferror_43',['serialization_error',['../classrpc_1_1exceptions_1_1serialization__error.html',1,'rpc::exceptions']]], + ['serialize_5fpack_44',['serialize_pack',['../classrpc_1_1pack__adapter.html#ac47543bf59d27ca6dc6faf771a31abb0',1,'rpc::pack_adapter']]], + ['server_5finterface_45',['server_interface',['../classrpc_1_1server_1_1server__interface.html',1,'rpc::server::server_interface< Serial >'],['../classrpc_1_1server_1_1server__interface.html',1,'rpc::server_interface< Serial >']]], + ['server_5freceive_5ferror_46',['server_receive_error',['../classrpc_1_1exceptions_1_1server__receive__error.html',1,'rpc::exceptions']]], + ['server_5fsend_5ferror_47',['server_send_error',['../classrpc_1_1exceptions_1_1server__send__error.html',1,'rpc::exceptions']]] +]; diff --git a/docs/search/classes_0.js b/docs/search/classes_0.js index be4d61e5..c2e8a659 100644 --- a/docs/search/classes_0.js +++ b/docs/search/classes_0.js @@ -1,4 +1,6 @@ var searchData= [ - ['client_5finterface_44',['client_interface',['../classrpc_1_1client_1_1client__interface.html',1,'rpc::client::client_interface< Serial >'],['../classrpc_1_1client_1_1client__interface.html',1,'rpc::client_interface< Serial >']]] + ['client_5finterface_48',['client_interface',['../classrpc_1_1client_1_1client__interface.html',1,'rpc::client::client_interface< Serial >'],['../classrpc_1_1client_1_1client__interface.html',1,'rpc::client_interface< Serial >']]], + ['client_5freceive_5ferror_49',['client_receive_error',['../classrpc_1_1exceptions_1_1client__receive__error.html',1,'rpc::exceptions']]], + ['client_5fsend_5ferror_50',['client_send_error',['../classrpc_1_1exceptions_1_1client__send__error.html',1,'rpc::exceptions']]] ]; diff --git a/docs/search/classes_1.js b/docs/search/classes_1.js index 6084aae5..b12baa63 100644 --- a/docs/search/classes_1.js +++ b/docs/search/classes_1.js @@ -1,6 +1,4 @@ var searchData= [ - ['pack_5fadapter_45',['pack_adapter',['../classrpc_1_1pack__adapter.html',1,'rpc']]], - ['packed_5ffunc_46',['packed_func',['../classrpc_1_1packed__func.html',1,'rpc']]], - ['packed_5ffunc_3c_20void_2c_20args_2e_2e_2e_20_3e_47',['packed_func< void, Args... >',['../classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html',1,'rpc']]] + ['deserialization_5ferror_51',['deserialization_error',['../classrpc_1_1exceptions_1_1deserialization__error.html',1,'rpc::exceptions']]] ]; diff --git a/docs/search/classes_2.js b/docs/search/classes_2.js index feea0a81..515d17dd 100644 --- a/docs/search/classes_2.js +++ b/docs/search/classes_2.js @@ -1,4 +1,5 @@ var searchData= [ - ['server_5finterface_48',['server_interface',['../classrpc_1_1server_1_1server__interface.html',1,'rpc::server::server_interface< Serial >'],['../classrpc_1_1server_1_1server__interface.html',1,'rpc::server_interface< Serial >']]] + ['function_5fmismatch_52',['function_mismatch',['../classrpc_1_1exceptions_1_1function__mismatch.html',1,'rpc::exceptions']]], + ['function_5fnot_5ffound_53',['function_not_found',['../classrpc_1_1exceptions_1_1function__not__found.html',1,'rpc::exceptions']]] ]; diff --git a/docs/search/classes_3.html b/docs/search/classes_3.html new file mode 100644 index 00000000..d33343bc --- /dev/null +++ b/docs/search/classes_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/classes_3.js b/docs/search/classes_3.js new file mode 100644 index 00000000..eda32400 --- /dev/null +++ b/docs/search/classes_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['hash_3c_20std_3a_3avector_3c_20uint8_5ft_20_3e_20_3e_54',['hash< std::vector< uint8_t > >',['../structstd_1_1hash_3_01std_1_1vector_3_01uint8__t_01_4_01_4.html',1,'std']]] +]; diff --git a/docs/search/classes_4.html b/docs/search/classes_4.html new file mode 100644 index 00000000..8430b07f --- /dev/null +++ b/docs/search/classes_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/classes_4.js b/docs/search/classes_4.js new file mode 100644 index 00000000..1358cbe2 --- /dev/null +++ b/docs/search/classes_4.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['largest_55',['largest',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest.html',1,'rpc::adapters::bitsery::details']]], + ['largest_3c_20t_2c_200_20_3e_56',['largest< T, 0 >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_010_01_4.html',1,'rpc::adapters::bitsery::details']]], + ['largest_3c_20t_2c_203_20_3e_57',['largest< T, 3 >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_013_01_4.html',1,'rpc::adapters::bitsery::details']]], + ['largest_3c_20t_2c_204_20_3e_58',['largest< T, 4 >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_014_01_4.html',1,'rpc::adapters::bitsery::details']]], + ['largest_3c_20t_2c_206_20_3e_59',['largest< T, 6 >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_016_01_4.html',1,'rpc::adapters::bitsery::details']]] +]; diff --git a/docs/search/classes_5.html b/docs/search/classes_5.html new file mode 100644 index 00000000..c2f1b767 --- /dev/null +++ b/docs/search/classes_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/classes_5.js b/docs/search/classes_5.js new file mode 100644 index 00000000..bd71496f --- /dev/null +++ b/docs/search/classes_5.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['pack_5fadapter_60',['pack_adapter',['../classrpc_1_1pack__adapter.html',1,'rpc']]], + ['pack_5fhelper_61',['pack_helper',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper.html',1,'rpc::adapters::bitsery::details']]], + ['pack_5fhelper_3c_20void_2c_20args_2e_2e_2e_20_3e_62',['pack_helper< void, Args... >',['../structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper_3_01void_00_01_args_8_8_8_01_4.html',1,'rpc::adapters::bitsery::details']]] +]; diff --git a/docs/search/classes_6.html b/docs/search/classes_6.html new file mode 100644 index 00000000..e39847ce --- /dev/null +++ b/docs/search/classes_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/classes_6.js b/docs/search/classes_6.js new file mode 100644 index 00000000..34a0d5b6 --- /dev/null +++ b/docs/search/classes_6.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['remote_5fexec_5ferror_63',['remote_exec_error',['../classrpc_1_1exceptions_1_1remote__exec__error.html',1,'rpc::exceptions']]], + ['rpc_5fexception_64',['rpc_exception',['../classrpc_1_1exceptions_1_1rpc__exception.html',1,'rpc::exceptions']]] +]; diff --git a/docs/search/classes_7.html b/docs/search/classes_7.html new file mode 100644 index 00000000..a2c4d1a3 --- /dev/null +++ b/docs/search/classes_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/classes_7.js b/docs/search/classes_7.js new file mode 100644 index 00000000..fa15ab47 --- /dev/null +++ b/docs/search/classes_7.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['serialization_5ferror_65',['serialization_error',['../classrpc_1_1exceptions_1_1serialization__error.html',1,'rpc::exceptions']]], + ['server_5finterface_66',['server_interface',['../classrpc_1_1server_1_1server__interface.html',1,'rpc::server::server_interface< Serial >'],['../classrpc_1_1server_1_1server__interface.html',1,'rpc::server_interface< Serial >']]], + ['server_5freceive_5ferror_67',['server_receive_error',['../classrpc_1_1exceptions_1_1server__receive__error.html',1,'rpc::exceptions']]], + ['server_5fsend_5ferror_68',['server_send_error',['../classrpc_1_1exceptions_1_1server__send__error.html',1,'rpc::exceptions']]] +]; diff --git a/docs/search/defines_0.js b/docs/search/defines_0.js index e3f96da3..ce4194b8 100644 --- a/docs/search/defines_0.js +++ b/docs/search/defines_0.js @@ -1,16 +1,7 @@ var searchData= [ - ['rpc_5falias_5fcached_5ffunc_76',['RPC_ALIAS_CACHED_FUNC',['../rpc__dispatch__helper_8hpp.html#a3d26fb2bdbdaf4a07cb3db322438a535',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5falias_5ffunc_77',['RPC_ALIAS_FUNC',['../rpc__dispatch__helper_8hpp.html#a53c1701bdc48f45cf816f719c31c459d',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fattach_5fcached_5ffunc_78',['RPC_ATTACH_CACHED_FUNC',['../rpc__dispatch__helper_8hpp.html#a1fd97337976f1caa9eb2e40d4783a981',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fattach_5fcached_5ffuncs_79',['RPC_ATTACH_CACHED_FUNCS',['../rpc__dispatch__helper_8hpp.html#ab2f290069829c2a1888c6bdf879f80de',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fattach_5ffunc_80',['RPC_ATTACH_FUNC',['../rpc__dispatch__helper_8hpp.html#a8c550cde657b130fbf88587ec4c8807a',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fattach_5ffuncs_81',['RPC_ATTACH_FUNCS',['../rpc__dispatch__helper_8hpp.html#ac5e4f21a2987e073f9009cf683c1c34e',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fdefault_5fdispatch_82',['RPC_DEFAULT_DISPATCH',['../rpc__dispatch__helper_8hpp.html#af644f9b75ee44bf766427b50557dce70',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fhpp_5fclient_5fimpl_83',['RPC_HPP_CLIENT_IMPL',['../rpc_8hpp.html#af56044a2d07e951cbf315821dd3f1a41',1,'rpc.hpp']]], - ['rpc_5fhpp_5fenable_5fserver_5fcache_84',['RPC_HPP_ENABLE_SERVER_CACHE',['../rpc_8hpp.html#aa68fe684faf759e42e530ec4584f09fa',1,'rpc.hpp']]], - ['rpc_5fhpp_5fmodule_5fimpl_85',['RPC_HPP_MODULE_IMPL',['../rpc_8hpp.html#ae19f6e09c9f97b2789404cc054dd8811',1,'rpc.hpp']]], - ['rpc_5fhpp_5fserver_5fimpl_86',['RPC_HPP_SERVER_IMPL',['../rpc_8hpp.html#a036051135b9379ac43ff4d6023827325',1,'rpc.hpp']]], - ['rpc_5fmulti_5falias_5fcached_5ffunc_87',['RPC_MULTI_ALIAS_CACHED_FUNC',['../rpc__dispatch__helper_8hpp.html#a3538fd2178d5c87d931cec226063e956',1,'rpc_dispatch_helper.hpp']]], - ['rpc_5fmulti_5falias_5ffunc_88',['RPC_MULTI_ALIAS_FUNC',['../rpc__dispatch__helper_8hpp.html#a946963e302f5510f1459de088880a28f',1,'rpc_dispatch_helper.hpp']]] + ['rpc_5fhpp_5fclient_5fimpl_88',['RPC_HPP_CLIENT_IMPL',['../rpc_8hpp.html#af56044a2d07e951cbf315821dd3f1a41',1,'rpc.hpp']]], + ['rpc_5fhpp_5fenable_5fserver_5fcache_89',['RPC_HPP_ENABLE_SERVER_CACHE',['../rpc_8hpp.html#aa68fe684faf759e42e530ec4584f09fa',1,'rpc.hpp']]], + ['rpc_5fhpp_5fmodule_5fimpl_90',['RPC_HPP_MODULE_IMPL',['../rpc_8hpp.html#ae19f6e09c9f97b2789404cc054dd8811',1,'rpc.hpp']]], + ['rpc_5fhpp_5fserver_5fimpl_91',['RPC_HPP_SERVER_IMPL',['../rpc_8hpp.html#a036051135b9379ac43ff4d6023827325',1,'rpc.hpp']]] ]; diff --git a/docs/search/files_0.js b/docs/search/files_0.js index 152b18f8..a7b09b03 100644 --- a/docs/search/files_0.js +++ b/docs/search/files_0.js @@ -1,8 +1,9 @@ var searchData= [ - ['rpc_2ehpp_53',['rpc.hpp',['../rpc_8hpp.html',1,'']]], - ['rpc_5fboost_5fjson_2ehpp_54',['rpc_boost_json.hpp',['../rpc__boost__json_8hpp.html',1,'']]], - ['rpc_5fdispatch_5fhelper_2ehpp_55',['rpc_dispatch_helper.hpp',['../rpc__dispatch__helper_8hpp.html',1,'']]], - ['rpc_5fnjson_2ehpp_56',['rpc_njson.hpp',['../rpc__njson_8hpp.html',1,'']]], - ['rpc_5frapidjson_2ehpp_57',['rpc_rapidjson.hpp',['../rpc__rapidjson_8hpp.html',1,'']]] + ['rpc_2ehpp_73',['rpc.hpp',['../rpc_8hpp.html',1,'']]], + ['rpc_5fbitsery_2ehpp_74',['rpc_bitsery.hpp',['../rpc__bitsery_8hpp.html',1,'']]], + ['rpc_5fboost_5fjson_2ehpp_75',['rpc_boost_json.hpp',['../rpc__boost__json_8hpp.html',1,'']]], + ['rpc_5fdispatch_5fhelper_2ehpp_76',['rpc_dispatch_helper.hpp',['../rpc__dispatch__helper_8hpp.html',1,'']]], + ['rpc_5fnjson_2ehpp_77',['rpc_njson.hpp',['../rpc__njson_8hpp.html',1,'']]], + ['rpc_5frapidjson_2ehpp_78',['rpc_rapidjson.hpp',['../rpc__rapidjson_8hpp.html',1,'']]] ]; diff --git a/docs/search/functions_0.js b/docs/search/functions_0.js index 49afe2f2..c078244b 100644 --- a/docs/search/functions_0.js +++ b/docs/search/functions_0.js @@ -1,5 +1,4 @@ var searchData= [ - ['call_5ffunc_58',['call_func',['../classrpc_1_1client_1_1client__interface.html#a5cc7a0f8b893f4eefd5157b8e76573f4',1,'rpc::client::client_interface']]], - ['clear_5fresult_59',['clear_result',['../classrpc_1_1packed__func.html#a69918d28c9baea0291c735df6f0865f4',1,'rpc::packed_func']]] + ['call_5ffunc_79',['call_func',['../classrpc_1_1client_1_1client__interface.html#a13cb1ee5075bba41f2a26d6cf3b420b3',1,'rpc::client::client_interface::call_func(const std::string &func_name, Args &&... args)'],['../classrpc_1_1client_1_1client__interface.html#a61ef1336c96e7c6a4740391665b1c198',1,'rpc::client::client_interface::call_func(std::string &&func_name, Args &&... args)']]] ]; diff --git a/docs/search/functions_1.js b/docs/search/functions_1.js index dc7bf2fa..44514f6a 100644 --- a/docs/search/functions_1.js +++ b/docs/search/functions_1.js @@ -1,8 +1,7 @@ var searchData= [ - ['deserialize_5fpack_60',['deserialize_pack',['../classrpc_1_1pack__adapter.html#a3b42b493777bc20d6973ad082b9d29f2',1,'rpc::pack_adapter']]], - ['dispatch_61',['dispatch',['../classrpc_1_1server_1_1server__interface.html#a8052947e620688b4b2bde4dabfa0c8f0',1,'rpc::server::server_interface']]], - ['dispatch_5fcached_5ffunc_62',['dispatch_cached_func',['../classrpc_1_1server_1_1server__interface.html#a9043fffe7bdcbb3681f6fd26eb048507',1,'rpc::server::server_interface']]], - ['dispatch_5ffunc_63',['dispatch_func',['../classrpc_1_1server_1_1server__interface.html#a3c4b127d19f2c7b96d9518e57f0a93ce',1,'rpc::server::server_interface']]], - ['dispatch_5fimpl_64',['dispatch_impl',['../classrpc_1_1server_1_1server__interface.html#a301cab7ee170a066603b9e655c5f2d43',1,'rpc::server::server_interface']]] + ['deserialize_5fpack_80',['deserialize_pack',['../classrpc_1_1pack__adapter.html#a734a7928c5648972adf40008a6bc09d0',1,'rpc::pack_adapter']]], + ['dispatch_81',['dispatch',['../classrpc_1_1server_1_1server__interface.html#a8052947e620688b4b2bde4dabfa0c8f0',1,'rpc::server::server_interface']]], + ['dispatch_5fcached_5ffunc_82',['dispatch_cached_func',['../classrpc_1_1server_1_1server__interface.html#ab6055dff21bc516eff7956117488184f',1,'rpc::server::server_interface']]], + ['dispatch_5ffunc_83',['dispatch_func',['../classrpc_1_1server_1_1server__interface.html#a3c4b127d19f2c7b96d9518e57f0a93ce',1,'rpc::server::server_interface']]] ]; diff --git a/docs/search/functions_2.js b/docs/search/functions_2.js index 4b09a3f1..a71c4008 100644 --- a/docs/search/functions_2.js +++ b/docs/search/functions_2.js @@ -1,5 +1,4 @@ var searchData= [ - ['get_5ffunc_5fname_65',['get_func_name',['../classrpc_1_1pack__adapter.html#a97335816daece357925dadcd95ebbfde',1,'rpc::pack_adapter']]], - ['get_5fresult_66',['get_result',['../classrpc_1_1packed__func.html#a806c046cd6e9f2301da0a37c78f8e2d7',1,'rpc::packed_func']]] + ['get_5ffunc_5fname_84',['get_func_name',['../classrpc_1_1pack__adapter.html#a97335816daece357925dadcd95ebbfde',1,'rpc::pack_adapter']]] ]; diff --git a/docs/search/functions_3.js b/docs/search/functions_3.js index bf6aca03..0b849a0c 100644 --- a/docs/search/functions_3.js +++ b/docs/search/functions_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['operator_20bool_67',['operator bool',['../classrpc_1_1packed__func.html#a7b6b3a5073fbecabe4420f78603adf4f',1,'rpc::packed_func']]] + ['receive_85',['receive',['../classrpc_1_1client_1_1client__interface.html#ac183a72ae42949d1995d919e248909bd',1,'rpc::client::client_interface']]] ]; diff --git a/docs/search/functions_4.js b/docs/search/functions_4.js index 8ec30762..ea027b30 100644 --- a/docs/search/functions_4.js +++ b/docs/search/functions_4.js @@ -1,4 +1,5 @@ var searchData= [ - ['packed_5ffunc_68',['packed_func',['../classrpc_1_1packed__func.html#aef4285a1e20b28b275ccf3947ed65d31',1,'rpc::packed_func::packed_func()'],['../classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html#a6d8d040cbd7755f7491887ba0fa9bc6f',1,'rpc::packed_func< void, Args... >::packed_func()']]] + ['send_86',['send',['../classrpc_1_1client_1_1client__interface.html#aa7c513e73a82d7c5ef0bf1401b3acd4a',1,'rpc::client::client_interface::send(const typename Serial::bytes_t &bytes)=0'],['../classrpc_1_1client_1_1client__interface.html#acb339a35647fe87c7efd269bd626a76c',1,'rpc::client::client_interface::send(typename Serial::bytes_t &&bytes)=0']]], + ['serialize_5fpack_87',['serialize_pack',['../classrpc_1_1pack__adapter.html#ac47543bf59d27ca6dc6faf771a31abb0',1,'rpc::pack_adapter']]] ]; diff --git a/docs/search/functions_5.js b/docs/search/functions_5.js deleted file mode 100644 index 19afb899..00000000 --- a/docs/search/functions_5.js +++ /dev/null @@ -1,5 +0,0 @@ -var searchData= -[ - ['receive_69',['receive',['../classrpc_1_1client_1_1client__interface.html#ac183a72ae42949d1995d919e248909bd',1,'rpc::client::client_interface']]], - ['run_5fcallback_70',['run_callback',['../classrpc_1_1server_1_1server__interface.html#ac5d9e8286cff4d1c0183f8bf089ab8aa',1,'rpc::server::server_interface']]] -]; diff --git a/docs/search/functions_6.js b/docs/search/functions_6.js deleted file mode 100644 index f1045180..00000000 --- a/docs/search/functions_6.js +++ /dev/null @@ -1,7 +0,0 @@ -var searchData= -[ - ['send_71',['send',['../classrpc_1_1client_1_1client__interface.html#aa7c513e73a82d7c5ef0bf1401b3acd4a',1,'rpc::client::client_interface']]], - ['serialize_5fpack_72',['serialize_pack',['../classrpc_1_1pack__adapter.html#aa2b0dc1bb016265f0dc367a56ff31208',1,'rpc::pack_adapter']]], - ['set_5ferr_5fmesg_73',['set_err_mesg',['../classrpc_1_1pack__adapter.html#ac5569c012b082665157f2033f4c39a75',1,'rpc::pack_adapter']]], - ['set_5fresult_74',['set_result',['../classrpc_1_1packed__func.html#a7fd739d3cf02f83a81e9dbbac39ce187',1,'rpc::packed_func']]] -]; diff --git a/docs/search/namespaces_0.js b/docs/search/namespaces_0.js index 7948eb7e..a60c75f1 100644 --- a/docs/search/namespaces_0.js +++ b/docs/search/namespaces_0.js @@ -1,7 +1,7 @@ var searchData= [ - ['client_49',['client',['../namespacerpc_1_1client.html',1,'rpc']]], - ['details_50',['details',['../namespacerpc_1_1details.html',1,'rpc']]], - ['rpc_51',['rpc',['../namespacerpc.html',1,'']]], - ['server_52',['server',['../namespacerpc_1_1server.html',1,'rpc']]] + ['client_69',['client',['../namespacerpc_1_1client.html',1,'rpc']]], + ['details_70',['details',['../namespacerpc_1_1details.html',1,'rpc']]], + ['rpc_71',['rpc',['../namespacerpc.html',1,'']]], + ['server_72',['server',['../namespacerpc_1_1server.html',1,'rpc']]] ]; diff --git a/docs/search/pages_0.html b/docs/search/pages_0.html new file mode 100644 index 00000000..8517b48f --- /dev/null +++ b/docs/search/pages_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/pages_0.js b/docs/search/pages_0.js new file mode 100644 index 00000000..83fb34c5 --- /dev/null +++ b/docs/search/pages_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['contributor_20covenant_20code_20of_20conduct_92',['Contributor Covenant Code of Conduct',['../md__c_o_d_e__o_f__c_o_n_d_u_c_t.html',1,'']]] +]; diff --git a/docs/search/pages_1.html b/docs/search/pages_1.html new file mode 100644 index 00000000..a0fb6796 --- /dev/null +++ b/docs/search/pages_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/pages_1.js b/docs/search/pages_1.js new file mode 100644 index 00000000..0ad2d58e --- /dev/null +++ b/docs/search/pages_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['how_20to_20contribute_93',['How to Contribute',['../md__c_o_n_t_r_i_b_u_t_i_n_g.html',1,'']]] +]; diff --git a/docs/search/pages_2.html b/docs/search/pages_2.html new file mode 100644 index 00000000..084edfd0 --- /dev/null +++ b/docs/search/pages_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/pages_2.js b/docs/search/pages_2.js new file mode 100644 index 00000000..fe70b3e6 --- /dev/null +++ b/docs/search/pages_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['installation_20guide_94',['Installation Guide',['../md__i_n_s_t_a_l_l.html',1,'']]] +]; diff --git a/docs/search/pages_3.html b/docs/search/pages_3.html new file mode 100644 index 00000000..c0b45b0f --- /dev/null +++ b/docs/search/pages_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/pages_3.js b/docs/search/pages_3.js new file mode 100644 index 00000000..830fd14c --- /dev/null +++ b/docs/search/pages_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['rpc_2ehpp_20security_20policy_95',['rpc.hpp Security Policy',['../md__s_e_c_u_r_i_t_y.html',1,'']]] +]; diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js index 7d290f1b..824944cd 100644 --- a/docs/search/searchdata.js +++ b/docs/search/searchdata.js @@ -1,12 +1,12 @@ var indexSectionsWithContent = { - 0: "cdgoprs", - 1: "cps", + 0: "cdfghilprs", + 1: "cdfhlprs", 2: "r", 3: "r", - 4: "cdgoprs", + 4: "cdgrs", 5: "r", - 6: "r" + 6: "chir" }; var indexSectionNames = @@ -16,8 +16,8 @@ var indexSectionNames = 2: "namespaces", 3: "files", 4: "functions", - 5: "typedefs", - 6: "defines" + 5: "defines", + 6: "pages" }; var indexSectionLabels = @@ -27,7 +27,7 @@ var indexSectionLabels = 2: "Namespaces", 3: "Files", 4: "Functions", - 5: "Typedefs", - 6: "Macros" + 5: "Macros", + 6: "Pages" }; diff --git a/docs/search/typedefs_0.js b/docs/search/typedefs_0.js deleted file mode 100644 index 4d6611e1..00000000 --- a/docs/search/typedefs_0.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['result_5ft_75',['result_t',['../classrpc_1_1packed__func.html#ae2485fe8827883a17c8c8e6d8876c510',1,'rpc::packed_func::result_t()'],['../classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4.html#a8b8df53d5d47247870a289ff077d3b09',1,'rpc::packed_func< void, Args... >::result_t()']]] -]; diff --git a/docs/functions_type.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest.html similarity index 75% rename from docs/functions_type.html rename to docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest.html index dde38e1e..f7ea1051 100644 --- a/docs/functions_type.html +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest.html @@ -5,7 +5,7 @@ -rpc.hpp: Class Members - Typedefs +rpc.hpp: rpc::adapters::bitsery::details::largest< T, int > Struct Template Reference @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -47,7 +47,6 @@ }); /* @license-end */ -
    + + +
    +
    +
    rpc::adapters::bitsery::details::largest< T, int > Struct Template Reference
    +
    - 
    diff --git a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4-members.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_010_01_4-members.html similarity index 71% rename from docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4-members.html rename to docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_010_01_4-members.html index 18c0d1dc..d7779a61 100644 --- a/docs/classrpc_1_1packed__func_3_01void_00_01_args_8_8_8_01_4-members.html +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_010_01_4-members.html @@ -22,7 +22,7 @@
    rpc.hpp -  0.6.1 +  0.7.1
    Simple RPC Header-Only Library
    @@ -63,19 +63,18 @@
-
rpc::packed_func< void, Args... > Member List
+
rpc::adapters::bitsery::details::largest< T, 0 > Member List
-

This is the complete list of members for rpc::packed_func< void, Args... >, including all inherited members.

+

This is the complete list of members for rpc::adapters::bitsery::details::largest< T, 0 >, including all inherited members.

- - +
packed_func(std::string func_name, args_t args)rpc::packed_func< void, Args... >inline
result_t typedefrpc::packed_func< void, Args... >
type typedef (defined in rpc::adapters::bitsery::details::largest< T, 0 >)rpc::adapters::bitsery::details::largest< T, 0 >
diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_010_01_4.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_010_01_4.html new file mode 100644 index 00000000..cb6df5d3 --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_010_01_4.html @@ -0,0 +1,93 @@ + + + + + + + +rpc.hpp: rpc::adapters::bitsery::details::largest< T, 0 > Struct Template Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +List of all members
+
+
rpc::adapters::bitsery::details::largest< T, 0 > Struct Template Reference
+
+
+ + + + +

+Public Types

+using type = T
 
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_013_01_4-members.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_013_01_4-members.html new file mode 100644 index 00000000..3229bd9a --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_013_01_4-members.html @@ -0,0 +1,84 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
rpc::adapters::bitsery::details::largest< T, 3 > Member List
+
+
+ +

This is the complete list of members for rpc::adapters::bitsery::details::largest< T, 3 >, including all inherited members.

+ + +
type typedef (defined in rpc::adapters::bitsery::details::largest< T, 3 >)rpc::adapters::bitsery::details::largest< T, 3 >
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_013_01_4.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_013_01_4.html new file mode 100644 index 00000000..0faf94e0 --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_013_01_4.html @@ -0,0 +1,93 @@ + + + + + + + +rpc.hpp: rpc::adapters::bitsery::details::largest< T, 3 > Struct Template Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +List of all members
+
+
rpc::adapters::bitsery::details::largest< T, 3 > Struct Template Reference
+
+
+ + + + +

+Public Types

+using type = uint64_t
 
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_014_01_4-members.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_014_01_4-members.html new file mode 100644 index 00000000..6734505a --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_014_01_4-members.html @@ -0,0 +1,84 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
rpc::adapters::bitsery::details::largest< T, 4 > Member List
+
+
+ +

This is the complete list of members for rpc::adapters::bitsery::details::largest< T, 4 >, including all inherited members.

+ + +
type typedef (defined in rpc::adapters::bitsery::details::largest< T, 4 >)rpc::adapters::bitsery::details::largest< T, 4 >
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_014_01_4.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_014_01_4.html new file mode 100644 index 00000000..644a9cc1 --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_014_01_4.html @@ -0,0 +1,93 @@ + + + + + + + +rpc.hpp: rpc::adapters::bitsery::details::largest< T, 4 > Struct Template Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +List of all members
+
+
rpc::adapters::bitsery::details::largest< T, 4 > Struct Template Reference
+
+
+ + + + +

+Public Types

+using type = double
 
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_016_01_4-members.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_016_01_4-members.html new file mode 100644 index 00000000..d33cb3cc --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_016_01_4-members.html @@ -0,0 +1,84 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
rpc::adapters::bitsery::details::largest< T, 6 > Member List
+
+
+ +

This is the complete list of members for rpc::adapters::bitsery::details::largest< T, 6 >, including all inherited members.

+ + +
type typedef (defined in rpc::adapters::bitsery::details::largest< T, 6 >)rpc::adapters::bitsery::details::largest< T, 6 >
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_016_01_4.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_016_01_4.html new file mode 100644 index 00000000..c18493c5 --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1largest_3_01_t_00_016_01_4.html @@ -0,0 +1,93 @@ + + + + + + + +rpc.hpp: rpc::adapters::bitsery::details::largest< T, 6 > Struct Template Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +List of all members
+
+
rpc::adapters::bitsery::details::largest< T, 6 > Struct Template Reference
+
+
+ + + + +

+Public Types

+using type = int64_t
 
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper-members.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper-members.html new file mode 100644 index 00000000..f20123ba --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper-members.html @@ -0,0 +1,90 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
rpc::adapters::bitsery::details::pack_helper< R, Args > Member List
+
+
+ +

This is the complete list of members for rpc::adapters::bitsery::details::pack_helper< R, Args >, including all inherited members.

+ + + + + + + + +
args (defined in rpc::adapters::bitsery::details::pack_helper< R, Args >)rpc::adapters::bitsery::details::pack_helper< R, Args >
args_t typedef (defined in rpc::adapters::bitsery::details::pack_helper< R, Args >)rpc::adapters::bitsery::details::pack_helper< R, Args >
err_mesg (defined in rpc::adapters::bitsery::details::pack_helper< R, Args >)rpc::adapters::bitsery::details::pack_helper< R, Args >
except_type (defined in rpc::adapters::bitsery::details::pack_helper< R, Args >)rpc::adapters::bitsery::details::pack_helper< R, Args >
func_name (defined in rpc::adapters::bitsery::details::pack_helper< R, Args >)rpc::adapters::bitsery::details::pack_helper< R, Args >
pack_helper()=default (defined in rpc::adapters::bitsery::details::pack_helper< R, Args >)rpc::adapters::bitsery::details::pack_helper< R, Args >
result (defined in rpc::adapters::bitsery::details::pack_helper< R, Args >)rpc::adapters::bitsery::details::pack_helper< R, Args >
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper.html new file mode 100644 index 00000000..865db67a --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper.html @@ -0,0 +1,112 @@ + + + + + + + +rpc.hpp: rpc::adapters::bitsery::details::pack_helper< R, Args > Struct Template Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +Public Attributes | +List of all members
+
+
rpc::adapters::bitsery::details::pack_helper< R, Args > Struct Template Reference
+
+
+ + + + +

+Public Types

+using args_t = std::tuple< largest_t< std::remove_cv_t< std::remove_reference_t< Args > >>... >
 
+ + + + + + + + + + + +

+Public Attributes

+int except_type {}
 
+std::string func_name {}
 
+std::string err_mesg {}
 
+R result {}
 
+args_t args {}
 
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper_3_01void_00_01_args_8_8_8_01_4-members.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper_3_01void_00_01_args_8_8_8_01_4-members.html new file mode 100644 index 00000000..77f5ed7a --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper_3_01void_00_01_args_8_8_8_01_4-members.html @@ -0,0 +1,89 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
rpc::adapters::bitsery::details::pack_helper< void, Args... > Member List
+
+
+ +

This is the complete list of members for rpc::adapters::bitsery::details::pack_helper< void, Args... >, including all inherited members.

+ + + + + + + +
args (defined in rpc::adapters::bitsery::details::pack_helper< void, Args... >)rpc::adapters::bitsery::details::pack_helper< void, Args... >
args_t typedef (defined in rpc::adapters::bitsery::details::pack_helper< void, Args... >)rpc::adapters::bitsery::details::pack_helper< void, Args... >
err_mesg (defined in rpc::adapters::bitsery::details::pack_helper< void, Args... >)rpc::adapters::bitsery::details::pack_helper< void, Args... >
except_type (defined in rpc::adapters::bitsery::details::pack_helper< void, Args... >)rpc::adapters::bitsery::details::pack_helper< void, Args... >
func_name (defined in rpc::adapters::bitsery::details::pack_helper< void, Args... >)rpc::adapters::bitsery::details::pack_helper< void, Args... >
pack_helper()=default (defined in rpc::adapters::bitsery::details::pack_helper< void, Args... >)rpc::adapters::bitsery::details::pack_helper< void, Args... >
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper_3_01void_00_01_args_8_8_8_01_4.html b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper_3_01void_00_01_args_8_8_8_01_4.html new file mode 100644 index 00000000..f508554d --- /dev/null +++ b/docs/structrpc_1_1adapters_1_1bitsery_1_1details_1_1pack__helper_3_01void_00_01_args_8_8_8_01_4.html @@ -0,0 +1,109 @@ + + + + + + + +rpc.hpp: rpc::adapters::bitsery::details::pack_helper< void, Args... > Struct Template Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +Public Attributes | +List of all members
+
+
rpc::adapters::bitsery::details::pack_helper< void, Args... > Struct Template Reference
+
+
+ + + + +

+Public Types

+using args_t = std::tuple< largest_t< std::remove_cv_t< std::remove_reference_t< Args > >>... >
 
+ + + + + + + + + +

+Public Attributes

+int except_type {}
 
+std::string func_name {}
 
+std::string err_mesg {}
 
+args_t args {}
 
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structstd_1_1hash_3_01std_1_1vector_3_01uint8__t_01_4_01_4-members.html b/docs/structstd_1_1hash_3_01std_1_1vector_3_01uint8__t_01_4_01_4-members.html new file mode 100644 index 00000000..6bf63f3f --- /dev/null +++ b/docs/structstd_1_1hash_3_01std_1_1vector_3_01uint8__t_01_4_01_4-members.html @@ -0,0 +1,84 @@ + + + + + + + +rpc.hpp: Member List + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
std::hash< std::vector< uint8_t > > Member List
+
+
+ +

This is the complete list of members for std::hash< std::vector< uint8_t > >, including all inherited members.

+ + +
operator()(const std::vector< uint8_t > &vec) const noexcept (defined in std::hash< std::vector< uint8_t > >)std::hash< std::vector< uint8_t > >inline
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/structstd_1_1hash_3_01std_1_1vector_3_01uint8__t_01_4_01_4.html b/docs/structstd_1_1hash_3_01std_1_1vector_3_01uint8__t_01_4_01_4.html new file mode 100644 index 00000000..b4cc3ffc --- /dev/null +++ b/docs/structstd_1_1hash_3_01std_1_1vector_3_01uint8__t_01_4_01_4.html @@ -0,0 +1,93 @@ + + + + + + + +rpc.hpp: std::hash< std::vector< uint8_t > > Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
rpc.hpp +  0.7.1 +
+
Simple RPC Header-Only Library
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
std::hash< std::vector< uint8_t > > Struct Reference
+
+
+ + + + +

+Public Member Functions

+size_t operator() (const std::vector< uint8_t > &vec) const noexcept
 
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/examples/meson.build b/examples/meson.build deleted file mode 100644 index 262d4c85..00000000 --- a/examples/meson.build +++ /dev/null @@ -1,64 +0,0 @@ -# BSD 3-Clause License -# -# Copyright (c) 2020-2021, Jackson Harmer -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, this -# list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -asio_dep = dependency('asio') -thread_dep = dependency('threads') - -ex_dependencies = [rpc_hpp_dep] -ex_defines = [] - -if get_option('build_adapter_boost_json') - ex_dependencies += [boost_json_adapter_dep] - ex_defines += ['-DRPC_HPP_ENABLE_BOOST_JSON'] -endif - -if get_option('build_adapter_njson') - ex_dependencies += [njson_adapter_dep] - ex_defines += ['-DRPC_HPP_ENABLE_NJSON'] -endif - -if get_option('build_adapter_rapidjson') - ex_dependencies += [rapidjson_adapter_dep] - ex_defines += ['-DRPC_HPP_ENABLE_RAPIDJSON'] -endif - -if host_machine.system() == 'linux' - dl_dep = meson.get_compiler('cpp').find_library('dl', required: false) -else - dl_dep = dependency('', required: false) -endif - -thread_dep = dependency('threads') - -rpc_server_exe = executable('rpc_server', 'server/server.cpp', dependencies : [ex_dependencies, asio_dep, thread_dep], install : false, cpp_args : [project_warnings, ex_defines]) -rpc_client_exe = executable('rpc_client', 'client/client.cpp', dependencies : [ex_dependencies, asio_dep, thread_dep], install : false, cpp_args : [project_warnings, ex_defines]) - -rpc_module_dll = shared_module('rpc_module', 'module/module.cpp', dependencies : ex_dependencies, install : false, cpp_args : [project_warnings, ex_defines, '-DRPC_HPP_EXPORT']) -rpc_module_exe = executable('rpc_module_client', 'module/module_client.cpp', dependencies : [ex_dependencies, dl_dep], install : false, cpp_args : [project_warnings, ex_defines]) diff --git a/examples/module/client.cpp b/examples/module/client.cpp index 9d69f593..f60f1ad7 100644 --- a/examples/module/client.cpp +++ b/examples/module/client.cpp @@ -11,11 +11,9 @@ using rpc::adapters::njson_adapter; -RpcClient::RpcClient(std::string module_path) +RpcClient::RpcClient(const std::string& module_path) : m_module{ LoadLibrary(module_path.c_str()) } { // Load the module into the application's memory - m_module = LoadLibrary(std::move(module_path).c_str()); - if (m_module == nullptr) { throw std::runtime_error("Could not load module!"); @@ -59,6 +57,35 @@ void RpcClient::send(const std::string& mesg) m_result = std::string{ buf }; } +void RpcClient::send(std::string&& mesg) +{ + // Interoperable with C-compatible code, so need to create a character buffer (keeping it small for this example) + constexpr auto BUF_SZ = 128; + + if (mesg.size() >= BUF_SZ) + { + throw std::runtime_error("String buffer was not big enough for request!"); + } + + char buf[BUF_SZ]; + +#if defined(_WIN32) + strcpy_s(buf, std::move(mesg).c_str()); + +#elif defined(__unix__) + strcpy(buf, std::move(mesg).c_str()); +#endif + + const auto result = m_func(buf, BUF_SZ); + + if (result == 1) + { + throw std::runtime_error("String buffer was not big enough for response!"); + } + + m_result = std::string{ buf }; +} + int main(int argc, char* argv[]) { if (argc < 2) diff --git a/examples/module/client.hpp b/examples/module/client.hpp index ff6e4e15..19956542 100644 --- a/examples/module/client.hpp +++ b/examples/module/client.hpp @@ -37,7 +37,7 @@ class RpcClient : public rpc::client::client_interface } } - RpcClient(std::string module_path); + RpcClient(const std::string& module_path); // Cannot copy a client, module could be unloaded by a copy RpcClient(const RpcClient&) = delete; @@ -65,8 +65,9 @@ class RpcClient : public rpc::client::client_interface private: void send(const std::string& mesg) override; + void send(std::string&& mesg) override; - std::string receive() override + [[nodiscard]] std::string receive() override { // By moving, we indicate that the result is no longer valid after the function returns return std::move(m_result); diff --git a/examples/module/module.cpp b/examples/module/module.cpp index 89c13fe1..e8c6a47f 100644 --- a/examples/module/module.cpp +++ b/examples/module/module.cpp @@ -6,16 +6,15 @@ #include -constexpr auto MODULE_NAME{ "rpc_module" }; +static constexpr auto MODULE_NAME{ "rpc_module" }; +static RpcModule rpc_mod{}; -static RpcModule rpc_mod; - -inline int Sum(int n1, int n2) +int Sum(int n1, int n2) { return n1 + n2; } -inline void AddOneToEach(std::vector& vec) +void AddOneToEach(std::vector& vec) { for (auto& n : vec) { @@ -23,7 +22,7 @@ inline void AddOneToEach(std::vector& vec) } } -inline void GetName(std::string& name_out) +void GetName(std::string& name_out) { name_out.assign(MODULE_NAME); } diff --git a/examples/tcp_server/client.cpp b/examples/tcp_server/client.cpp index fb2fe2d8..15db0f4c 100644 --- a/examples/tcp_server/client.cpp +++ b/examples/tcp_server/client.cpp @@ -2,8 +2,8 @@ #include "client.hpp" +#include #include -#include #include int main(int argc, char* argv[]) diff --git a/examples/tcp_server/client.hpp b/examples/tcp_server/client.hpp index 7a1caa35..e6720fed 100644 --- a/examples/tcp_server/client.hpp +++ b/examples/tcp_server/client.hpp @@ -26,6 +26,12 @@ class RpcClient : public rpc::client::client_interface asio::write(m_socket, asio::buffer(mesg, mesg.size())); } + void send(std::string&& mesg) override + { + const auto sz = mesg.size(); + asio::write(m_socket, asio::buffer(std::move(mesg), sz)); + } + std::string receive() override { const auto numBytes = m_socket.read_some(asio::buffer(m_buffer, BUF_SZ)); diff --git a/examples/tcp_server/server.hpp b/examples/tcp_server/server.hpp index 8d8e9b56..1da2b1f2 100644 --- a/examples/tcp_server/server.hpp +++ b/examples/tcp_server/server.hpp @@ -16,12 +16,12 @@ class RpcServer : public rpc::server_interface RpcServer(asio::io_context& io, uint16_t port) : m_io(io), m_port(port) {} void Run(); - void Stop() { m_running = false; } + void Stop() noexcept { m_running = false; } private: void dispatch_impl(rpc::adapters::njson::njson_t& serial_obj) override; asio::io_context& m_io; - std::atomic m_running{ false }; + mutable std::atomic m_running{ false }; uint16_t m_port; }; diff --git a/include/rpc.hpp b/include/rpc.hpp index 4130c1db..d070b09b 100644 --- a/include/rpc.hpp +++ b/include/rpc.hpp @@ -1,7 +1,7 @@ ///@file rpc.hpp ///@author Jackson Harmer (jharmer95@gmail.com) ///@brief Header-only library for serialized RPC usage -///@version 0.6.1 +///@version 0.7.1 /// ///@copyright ///BSD 3-Clause License @@ -52,6 +52,7 @@ # error At least one implementation type must be defined using 'RPC_HPP_{CLIENT, SERVER, MODULE}_IMPL' #endif +#include // for assert #include // for size_t #include // for nullopt, optional #include // for runtime_error @@ -64,9 +65,177 @@ # include // for unordered_map #endif +#define RPC_HPP_PRECONDITION(EXPR) assert(EXPR) +#define RPC_HPP_POSTCONDITION(EXPR) assert(EXPR) + ///@brief Top-level namespace for rpc.hpp classes and functions namespace rpc { +///@brief Array containing the version information for rpc.hpp +static constexpr unsigned version[]{ 0, 7, 1 }; + +namespace exceptions +{ + enum class Type + { + None, + FuncNotFound, + RemoteExec, + Serialization, + DeSerialization, + SignatureMismatch, + ClientSend, + ClientReceive, + ServerSend, + ServerReceive, + }; + + class rpc_exception : public std::runtime_error + { + public: + explicit rpc_exception(const std::string& mesg, Type type) noexcept + : std::runtime_error(mesg), m_type(type) + { + } + + explicit rpc_exception(const char* mesg, Type type) noexcept + : std::runtime_error(mesg), m_type(type) + { + } + + Type get_type() const noexcept { return m_type; } + + private: + Type m_type; + }; + + class function_not_found : public rpc_exception + { + public: + explicit function_not_found(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::FuncNotFound) + { + } + + explicit function_not_found(const char* mesg) noexcept + : rpc_exception(mesg, Type::FuncNotFound) + { + } + }; + + class remote_exec_error : public rpc_exception + { + public: + explicit remote_exec_error(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::RemoteExec) + { + } + + explicit remote_exec_error(const char* mesg) noexcept + : rpc_exception(mesg, Type::RemoteExec) + { + } + }; + + class serialization_error : public rpc_exception + { + public: + explicit serialization_error(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::Serialization) + { + } + + explicit serialization_error(const char* mesg) noexcept + : rpc_exception(mesg, Type::Serialization) + { + } + }; + + class deserialization_error : public rpc_exception + { + public: + explicit deserialization_error(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::DeSerialization) + { + } + + explicit deserialization_error(const char* mesg) noexcept + : rpc_exception(mesg, Type::DeSerialization) + { + } + }; + + class function_mismatch : public rpc_exception + { + public: + explicit function_mismatch(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::SignatureMismatch) + { + } + + explicit function_mismatch(const char* mesg) noexcept + : rpc_exception(mesg, Type::SignatureMismatch) + { + } + }; + + class client_send_error : public rpc_exception + { + public: + explicit client_send_error(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::ClientSend) + { + } + + explicit client_send_error(const char* mesg) noexcept + : rpc_exception(mesg, Type::ClientSend) + { + } + }; + + class client_receive_error : public rpc_exception + { + public: + explicit client_receive_error(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::ClientReceive) + { + } + + explicit client_receive_error(const char* mesg) noexcept + : rpc_exception(mesg, Type::ClientReceive) + { + } + }; + + class server_send_error : public rpc_exception + { + public: + explicit server_send_error(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::ServerSend) + { + } + + explicit server_send_error(const char* mesg) noexcept + : rpc_exception(mesg, Type::ServerSend) + { + } + }; + + class server_receive_error : public rpc_exception + { + public: + explicit server_receive_error(const std::string& mesg) noexcept + : rpc_exception(mesg, Type::ServerReceive) + { + } + + explicit server_receive_error(const char* mesg) noexcept + : rpc_exception(mesg, Type::ServerReceive) + { + } + }; +} // namespace exceptions + ///@brief Namespace for implementation details, should not be used outside of the library namespace details { @@ -197,7 +366,7 @@ namespace details [[maybe_unused]] std::index_sequence iseq) { using expander = int[]; - (void)expander{ 0, ((void)func(std::get(tuple)), 0)... }; + std::ignore = expander{ 0, ((void)func(std::get(tuple)), 0)... }; } template @@ -213,7 +382,7 @@ namespace details std::index_sequence, Args&&... dest) { using expander = int[]; - (void)expander{ 0, + std::ignore = expander{ 0, ( (void)[](auto&& x, auto&& y) { @@ -241,40 +410,74 @@ namespace details public: using args_t = std::tuple>...>; - packed_func_base(std::string func_name, args_t args) + packed_func_base(std::string func_name, args_t args) noexcept : m_func_name(std::move(func_name)), m_args(std::move(args)) { + RPC_HPP_POSTCONDITION(!m_func_name.empty()); } - const std::string& get_err_mesg() const& { return m_err_mesg; } - [[nodiscard]] std::string get_err_mesg() && { return std::move(m_err_mesg); } + explicit operator bool() const noexcept { return m_except_type == exceptions::Type::None; } + const std::string& get_err_mesg() const noexcept { return m_err_mesg; } + const std::string& get_func_name() const noexcept { return m_func_name; } + exceptions::Type get_except_type() const noexcept { return m_except_type; } - const std::string& get_func_name() const& { return m_func_name; } - [[nodiscard]] std::string get_func_name() && { return std::move(m_func_name); } + void set_exception(std::string&& mesg, exceptions::Type type) & noexcept + { + m_except_type = type; + m_err_mesg = std::move(mesg); + } - void set_err_mesg(const std::string& mesg) & { m_err_mesg = mesg; } + const args_t& get_args() const noexcept { return m_args; } + args_t& get_args() noexcept { return m_args; } - virtual explicit operator bool() const { return m_err_mesg.empty(); } + protected: + ~packed_func_base() noexcept = default; + packed_func_base(const packed_func_base&) = default; + packed_func_base(packed_func_base&&) noexcept = default; + packed_func_base& operator=(const packed_func_base&) & = default; + packed_func_base& operator=(packed_func_base&&) & noexcept = default; - const args_t& get_args() const& { return m_args; } - [[nodiscard]] args_t get_args() && { return std::move(m_args); } + [[noreturn]] void throw_ex() const noexcept(false) + { + switch (m_except_type) + { + using namespace exceptions; - void set_args(const args_t& args) & { m_args = args; } - void set_args(args_t&& args) & { m_args = std::move(args); } + case Type::FuncNotFound: + throw function_not_found(m_err_mesg); - template - const auto& get_arg() const& - { - return std::get(m_args); - } + case Type::RemoteExec: + throw remote_exec_error(m_err_mesg); - template - [[nodiscard]] auto get_arg() && - { - return std::get(std::move(m_args)); + case Type::Serialization: + throw serialization_error(m_err_mesg); + + case Type::DeSerialization: + throw deserialization_error(m_err_mesg); + + case Type::SignatureMismatch: + throw function_mismatch(m_err_mesg); + + case Type::ClientSend: + throw client_send_error(m_err_mesg); + + case Type::ClientReceive: + throw client_receive_error(m_err_mesg); + + case Type::ServerSend: + throw server_send_error(m_err_mesg); + + case Type::ServerReceive: + throw server_receive_error(m_err_mesg); + + case Type::None: + default: + throw rpc_exception(m_err_mesg, Type::None); + } } private: + exceptions::Type m_except_type{ exceptions::Type::None }; std::string m_func_name; std::string m_err_mesg{}; args_t m_args; @@ -286,114 +489,83 @@ namespace details using serial_t = T_Serial; using bytes_t = T_Bytes; + // nodiscard because a potentially expensive parse and copy is being done template - static serial_t serialize(const T& val); + [[nodiscard]] static serial_t serialize(const T& val); + // nodiscard because a potentially expensive parse and copy is being done template - static T deserialize(const serial_t& serial_obj); + [[nodiscard]] static T deserialize(const serial_t& serial_obj); - static serial_t from_bytes(const bytes_t& bytes); + // nodiscard because input bytes are lost after conversion [[nodiscard]] static serial_t from_bytes(bytes_t&& bytes); - static bytes_t to_bytes(const serial_t& serial_obj); + // nodiscard because input object is lost after conversion [[nodiscard]] static bytes_t to_bytes(serial_t&& serial_obj); }; -#endif -} // namespace details -///@brief Object representing a function call, including the function's name, arguments and result -/// -///@tparam R Return type of the function -///@tparam Args Variadic type(s) of the function's arguments -template -class packed_func final : public details::packed_func_base -{ -public: - ///@brief Type alias for the return type - using result_t = R; - - ///@brief Type alias for the argument type(s) in a tuple - using typename details::packed_func_base::args_t; - - ///@brief Constructs a packed_func - /// - ///@param func_name Function name - ///@param result Return value of the function (std::nullopt if not called yet or an error occurred) - ///@param args Tuple containing the argument(s) - packed_func(std::string func_name, std::optional result, args_t args) - : details::packed_func_base(std::move(func_name), std::move(args)), - m_result(std::move(result)) - { - } - - ///@brief Indicates if the packed_func holds a return value and no error occurred - /// - ///@note If an error occurred, the reason may be retrieved from the get_err_mesg() function - ///@return true A return value exists and no error occurred - ///@return false A return value does not exist AND/OR an error occurred - explicit operator bool() const override + template + class packed_func final : public packed_func_base { - return m_result.has_value() && details::packed_func_base::operator bool(); - } + public: + using result_t = R; + using typename packed_func_base::args_t; - ///@brief Returns the result, throwing with the error message if it does not exist - /// - ///@return R The result of the function call - const R& get_result() const& - { - if (m_result.has_value()) + packed_func(std::string func_name, std::optional result, args_t args) noexcept + : packed_func_base(std::move(func_name), std::move(args)), + m_result(std::move(result)) { - return m_result.value(); } - throw std::runtime_error(this->get_err_mesg()); - } - - [[nodiscard]] R get_result() && - { - if (m_result.has_value()) + explicit operator bool() const noexcept { - return std::move(m_result).value(); + return m_result.has_value() && packed_func_base::operator bool(); } - throw std::runtime_error(this->get_err_mesg()); - } + const R& get_result() const + { + if (!static_cast(*this)) + { + // throws exception based on except_type + this->throw_ex(); + } - ///@brief Sets the result to a value - /// - ///@param value The value to store as the result - void set_result(const R& value) & { m_result = value; } - void set_result(R&& value) & { m_result = std::move(value); } + return m_result.value(); + } - ///@brief Clears the result stored (sets it back to std::nullopt) - void clear_result() & { m_result = std::nullopt; } + void set_result(const R& value) & { m_result = value; } -private: - std::optional m_result{ std::nullopt }; -}; + void set_result(R&& value) & noexcept(std::is_nothrow_move_assignable_v) + { + m_result = std::move(value); + } -///@brief Object representing a void returning function call, including the function's name and arguments -/// -///@tparam Args Variadic type(s) of the function's arguments -template -class packed_func final : public details::packed_func_base -{ -public: - ///@brief Type alias for the return type (void) - using result_t = void; + void clear_result() & noexcept { m_result.reset(); } - ///@brief Type alias for the argument type(s) in a tuple - using typename details::packed_func_base::args_t; + private: + std::optional m_result{}; + }; - ///@brief Constructs a packed_func - /// - ///@param func_name Function name - ///@param args Tuple containing the argument(s) - packed_func(std::string func_name, args_t args) - : details::packed_func_base(std::move(func_name), std::move(args)) + template + class packed_func final : public packed_func_base { - } -}; + public: + using result_t = void; + using typename packed_func_base::args_t; + using packed_func_base::packed_func_base; + using packed_func_base::operator bool; + + void get_result() const + { + if (!static_cast(*this)) + { + // throws exception based on except_type + this->throw_ex(); + } + } + }; +#endif +} // namespace details ///@brief Class collecting several functions for interoperating between serial objects and a packed_func /// @@ -408,8 +580,11 @@ class pack_adapter ///@tparam Args Variadic argument type(s) of the packed_func ///@param pack packed_func to be serialized ///@return Serial::serial_t Serial representation of the packed_func + + // nodiscard because a potentially expensive parse and copy is being done template - static typename Serial::serial_t serialize_pack(const packed_func& pack); + [[nodiscard]] static typename Serial::serial_t serialize_pack( + const details::packed_func& pack); ///@brief De-serializes a serial object to a packed_func /// @@ -417,20 +592,22 @@ class pack_adapter ///@tparam Args Variadic argument type(s) of the packed_func ///@param serial_obj Serial object to be serialized ///@return packed_func resulting packed_func + + // nodiscard because a potentially expensive parse and copy is being done template - static packed_func deserialize_pack(const typename Serial::serial_t& serial_obj); + [[nodiscard]] static details::packed_func deserialize_pack( + const typename Serial::serial_t& serial_obj); ///@brief Extracts the function name of a serialized function call /// ///@param serial_obj Serial object to be parsed ///@return std::string Name of the contained function - static std::string get_func_name(const typename Serial::serial_t& serial_obj); - ///@brief Sets the error message for the serialized function call - /// - ///@param serial_obj Serial object to be modified - ///@param mesg String to set as the error message - static void set_err_mesg(typename Serial::serial_t& serial_obj, const std::string& mesg); + // nodiscard because a potentially expensive parse and string allocation is being done + [[nodiscard]] static std::string get_func_name(const typename Serial::serial_t& serial_obj); + + static void set_exception( + typename Serial::serial_t& serial_obj, const exceptions::rpc_exception& ex); }; #if defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL) @@ -448,50 +625,51 @@ inline namespace server public: using adapter_t = Serial; - virtual ~server_interface() = default; - - ///@brief Runs the callback function and updates the result (and any changes to mutable arguments) in the packed_func - /// - ///@tparam R Return type of the callback function - ///@tparam Args Variadic argument type(s) for the function - ///@param func pointer to the callback function - ///@param pack packed_func representing the callback - template - static void run_callback(R (*func)(Args...), packed_func& pack) - { - auto args = pack.get_args(); + virtual ~server_interface() noexcept = default; + server_interface() noexcept = default; - if constexpr (std::is_void_v) - { - std::apply(func, args); - pack.set_args(std::move(args)); - } - else - { - auto result = std::apply(func, args); - pack.set_result(std::move(result)); - pack.set_args(std::move(args)); - } - } + server_interface(const server_interface&) = delete; + server_interface& operator=(const server_interface&) = delete; + server_interface& operator=(server_interface&&) = delete; # if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE) template std::unordered_map& get_func_cache( const std::string& func_name) { + RPC_HPP_PRECONDITION(!func_name.empty()); + update_all_cache(func_name); return *static_cast*>( m_cache_map.at(func_name)); } - template - void update_all_cache(const std::string& func_name) + void clear_all_cache() noexcept { m_cache_map.clear(); } +# endif + + ///@brief Parses the received serialized data and determines which function to call + /// + ///@param bytes Data to be parsed into/back out of a serial object + void dispatch(typename Serial::bytes_t& bytes) { - m_cache_map[func_name] = get_func_cache_impl(func_name); + auto serial_obj = Serial::from_bytes(std::move(bytes)); + + try + { + dispatch_impl(serial_obj); + } + catch (const exceptions::rpc_exception& ex) + { + pack_adapter::set_exception(serial_obj, ex); + } + + bytes = Serial::to_bytes(std::move(serial_obj)); } - void clear_all_cache() { m_cache_map.clear(); } + protected: + server_interface(server_interface&&) noexcept = default; +# if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE) ///@brief Deserializes the serial object to a packed_func, calls the callback function, then serializes the result back to the serial object, using a server-side cache for performance. /// ///@note This feature is enabled by defining @ref RPC_HPP_ENABLE_SERVER_CACHE @@ -502,7 +680,24 @@ inline namespace server template void dispatch_cached_func(R (*func)(Args...), typename Serial::serial_t& serial_obj) { - auto pack = pack_adapter::template deserialize_pack(serial_obj); + RPC_HPP_PRECONDITION(func != nullptr); + + auto pack = [&serial_obj] + { + try + { + return pack_adapter::template deserialize_pack(serial_obj); + } + catch (const exceptions::rpc_exception&) + { + throw; + } + catch (const std::exception& ex) + { + throw exceptions::deserialization_error(ex.what()); + } + }(); + auto& result_cache = get_func_cache(pack.get_func_name()); if constexpr (!std::is_void_v) @@ -514,9 +709,21 @@ inline namespace server if (it != result_cache.end()) { pack.set_result(it->second); - serial_obj = pack_adapter::template serialize_pack(pack); - return; + try + { + serial_obj = + pack_adapter::template serialize_pack(pack); + return; + } + catch (const exceptions::rpc_exception&) + { + throw; + } + catch (const std::exception& ex) + { + throw exceptions::serialization_error(ex.what()); + } } run_callback(func, pack); @@ -527,12 +734,26 @@ inline namespace server run_callback(func, pack); } - serial_obj = pack_adapter::template serialize_pack(pack); + try + { + serial_obj = pack_adapter::template serialize_pack(pack); + } + catch (const exceptions::rpc_exception&) + { + throw; + } + catch (const std::exception& ex) + { + throw exceptions::serialization_error(ex.what()); + } } + # else template void dispatch_cached_func(R (*func)(Args...), typename Serial::serial_t& serial_obj) { + RPC_HPP_PRECONDITION(func != nullptr); + dispatch_func(func, serial_obj); } # endif @@ -546,38 +767,82 @@ inline namespace server template static void dispatch_func(R (*func)(Args...), typename Serial::serial_t& serial_obj) { - auto pack = pack_adapter::template deserialize_pack(serial_obj); + RPC_HPP_PRECONDITION(func != nullptr); + + auto pack = [&serial_obj] + { + try + { + return pack_adapter::template deserialize_pack(serial_obj); + } + catch (const exceptions::rpc_exception&) + { + throw; + } + catch (const std::exception& ex) + { + throw exceptions::deserialization_error(ex.what()); + } + }(); run_callback(func, pack); - serial_obj = pack_adapter::template serialize_pack(pack); + + try + { + serial_obj = pack_adapter::template serialize_pack(pack); + } + catch (const exceptions::rpc_exception&) + { + throw; + } + catch (const std::exception& ex) + { + throw exceptions::serialization_error(ex.what()); + } } - ///@brief Implementation component for the dispatch function - /// - ///@param serial_obj Serial object used to represent the function call + private: virtual void dispatch_impl(typename Serial::serial_t& serial_obj) = 0; - ///@brief Parses the received serialized data and determines which function to call + ///@brief Runs the callback function and updates the result (and any changes to mutable arguments) in the packed_func /// - ///@param bytes Data to be parsed into/back out of a serial object - void dispatch(typename Serial::bytes_t& bytes) + ///@tparam R Return type of the callback function + ///@tparam Args Variadic argument type(s) for the function + ///@param func pointer to the callback function + ///@param pack packed_func representing the callback + template + static void run_callback(R (*func)(Args...), details::packed_func& pack) { - auto serial_obj = Serial::from_bytes(std::move(bytes)); + RPC_HPP_PRECONDITION(func != nullptr); - try + auto& args = pack.get_args(); + + if constexpr (std::is_void_v) { - dispatch_impl(serial_obj); + try + { + std::apply(func, args); + } + catch (const std::exception& ex) + { + throw exceptions::remote_exec_error(ex.what()); + } } - catch (const std::exception& ex) + else { - pack_adapter::set_err_mesg(serial_obj, ex.what()); + try + { + auto result = std::apply(func, args); + pack.set_result(std::move(result)); + } + catch (const std::exception& ex) + { + throw exceptions::remote_exec_error(ex.what()); + } } - - bytes = Serial::to_bytes(std::move(serial_obj)); } # if defined(RPC_HPP_SERVER_IMPL) && defined(RPC_HPP_ENABLE_SERVER_CACHE) - private: template static void* get_func_cache_impl(const std::string& func_name) { @@ -585,16 +850,26 @@ inline namespace server std::unordered_map> cache{}; - return static_cast(&cache[func_name]); + return &cache[func_name]; + } + + template + void update_all_cache(const std::string& func_name) + { + RPC_HPP_PRECONDITION(!func_name.empty()); + + m_cache_map.insert_or_assign(func_name, get_func_cache_impl(func_name)); } - std::unordered_map m_cache_map; + std::unordered_map m_cache_map{}; # endif }; } // namespace server #endif #if defined(RPC_HPP_CLIENT_IMPL) +# define call_header_func(FUNCNAME, ...) call_header_func_impl(FUNCNAME, # FUNCNAME, __VA_ARGS__) + ///@brief Namespace containing functions and classes only relevant to "client-side" implentations /// ///@note Is only compiled by defining @ref RPC_HPP_CLIENT_IMPL @@ -607,7 +882,13 @@ inline namespace client class client_interface { public: - virtual ~client_interface() = default; + virtual ~client_interface() noexcept = default; + client_interface() noexcept = default; + + client_interface(const client_interface&) = delete; + client_interface(client_interface&&) noexcept = default; + client_interface& operator=(const client_interface&) = delete; + client_interface& operator=(client_interface&&) = delete; ///@brief Sends an RPC call request to a server, waits for a response, then returns the result /// @@ -616,45 +897,184 @@ inline namespace client ///@param func_name Name of the remote function to call ///@param args Argument(s) for the remote function ///@return R Result of the function call, will throw with server's error message if the result does not exist + + // nodiscard because an expensive remote procedure call is being performed template - R call_func(std::string func_name, Args&&... args) + [[nodiscard]] R call_func(const std::string& func_name, Args&&... args) { - packed_func pack = [&] + RPC_HPP_PRECONDITION(!func_name.empty()); + + details::packed_func pack = [&]() noexcept { if constexpr (std::is_void_v) { - return packed_func{ std::move(func_name), + return details::packed_func{ func_name, std::forward_as_tuple(args...) }; } else { - return packed_func{ std::move(func_name), std::nullopt, + return details::packed_func{ func_name, std::nullopt, std::forward_as_tuple(args...) }; } }(); - send(Serial::to_bytes(pack_adapter::serialize_pack(pack))); + auto serial_obj = [&pack] + { + try + { + return pack_adapter::serialize_pack(pack); + } + catch (const exceptions::rpc_exception&) + { + throw; + } + catch (const std::exception& ex) + { + throw exceptions::serialization_error(ex.what()); + } + }(); - pack = pack_adapter::template deserialize_pack( - Serial::from_bytes(receive())); + auto bytes = Serial::to_bytes(std::move(serial_obj)); + + try + { + send(std::move(bytes)); + } + catch (const std::exception& ex) + { + throw exceptions::client_send_error(ex.what()); + } + + try + { + bytes = receive(); + } + catch (const std::exception& ex) + { + throw exceptions::client_receive_error(ex.what()); + } + + serial_obj = Serial::from_bytes(std::move(bytes)); + + try + { + pack = pack_adapter::template deserialize_pack(serial_obj); + } + catch (const exceptions::rpc_exception&) + { + throw; + } + catch (const std::exception& ex) + { + throw exceptions::deserialization_error(ex.what()); + } // Assign values back to any (non-const) reference members details::tuple_bind(pack.get_args(), std::forward(args)...); + return pack.get_result(); + } - if constexpr (std::is_void_v) + ///@brief Sends an RPC call request to a server, waits for a response, then returns the result + /// + ///@tparam R Return type of the remote function to call + ///@tparam Args Variadic argument type(s) of the remote function to call + ///@param func_name Name of the remote function to call + ///@param args Argument(s) for the remote function + ///@return R Result of the function call, will throw with server's error message if the result does not exist + + // nodiscard because an expensive remote procedure call is being performed + template + [[nodiscard]] R call_func(std::string&& func_name, Args&&... args) + { + RPC_HPP_PRECONDITION(!func_name.empty()); + + details::packed_func pack = [&]() noexcept { - return; + if constexpr (std::is_void_v) + { + return details::packed_func{ std::move(func_name), + std::forward_as_tuple(args...) }; + } + else + { + return details::packed_func{ std::move(func_name), std::nullopt, + std::forward_as_tuple(args...) }; + } + }(); + + auto serial_obj = [&pack] + { + try + { + return pack_adapter::serialize_pack(pack); + } + catch (const exceptions::rpc_exception&) + { + throw; + } + catch (const std::exception& ex) + { + throw exceptions::serialization_error(ex.what()); + } + }(); + + auto bytes = Serial::to_bytes(std::move(serial_obj)); + + try + { + send(std::move(bytes)); } - else + catch (const std::exception& ex) + { + throw exceptions::client_send_error(ex.what()); + } + + try + { + bytes = receive(); + } + catch (const std::exception& ex) + { + throw exceptions::client_receive_error(ex.what()); + } + + serial_obj = Serial::from_bytes(std::move(bytes)); + + try + { + pack = pack_adapter::template deserialize_pack(serial_obj); + } + catch (const exceptions::rpc_exception&) { - return pack.get_result(); + throw; } + catch (const std::exception& ex) + { + throw exceptions::deserialization_error(ex.what()); + } + + // Assign values back to any (non-const) reference members + details::tuple_bind(pack.get_args(), std::forward(args)...); + return pack.get_result(); } + // nodiscard because an expensive remote procedure call is being performed template - R call_header_func_impl( - [[maybe_unused]] R (*func)(Args...), std::string func_name, Args&&... args) + [[nodiscard]] R call_header_func_impl( + [[maybe_unused]] R (*func)(Args...), const std::string& func_name, Args&&... args) { + RPC_HPP_PRECONDITION(!func_name.empty()); + + return call_func(func_name, std::forward(args)...); + } + + // nodiscard because an expensive remote procedure call is being performed + template + [[nodiscard]] R call_header_func_impl( + [[maybe_unused]] R (*func)(Args...), std::string&& func_name, Args&&... args) + { + RPC_HPP_PRECONDITION(!func_name.empty()); + return call_func(std::move(func_name), std::forward(args)...); } @@ -664,13 +1084,16 @@ inline namespace client ///@param bytes Serialized data to be sent virtual void send(const typename Serial::bytes_t& bytes) = 0; + ///@brief Sends serialized data to a server or module + /// + ///@param bytes Serialized data to be sent + virtual void send(typename Serial::bytes_t&& bytes) = 0; + ///@brief Receives serialized data from a server or module /// ///@return Serial::bytes_t Received serialized data virtual typename Serial::bytes_t receive() = 0; }; - -# define call_header_func(FUNCNAME, ...) call_header_func_impl(FUNCNAME, # FUNCNAME, __VA_ARGS__) } // namespace client #endif } // namespace rpc diff --git a/include/rpc_adapters/meson.build b/include/rpc_adapters/meson.build deleted file mode 100644 index 29d9f225..00000000 --- a/include/rpc_adapters/meson.build +++ /dev/null @@ -1,50 +0,0 @@ -# BSD 3-Clause License -# -# Copyright (c) 2020-2021, Jackson Harmer -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, this -# list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -if get_option('build_adapter_boost_json') - boost_json_dep = dependency('boost', version : '>=1.75.0') - boost_json_adapter_dep = declare_dependency(dependencies : [rpc_hpp_dep, boost_json_dep]) - add_project_arguments('-DRPC_HPP_BOOST_JSON_ENABLED', language : 'cpp') -endif - -if get_option('build_adapter_njson') - njson_dep = dependency('nlohmann_json', version : '>=3.9.0') - njson_adapter_dep = declare_dependency(dependencies : [rpc_hpp_dep, njson_dep]) - add_project_arguments(['-DRPC_HPP_NJSON_ENABLED', '-DRPC_HPP_NLOHMANN_SERIAL_TYPE=1'], language : 'cpp') -endif - -if get_option('build_adapter_rapidjson') - rapidjson_dep = dependency('RapidJSON', version : '>=1.1.0') - rapidjson_adapter_dep = declare_dependency(dependencies : [rpc_hpp_dep, rapidjson_dep]) - add_project_arguments('-DRPC_HPP_RAPIDJSON_ENABLED', language : 'cpp') -endif - -adapter_list = ['rpc_njson.hpp', 'rpc_rapidjson.hpp', 'rpc_boost_json.hpp'] -install_headers(adapter_list) diff --git a/include/rpc_adapters/rpc_bitsery.hpp b/include/rpc_adapters/rpc_bitsery.hpp index aa7a3541..1a6aa622 100644 --- a/include/rpc_adapters/rpc_bitsery.hpp +++ b/include/rpc_adapters/rpc_bitsery.hpp @@ -36,13 +36,8 @@ #pragma once -#if !defined(RPC_HPP_ENABLE_BITSERY) -# error 'rpc_bitsery' was included without defining 'RPC_HPP_ENABLE_BITSERY' Please define this macro or do not include this header! -#endif - #include "../rpc.hpp" -#include #include #include #include @@ -53,12 +48,10 @@ #include #if defined(RPC_HPP_ENABLE_SERVER_CACHE) -namespace std -{ template<> -struct hash> +struct std::hash> { - size_t operator()(const std::vector& vec) const noexcept + [[nodiscard]] size_t operator()(const std::vector& vec) const noexcept { size_t seed = vec.size(); @@ -70,7 +63,6 @@ struct hash> return seed; } }; -} // namespace std #endif namespace rpc @@ -87,9 +79,9 @@ namespace adapters namespace config { #if defined(RPC_HPP_BITSERY_EXACT_SZ) - constexpr bool use_exact_size = true; + static constexpr bool use_exact_size = true; #else - constexpr bool use_exact_size = false; + static constexpr bool use_exact_size = false; #endif extern const uint64_t max_func_name_size; @@ -151,12 +143,7 @@ namespace adapters pack_helper() = default; - pack_helper(std::string name, std::string err, R res, args_t arg_tup) - : func_name(std::move(name)), err_mesg(std::move(err)), result(std::move(res)), - args(std::move(arg_tup)) - { - } - + int except_type{}; std::string func_name{}; std::string err_mesg{}; R result{}; @@ -175,11 +162,7 @@ namespace adapters pack_helper() = default; - pack_helper(std::string name, std::string err, args_t arg_tup) - : func_name(std::move(name)), err_mesg(std::move(err)), args(std::move(arg_tup)) - { - } - + int except_type{}; std::string func_name{}; std::string err_mesg{}; args_t args{}; @@ -188,6 +171,7 @@ namespace adapters template void serialize(S& s, pack_helper& o) { + s.template value(o.except_type); s.text1b(o.func_name, config::max_func_name_size); s.text1b(o.err_mesg, config::max_string_size); @@ -250,13 +234,16 @@ namespace adapters } }); } + // nodiscard because a potentially expensive copy and allocation is being done template - pack_helper to_helper(const packed_func& pack) + [[nodiscard]] pack_helper to_helper( + const ::rpc::details::packed_func& pack) { pack_helper helper; if (!pack) { + helper.except_type = static_cast(pack.get_except_type()); helper.err_mesg = pack.get_err_mesg(); } else @@ -287,36 +274,40 @@ namespace adapters # endif #endif + // nodiscard because a potentially expensive copy and allocation is being done template - packed_func from_helper(pack_helper helper) + [[nodiscard]] ::rpc::details::packed_func from_helper( + pack_helper helper) { if constexpr (std::is_void_v) { - if (helper.err_mesg.empty()) + if (helper.except_type == 0) { - return packed_func{ std::move(helper.func_name), - std::move(helper.args) }; + return ::rpc::details::packed_func{ + std::move(helper.func_name), std::move(helper.args) + }; } - packed_func pack{ std::move(helper.func_name), + ::rpc::details::packed_func pack{ std::move(helper.func_name), std::move(helper.args) }; - pack.set_err_mesg(helper.err_mesg); + pack.set_exception(std::move(helper.err_mesg), + static_cast(helper.except_type)); return pack; } else { if (helper.err_mesg.empty()) { - return packed_func{ std::move(helper.func_name), + return ::rpc::details::packed_func{ std::move(helper.func_name), std::move(helper.result), std::move(helper.args) }; } - packed_func pack{ std::move(helper.func_name), - std::move(helper.result), std::move(helper.args) }; + ::rpc::details::packed_func pack{ std::move(helper.func_name), + std::nullopt, std::move(helper.args) }; - pack.set_err_mesg(helper.err_mesg); - pack.clear_result(); + pack.set_exception(std::move(helper.err_mesg), + static_cast(helper.except_type)); return pack; } } @@ -334,6 +325,7 @@ namespace adapters // Borrowed from Bitsery library for compatibility inline unsigned extract_length(const bit_buffer& bytes, size_t& index) { + assert(index < bytes.size()); const uint8_t hb = bytes[index++]; if (hb < 0x80U) @@ -341,11 +333,13 @@ namespace adapters return hb; } + assert(index < bytes.size()); const uint8_t lb = bytes[index++]; if ((hb & 0x40U) != 0U) { - const uint16_t lw = *reinterpret_cast(bytes.data() + index++); + assert(index < bytes.size()); + const uint16_t lw = *reinterpret_cast(&bytes[index++]); return ((((hb & 0x3FU) << 8) | lb) << 16) | lw; } @@ -358,31 +352,37 @@ namespace adapters { if (size < 0x80U) { - bytes.insert(bytes.begin() + index++, static_cast(size)); + assert(index < size); + assert(index <= std::numeric_limits::max()); + + bytes.insert(bytes.begin() + static_cast(index++), + static_cast(size)); } else { if (size < 0x4000U) { - bytes.insert( - bytes.begin() + index++, static_cast((size >> 8) | 0x80U)); - bytes.insert(bytes.begin() + index++, static_cast(size)); + bytes.insert(bytes.begin() + static_cast(index++), + static_cast((size >> 8) | 0x80U)); + + bytes.insert(bytes.begin() + static_cast(index++), + static_cast(size)); } else { assert(size < 0x40000000U); - bytes.insert( - bytes.begin() + index++, static_cast((size >> 24) | 0xC0U)); - bytes.insert(bytes.begin() + index++, static_cast(size >> 16)); + bytes.insert(bytes.begin() + static_cast(index++), + static_cast((size >> 24) | 0xC0U)); - const auto sh = static_cast(size); + bytes.insert(bytes.begin() + static_cast(index++), + static_cast(size >> 16)); - bytes.insert( - bytes.begin() + index++, *reinterpret_cast(&size)); + bytes.insert(bytes.begin() + static_cast(index++), + *reinterpret_cast(&size)); - bytes.insert( - bytes.begin() + index++, *reinterpret_cast(&size) + 1); + bytes.insert(bytes.begin() + static_cast(index++), + *reinterpret_cast(&size) + 1); } } } @@ -391,28 +391,14 @@ namespace adapters } // namespace adapters template<> -inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::to_bytes( - const adapters::bitsery::bit_buffer& serial_obj) -{ - return serial_obj; -} - -template<> -inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::to_bytes( +[[nodiscard]] inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::to_bytes( adapters::bitsery::bit_buffer&& serial_obj) { return std::move(serial_obj); } template<> -inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::from_bytes( - const adapters::bitsery::bit_buffer& bytes) -{ - return bytes; -} - -template<> -inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::from_bytes( +[[nodiscard]] inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::from_bytes( adapters::bitsery::bit_buffer&& bytes) { return std::move(bytes); @@ -420,14 +406,16 @@ inline adapters::bitsery::bit_buffer adapters::bitsery_adapter::from_bytes( template<> template -adapters::bitsery::bit_buffer pack_adapter::serialize_pack( - const packed_func& pack) +[[nodiscard]] adapters::bitsery::bit_buffer pack_adapter::serialize_pack( + const ::rpc::details::packed_func& pack) { using namespace adapters::bitsery; const auto helper = adapters::bitsery::details::to_helper(pack); - bit_buffer buffer; + bit_buffer buffer{}; + buffer.reserve(64); + const auto bytes_written = bitsery::quickSerialization(buffer, helper); @@ -437,8 +425,8 @@ adapters::bitsery::bit_buffer pack_adapter::serialize template<> template -packed_func pack_adapter::deserialize_pack( - const adapters::bitsery::bit_buffer& serial_obj) +[[nodiscard]] ::rpc::details::packed_func pack_adapter< + adapters::bitsery_adapter>::deserialize_pack(const adapters::bitsery::bit_buffer& serial_obj) { using namespace adapters::bitsery; @@ -449,63 +437,77 @@ packed_func pack_adapter::deserialize_pac if (error != bitsery::ReaderError::NoError) { - const std::string error_mesg = [error = error]() + switch (error) { - switch (error) - { - case bitsery::ReaderError::ReadingError: - return "a reading error!"; - - case bitsery::ReaderError::DataOverflow: - return "data overflow!"; - - case bitsery::ReaderError::InvalidData: - return "invalid data!"; - - case bitsery::ReaderError::InvalidPointer: - return "an invalid pointer!"; - - case bitsery::ReaderError::NoError: - default: - return "extra data on the end!"; - } - }(); - - throw std::runtime_error( - std::string{ "Bitsery deserialization failed due to " } + error_mesg); + case bitsery::ReaderError::ReadingError: + throw rpc::exceptions::deserialization_error( + "Bitsery deserialization failed due to a reading error"); + + case bitsery::ReaderError::DataOverflow: + throw rpc::exceptions::function_mismatch( + "Bitsery deserialization failed due to data overflow (likely mismatched " + "function signature)"); + + case bitsery::ReaderError::InvalidData: + throw rpc::exceptions::deserialization_error( + "Bitsery deserialization failed due to a invalid data"); + + case bitsery::ReaderError::InvalidPointer: + throw rpc::exceptions::deserialization_error( + "Bitsery deserialization failed due to an invalid pointer"); + + case bitsery::ReaderError::NoError: + default: + throw rpc::exceptions::deserialization_error( + "Bitsery deserialization failed due to extra data on the end"); + } } return adapters::bitsery::details::from_helper(helper); } template<> -inline std::string pack_adapter::get_func_name( +[[nodiscard]] inline std::string pack_adapter::get_func_name( const adapters::bitsery::bit_buffer& serial_obj) { - size_t index = 0; + size_t index = sizeof(int); const auto len = adapters::bitsery::details::extract_length(serial_obj, index); - return { serial_obj.begin() + index, serial_obj.begin() + index + len }; + + assert(index < serial_obj.size()); + assert(index <= std::numeric_limits::max()); + return { serial_obj.begin() + static_cast(index), + serial_obj.begin() + static_cast(index + len) }; } template<> -inline void pack_adapter::set_err_mesg( - adapters::bitsery::bit_buffer& serial_obj, const std::string& mesg) +inline void pack_adapter::set_exception( + adapters::bitsery::bit_buffer& serial_obj, const rpc::exceptions::rpc_exception& ex) { - size_t index = 0; + // copy except_type into buffer + const int ex_type = static_cast(ex.get_type()); + memcpy(&serial_obj[0], &ex_type, sizeof(int)); - const auto name_len = adapters::bitsery::details::extract_length(serial_obj, index); + const std::string_view mesg = ex.what(); + size_t index = sizeof(int); + const auto name_len = adapters::bitsery::details::extract_length(serial_obj, index); const size_t name_sz_len = index; index += name_len; const auto err_len = adapters::bitsery::details::extract_length(serial_obj, index); - const auto new_err_len = static_cast(mesg.size()); if (new_err_len != err_len) { - serial_obj.erase( - serial_obj.begin() + name_sz_len + name_len, serial_obj.begin() + index + err_len); + if (err_len != 0) + { + assert(index < serial_obj.size()); + assert(index <= std::numeric_limits::max()); + + serial_obj.erase(serial_obj.begin() + static_cast(name_sz_len) + + static_cast(name_len), + serial_obj.begin() + static_cast(index + err_len)); + } index = name_sz_len + name_len; adapters::bitsery::details::write_length(serial_obj, new_err_len, index); @@ -513,7 +515,11 @@ inline void pack_adapter::set_err_mesg( for (unsigned i = 0; i < new_err_len; ++i) { - serial_obj.insert(serial_obj.begin() + index++, mesg[i]); + assert(index < serial_obj.size()); + assert(index <= std::numeric_limits::max()); + + serial_obj.insert(serial_obj.begin() + static_cast(index++), + static_cast(mesg[i])); } } } // namespace rpc diff --git a/include/rpc_adapters/rpc_boost_json.hpp b/include/rpc_adapters/rpc_boost_json.hpp index fa0ed155..a25256b5 100644 --- a/include/rpc_adapters/rpc_boost_json.hpp +++ b/include/rpc_adapters/rpc_boost_json.hpp @@ -36,10 +36,6 @@ #pragma once -#if !defined(RPC_HPP_ENABLE_BOOST_JSON) -# error 'rpc_boost_json' was included without defining 'RPC_HPP_ENABLE_BOOST_JSON' Please define this macro or do not include this header! -#endif - #include "../rpc.hpp" #include @@ -60,49 +56,140 @@ namespace adapters namespace details { template - void push_arg(T&& arg, boost::json::array& arg_arr) + [[nodiscard]] constexpr bool validate_arg(const value_t& arg) + { + if constexpr (std::is_same_v) + { + return arg.is_bool(); + } + else if constexpr (std::is_integral_v) + { + if constexpr (std::is_signed_v) + { + return arg.is_int64(); + } + else + { + return arg.is_uint64(); + } + } + else if constexpr (std::is_floating_point_v) + { + return arg.is_double(); + } + else if constexpr (std::is_same_v) + { + return arg.is_string(); + } + else if constexpr (rpc::details::is_container_v) + { + return arg.is_array(); + } + else + { + return !arg.is_null(); + } + } + + [[noreturn]] inline void throw_mismatch( + std::string&& expect_type, const value_t& obj) noexcept(false) + { + std::string type_str = [&obj] + { + switch (obj.kind()) + { + case boost::json::kind::bool_: + return "bool"; + + case boost::json::kind::int64: + return "int64"; + + case boost::json::kind::uint64: + return "uint64"; + + case boost::json::kind::double_: + return "double"; + + case boost::json::kind::string: + return "string"; + + case boost::json::kind::array: + return "array"; + + case boost::json::kind::object: + return "object"; + + default: + case boost::json::kind::null: + return "null"; + } + }(); + + throw exceptions::function_mismatch("Boost.JSON expected type: " + + std::move(expect_type) + ", got type: " + std::move(type_str)); + } + + template + void push_args(T&& arg, boost::json::array& obj); + + template + void push_arg(T&& arg, value_t& obj) { using no_ref_t = std::remove_cv_t>; if constexpr (std::is_arithmetic_v) { - arg_arr.push_back(std::forward(arg)); + obj = std::forward(arg); } else if constexpr (std::is_same_v) { - arg_arr.push_back(boost::json::string{ arg.c_str() }); + obj = boost::json::string{ arg.c_str() }; } else if constexpr (rpc::details::is_container_v) { - boost::json::array arr; + obj = boost::json::array{}; + auto& arr = obj.as_array(); + arr.reserve(arg.size()); for (auto&& val : arg) { - push_arg(std::forward(val), arr); + push_args(std::forward(val), arr); } - - arg_arr.push_back(arr); } else if constexpr (rpc::details::is_serializable_v) { - arg_arr.push_back(no_ref_t::template serialize( - std::forward(arg))); + obj = no_ref_t::template serialize( + std::forward(arg)); } else { - arg_arr.push_back(adapters::boost_json_adapter::template serialize( - std::forward(arg))); + obj = adapters::boost_json_adapter::template serialize( + std::forward(arg)); } } template - std::remove_cv_t> parse_arg( - const value_t& arg_arr, unsigned& index) + void push_args(T&& arg, boost::json::array& obj_arr) + { + value_t tmp{}; + push_arg(std::forward(arg), tmp); + obj_arr.push_back(std::move(tmp)); + } + + template + std::remove_cv_t> parse_args( + const value_t& arg_arr, unsigned& index); + + template + [[nodiscard]] std::remove_cv_t> parse_arg(const value_t& arg) { using no_ref_t = std::remove_cv_t>; - const auto& arg = arg_arr.is_array() ? arg_arr.as_array().at(index++) : arg_arr; + if (!validate_arg(arg)) + { + throw_mismatch(typeid(no_ref_t).name(), arg); + } if constexpr (std::is_arithmetic_v< no_ref_t> || std::is_same_v) @@ -111,17 +198,17 @@ namespace adapters } else if constexpr (rpc::details::is_container_v) { - using value_t = typename no_ref_t::value_type; + using subvalue_t = typename no_ref_t::value_type; auto& arr = arg.as_array(); - no_ref_t container; + no_ref_t container{}; container.reserve(arr.size()); unsigned j = 0; for (const auto& val : arr) { - container.push_back(parse_arg(val, j)); + container.push_back(parse_args(val, j)); } return container; @@ -136,121 +223,95 @@ namespace adapters return adapters::boost_json_adapter::template deserialize(arg); } } + + template + [[nodiscard]] std::remove_cv_t> parse_args( + const value_t& arg_arr, unsigned& index) + { + if (index >= arg_arr.as_array().size()) + { + throw exceptions::function_mismatch("Argument count mismatch"); + } + + const auto& arg = arg_arr.is_array() ? arg_arr.as_array().at(index++) : arg_arr; + return parse_arg(arg); + } } // namespace details } // namespace boost_json } // namespace adapters template<> -inline std::string adapters::boost_json_adapter::to_bytes( - const adapters::boost_json::value_t& serial_obj) -{ - return boost::json::serialize(serial_obj); -} - -template<> -inline std::string adapters::boost_json_adapter::to_bytes( +[[nodiscard]] inline std::string adapters::boost_json_adapter::to_bytes( adapters::boost_json::value_t&& serial_obj) { return boost::json::serialize(std::move(serial_obj)); } template<> -inline adapters::boost_json::value_t adapters::boost_json_adapter::from_bytes( - const std::string& bytes) -{ - return boost::json::parse(bytes); -} - -template<> -inline adapters::boost_json::value_t adapters::boost_json_adapter::from_bytes(std::string&& bytes) +[[nodiscard]] inline adapters::boost_json::value_t adapters::boost_json_adapter::from_bytes( + std::string&& bytes) { return boost::json::parse(std::move(bytes)); } template<> template -adapters::boost_json::value_t pack_adapter::serialize_pack( - const packed_func& pack) +[[nodiscard]] adapters::boost_json::value_t pack_adapter:: + serialize_pack(const ::rpc::details::packed_func& pack) { using namespace adapters::boost_json; - object_t ret_j; + object_t obj{}; + obj["func_name"] = pack.get_func_name(); - ret_j["func_name"] = pack.get_func_name(); + auto& args = obj["args"].emplace_array(); + args.reserve(sizeof...(Args)); - const auto& err_mesg = pack.get_err_mesg(); + const auto& argTup = pack.get_args(); + rpc::details::for_each_tuple(argTup, + [&args](auto&& x) + { adapters::boost_json::details::push_args(std::forward(x), args); }); - if (!err_mesg.empty()) + if (!pack) { - ret_j["err_mesg"] = err_mesg; + obj["except_type"] = static_cast(pack.get_except_type()); + obj["err_mesg"] = pack.get_err_mesg(); } - - if constexpr (!std::is_void_v) + else { - ret_j["result"] = nullptr; - auto& result = ret_j["result"]; - - if (pack) + if constexpr (!std::is_void_v) { - if constexpr (std::is_arithmetic_v || std::is_same_v) - { - result = pack.get_result(); - } - else if constexpr (rpc::details::is_container_v) - { - result = boost::json::array{}; - const auto& container = pack.get_result(); - - for (const auto& val : container) - { - result.as_array().push_back(val); - } - } - else if constexpr (rpc::details::is_serializable_v) - { - result = R::template serialize(pack.get_result()); - } - else - { - result = adapters::boost_json_adapter::template serialize(pack.get_result()); - } + obj["result"] = {}; + adapters::boost_json::details::push_arg(pack.get_result(), obj.at("result")); } } - boost::json::array args{}; - - const auto& argTup = pack.get_args(); - rpc::details::for_each_tuple(argTup, - [&args](auto&& x) - { adapters::boost_json::details::push_arg(std::forward(x), args); }); - - ret_j["args"] = std::move(args); - return ret_j; + return obj; } template<> template -packed_func pack_adapter::deserialize_pack( - const adapters::boost_json::value_t& serial_obj) +[[nodiscard]] ::rpc::details::packed_func pack_adapter< + adapters::boost_json_adapter>::deserialize_pack(const adapters::boost_json::value_t& serial_obj) { using namespace adapters::boost_json; - assert(serial_obj.is_object()); - const auto& obj = serial_obj.as_object(); + RPC_HPP_PRECONDITION(serial_obj.is_object()); + + const auto& obj = serial_obj.get_object(); [[maybe_unused]] unsigned i = 0; auto& args_val = obj.at("args"); - typename packed_func::args_t args{ adapters::boost_json::details::parse_arg( - args_val, i)... }; - if constexpr (std::is_void_v) { - packed_func pack(obj.at("func_name").get_string().c_str(), std::move(args)); + ::rpc::details::packed_func pack(obj.at("func_name").get_string().c_str(), + { adapters::boost_json::details::parse_args(args_val, i)... }); - if (obj.contains("err_mesg")) + if (obj.contains("except_type")) { - pack.set_err_mesg(obj.at("err_mesg").get_string().c_str()); + pack.set_exception(obj.at("err_mesg").get_string().c_str(), + static_cast(obj.at("except_type").get_int64())); } return pack; @@ -259,54 +320,19 @@ packed_func pack_adapter::deserialize_ { if (obj.contains("result") && !obj.at("result").is_null()) { - const auto& result = obj.at("result"); - - if constexpr (std::is_arithmetic_v) - { - return packed_func(obj.at("func_name").get_string().c_str(), - boost::json::value_to(result), std::move(args)); - } - else if constexpr (std::is_same_v) - { - return packed_func(obj.at("func_name").get_string().c_str(), - result.get_string().c_str(), std::move(args)); - } - else if constexpr (rpc::details::is_container_v) - { - using value_t = typename R::value_type; - - auto& arr = result.as_array(); - R container; - container.reserve(arr.size()); - - unsigned j = 0; - - for (const auto& val : arr) - { - container.push_back(adapters::boost_json::details::parse_arg(val, j)); - } - - return packed_func( - obj.at("func_name").get_string().c_str(), container, std::move(args)); - } - else if constexpr (rpc::details::is_serializable_v) - { - return packed_func(obj.at("func_name").get_string().c_str(), - R::template deserialize(result), std::move(args)); - } - else - { - return packed_func(obj.at("func_name").get_string().c_str(), - adapters::boost_json_adapter::template deserialize(result), std::move(args)); - } + return ::rpc::details::packed_func(obj.at("func_name").get_string().c_str(), + adapters::boost_json::details::parse_arg(obj.at("result")), + { adapters::boost_json::details::parse_args(obj.at("args"), i)... }); } - packed_func pack( - obj.at("func_name").get_string().c_str(), std::nullopt, std::move(args)); + ::rpc::details::packed_func pack(obj.at("func_name").get_string().c_str(), + std::nullopt, + { adapters::boost_json::details::parse_args(obj.at("args"), i)... }); - if (obj.contains("err_mesg")) + if (obj.contains("except_type")) { - pack.set_err_mesg(obj.at("err_mesg").get_string().c_str()); + pack.set_exception(obj.at("err_mesg").get_string().c_str(), + static_cast(obj.at("except_type").get_int64())); } return pack; @@ -314,19 +340,22 @@ packed_func pack_adapter::deserialize_ } template<> -inline std::string pack_adapter::get_func_name( +[[nodiscard]] inline std::string pack_adapter::get_func_name( const adapters::boost_json::value_t& serial_obj) { - assert(serial_obj.is_object()); - return serial_obj.at("func_name").get_string().c_str(); + RPC_HPP_PRECONDITION(serial_obj.is_object()); + + return { serial_obj.at("func_name").get_string().c_str() }; } template<> -inline void pack_adapter::set_err_mesg( - adapters::boost_json::value_t& serial_obj, const std::string& mesg) +inline void pack_adapter::set_exception( + adapters::boost_json::value_t& serial_obj, const rpc::exceptions::rpc_exception& ex) { - assert(serial_obj.is_object()); - auto& obj = serial_obj.as_object(); - obj["err_mesg"] = mesg; + RPC_HPP_PRECONDITION(serial_obj.is_object()); + + auto& obj = serial_obj.get_object(); + obj["except_type"] = static_cast(ex.get_type()); + obj["err_mesg"] = boost::json::string{ ex.what() }; } } // namespace rpc diff --git a/include/rpc_adapters/rpc_njson.hpp b/include/rpc_adapters/rpc_njson.hpp index 6461dff3..acb50b40 100644 --- a/include/rpc_adapters/rpc_njson.hpp +++ b/include/rpc_adapters/rpc_njson.hpp @@ -36,10 +36,6 @@ #pragma once -#if !defined(RPC_HPP_ENABLE_NJSON) -# error 'rpc_njson' was included without defining 'RPC_HPP_ENABLE_NJSON' Please define this macro or do not include this header! -#endif - #include "../rpc.hpp" #include @@ -57,45 +53,90 @@ namespace adapters namespace details { template - void push_arg(T&& arg, njson_t& arg_arr) + [[nodiscard]] constexpr bool validate_arg(const njson_t& arg) + { + if constexpr (std::is_same_v) + { + return arg.is_boolean(); + } + else if constexpr (std::is_integral_v) + { + return arg.is_number() && !arg.is_number_float(); + } + else if constexpr (std::is_floating_point_v) + { + return arg.is_number_float(); + } + else if constexpr (std::is_same_v) + { + return arg.is_string(); + } + else if constexpr (rpc::details::is_container_v) + { + return arg.is_array(); + } + else + { + return !arg.is_null(); + } + } + + template + void push_args(T&& arg, njson_t& obj_arr); + + template + void push_arg(T&& arg, njson_t& obj) { using no_ref_t = std::remove_cv_t>; if constexpr (std::is_arithmetic_v< no_ref_t> || std::is_same_v) { - arg_arr.push_back(std::forward(arg)); + obj = std::forward(arg); } else if constexpr (rpc::details::is_container_v) { - njson_t arr = njson_t::array(); + obj = njson_t::array(); + obj.get_ref().reserve(arg.size()); for (auto&& val : arg) { - push_arg(std::forward(val), arr); + push_args(std::forward(val), obj); } - - arg_arr.push_back(std::move(arr)); } else if constexpr (rpc::details::is_serializable_v) { - arg_arr.push_back( - no_ref_t::template serialize(std::forward(arg))); + obj = no_ref_t::template serialize(std::forward(arg)); } else { - arg_arr.push_back( - njson_adapter::template serialize(std::forward(arg))); + obj = njson_adapter::template serialize(std::forward(arg)); } } template - std::remove_cv_t> parse_arg( - const njson_t& arg_arr, unsigned& index) + void push_args(T&& arg, njson_t& obj_arr) + { + njson_t tmp{}; + push_arg(std::forward(arg), tmp); + obj_arr.push_back(std::move(tmp)); + } + + template + std::remove_cv_t> parse_args( + const njson_t& arg_arr, unsigned& index); + + template + [[nodiscard]] std::remove_cv_t> parse_arg(const njson_t& arg) { using no_ref_t = std::remove_cv_t>; - const auto& arg = arg_arr.is_array() ? arg_arr[index++] : arg_arr; + if (!validate_arg(arg)) + { + throw exceptions::function_mismatch(std::string{ "njson expected type: " } + + std::string{ typeid(no_ref_t).name() } + std::string{ ", got type: " } + + std::string{ arg.type_name() }); + } if constexpr (std::is_arithmetic_v< no_ref_t> || std::is_same_v) @@ -106,14 +147,14 @@ namespace adapters { using value_t = typename no_ref_t::value_type; - no_ref_t container; + no_ref_t container{}; container.reserve(arg.size()); unsigned j = 0; for (const auto& val : arg) { - container.push_back(parse_arg(val, j)); + container.push_back(parse_args(val, j)); } return container; @@ -127,63 +168,66 @@ namespace adapters return njson_adapter::template deserialize(arg); } } + + template + [[nodiscard]] std::remove_cv_t> parse_args( + const njson_t& arg_arr, unsigned& index) + { + if (index >= arg_arr.size()) + { + throw exceptions::function_mismatch("Argument count mismatch"); + } + + const auto& arg = arg_arr.is_array() ? arg_arr[index++] : arg_arr; + return parse_arg(arg); + } } // namespace details } // namespace njson } // namespace adapters template<> -inline std::string adapters::njson_adapter::to_bytes(const adapters::njson::njson_t& serial_obj) -{ - return serial_obj.dump(); -} - -template<> -inline std::string adapters::njson_adapter::to_bytes(adapters::njson::njson_t&& serial_obj) +[[nodiscard]] inline std::string adapters::njson_adapter::to_bytes( + adapters::njson::njson_t&& serial_obj) { return std::move(serial_obj).dump(); } template<> -inline adapters::njson::njson_t adapters::njson_adapter::from_bytes(const std::string& bytes) -{ - return adapters::njson::njson_t::parse(bytes); -} - -template<> -inline adapters::njson::njson_t adapters::njson_adapter::from_bytes(std::string&& bytes) +[[nodiscard]] inline adapters::njson::njson_t adapters::njson_adapter::from_bytes( + std::string&& bytes) { return adapters::njson::njson_t::parse(std::move(bytes)); } template<> template -adapters::njson::njson_t pack_adapter::serialize_pack( - const packed_func& pack) +[[nodiscard]] adapters::njson::njson_t pack_adapter::serialize_pack( + const ::rpc::details::packed_func& pack) { using namespace adapters::njson; - njson_t obj; - + njson_t obj{}; obj["func_name"] = pack.get_func_name(); - - auto arg_arr = njson_t::array(); + obj["args"] = njson_t::array(); + auto& arg_arr = obj["args"]; + arg_arr.get_ref().reserve(sizeof...(Args)); const auto& argTup = pack.get_args(); rpc::details::for_each_tuple(argTup, [&arg_arr](auto&& x) - { adapters::njson::details::push_arg(std::forward(x), arg_arr); }); - - obj["args"] = std::move(arg_arr); + { adapters::njson::details::push_args(std::forward(x), arg_arr); }); if (!pack) { + obj["except_type"] = pack.get_except_type(); obj["err_mesg"] = pack.get_err_mesg(); } else { if constexpr (!std::is_void_v) { - obj["result"] = pack.get_result(); + obj["result"] = {}; + adapters::njson::details::push_arg(pack.get_result(), obj["result"]); } } @@ -192,23 +236,22 @@ adapters::njson::njson_t pack_adapter::serialize_pack( template<> template -packed_func pack_adapter::deserialize_pack( - const adapters::njson::njson_t& serial_obj) +[[nodiscard]] ::rpc::details::packed_func pack_adapter< + adapters::njson_adapter>::deserialize_pack(const adapters::njson::njson_t& serial_obj) { using namespace adapters::njson; [[maybe_unused]] unsigned i = 0; - typename packed_func::args_t args{ adapters::njson::details::parse_arg( - serial_obj["args"], i)... }; - if constexpr (std::is_void_v) { - packed_func pack(serial_obj["func_name"], std::move(args)); + ::rpc::details::packed_func pack(serial_obj["func_name"], + { adapters::njson::details::parse_args(serial_obj["args"], i)... }); - if (serial_obj.contains("err_mesg")) + if (serial_obj.contains("except_type")) { - pack.set_err_mesg(serial_obj["err_mesg"]); + pack.set_exception( + serial_obj["err_mesg"], static_cast(serial_obj["except_type"])); } return pack; @@ -217,15 +260,18 @@ packed_func pack_adapter::deserialize_pack( { if (serial_obj.contains("result") && !serial_obj["result"].is_null()) { - return packed_func( - serial_obj["func_name"], serial_obj["result"].get(), std::move(args)); + return ::rpc::details::packed_func(serial_obj["func_name"], + adapters::njson::details::parse_arg(serial_obj["result"]), + { adapters::njson::details::parse_args(serial_obj["args"], i)... }); } - packed_func pack(serial_obj["func_name"], std::nullopt, std::move(args)); + ::rpc::details::packed_func pack(serial_obj["func_name"], std::nullopt, + { adapters::njson::details::parse_args(serial_obj["args"], i)... }); - if (serial_obj.contains("err_mesg")) + if (serial_obj.contains("except_type")) { - pack.set_err_mesg(serial_obj["err_mesg"]); + pack.set_exception( + serial_obj["err_mesg"], static_cast(serial_obj["except_type"])); } return pack; @@ -233,16 +279,17 @@ packed_func pack_adapter::deserialize_pack( } template<> -inline std::string pack_adapter::get_func_name( +[[nodiscard]] inline std::string pack_adapter::get_func_name( const adapters::njson::njson_t& serial_obj) { return serial_obj["func_name"]; } template<> -inline void pack_adapter::set_err_mesg( - adapters::njson::njson_t& serial_obj, const std::string& mesg) +inline void pack_adapter::set_exception( + adapters::njson::njson_t& serial_obj, const rpc::exceptions::rpc_exception& ex) { - serial_obj["err_mesg"] = mesg; + serial_obj["except_type"] = ex.get_type(); + serial_obj["err_mesg"] = ex.what(); } } // namespace rpc diff --git a/include/rpc_adapters/rpc_rapidjson.hpp b/include/rpc_adapters/rpc_rapidjson.hpp index 1a6e2920..30aaefdd 100644 --- a/include/rpc_adapters/rpc_rapidjson.hpp +++ b/include/rpc_adapters/rpc_rapidjson.hpp @@ -36,10 +36,6 @@ #pragma once -#if !defined(RPC_HPP_ENABLE_RAPIDJSON) -# error 'rpc_rapidjson' was included without defining 'RPC_HPP_ENABLE_RAPIDJSON' Please define this macro or do not include this header! -#endif - #include "../rpc.hpp" #include @@ -60,13 +56,137 @@ namespace adapters namespace details { template - void push_arg(T&& arg, value_t& arg_arr, ::rapidjson::MemoryPoolAllocator<>& alloc) + [[nodiscard]] constexpr bool validate_arg(const value_t& arg) + { + if constexpr (std::is_same_v) + { + return arg.IsBool(); + } + else if constexpr (std::is_integral_v) + { + if constexpr (std::is_signed_v) + { + if constexpr (sizeof(T) < 8) + { + return arg.IsInt(); + } + else + { + return arg.IsInt64(); + } + } + else + { + if constexpr (sizeof(T) < 8) + { + return arg.IsUint(); + } + else + { + return arg.IsUint64(); + } + } + } + else if constexpr (std::is_same_v) + { + return arg.IsFloat(); + } + else if constexpr (std::is_same_v) + { + return arg.IsDouble(); + } + else if constexpr (std::is_same_v) + { + return arg.IsString(); + } + else if constexpr (rpc::details::is_container_v) + { + return arg.IsArray(); + } + else + { + return !arg.IsNull(); + } + } + + [[noreturn]] inline void throw_mismatch( + std::string&& expect_type, const value_t& obj) noexcept(false) + { + std::string type_str = [&obj] + { + if (obj.IsNull()) + { + return "null"; + } + + if (obj.IsInt64()) + { + return "int64"; + } + + if (obj.IsInt()) + { + return "int"; + } + + if (obj.IsUint64()) + { + return "uint64"; + } + + if (obj.IsUint()) + { + return "uint"; + } + + if (obj.IsDouble()) + { + return "double"; + } + + if (obj.IsFloat()) + { + return "float"; + } + + if (obj.IsBool()) + { + return "bool"; + } + + if (obj.IsString()) + { + return "string"; + } + + if (obj.IsArray()) + { + return "array"; + } + + if (obj.IsObject()) + { + return "object"; + } + + return "unknown"; + }(); + + throw exceptions::function_mismatch("rapidjson expected type: " + + std::move(expect_type) + ", got type: " + std::move(type_str)); + } + + template + void push_args(T&& arg, value_t& obj_arr, ::rapidjson::MemoryPoolAllocator<>& alloc); + + template + void push_arg(T&& arg, value_t& obj, ::rapidjson::MemoryPoolAllocator<>& alloc) { using no_ref_t = std::remove_cv_t>; if constexpr (std::is_same_v) { - arg_arr.PushBack(value_t{}.SetString(arg.c_str(), alloc), alloc); + obj.SetString(arg.c_str(), alloc); } else if constexpr (std::is_arithmetic_v) { @@ -75,56 +195,65 @@ namespace adapters std::is_same_v || std::is_same_v || std::is_same_v) { - arg_arr.PushBack(value_t().SetInt(arg), alloc); + obj.SetInt(arg); } else if constexpr (std::is_same_v || std::is_same_v) { - arg_arr.PushBack(value_t().SetUint(arg), alloc); + obj.SetUint(arg); } else { - arg_arr.PushBack(value_t().Set(arg), alloc); + obj.Set(arg); } } else if constexpr (rpc::details::is_container_v) { - value_t sub_arr; - sub_arr.SetArray(); + obj.SetArray(); + obj.Reserve(static_cast<::rapidjson::SizeType>(arg.size()), alloc); for (auto&& val : arg) { - push_arg(std::forward(val), sub_arr, alloc); + push_args(std::forward(val), obj, alloc); } - - arg_arr.PushBack(sub_arr, alloc); } else if constexpr (rpc::details::is_serializable_v) { doc_t serialized = no_ref_t::template serialize(std::forward(arg)); - value_t arr_val; - arr_val.CopyFrom(serialized, alloc); - arg_arr.PushBack(arr_val, alloc); + + obj.CopyFrom(serialized, alloc); } else { doc_t serialized = rapidjson_adapter::template serialize(std::forward(arg)); - value_t arr_val; - arr_val.CopyFrom(serialized, alloc); - arg_arr.PushBack(arr_val, alloc); + obj.CopyFrom(serialized, alloc); } } template - std::remove_cv_t> parse_arg( - const value_t& arg_arr, unsigned& index) + void push_args(T&& arg, value_t& obj_arr, ::rapidjson::MemoryPoolAllocator<>& alloc) + { + value_t tmp{}; + push_arg(std::forward(arg), tmp, alloc); + obj_arr.PushBack(std::move(tmp), alloc); + } + + template + [[nodiscard]] std::remove_cv_t> parse_args( + const value_t& arg_arr, unsigned& index); + + template + [[nodiscard]] std::remove_cv_t> parse_arg(const value_t& arg) { using no_ref_t = std::remove_cv_t>; - const value_t& arg = arg_arr.IsArray() ? arg_arr.GetArray()[index++] : arg_arr; + if (!validate_arg(arg)) + { + throw_mismatch(typeid(no_ref_t).name(), arg); + } if constexpr (std::is_same_v) { @@ -152,67 +281,63 @@ namespace adapters else if constexpr (rpc::details::is_container_v) { using subvalue_t = typename no_ref_t::value_type; - no_ref_t container; - container.reserve(arg.Size()); + no_ref_t container{}; + container.reserve(arg.Size()); unsigned j = 0; for (const auto& val : arg.GetArray()) { - container.push_back(parse_arg(val, j)); + container.push_back(parse_args(val, j)); } return container; } else if constexpr (rpc::details::is_serializable_v) { - doc_t d; + doc_t d{}; d.CopyFrom(arg, d.GetAllocator()); return no_ref_t::template deserialize(d); } else { - doc_t d; + doc_t d{}; d.CopyFrom(arg, d.GetAllocator()); return rapidjson_adapter::template deserialize(d); } } + + template + [[nodiscard]] std::remove_cv_t> parse_args( + const value_t& arg_arr, unsigned& index) + { + if (arg_arr.IsArray() && index >= arg_arr.GetArray().Size()) + { + throw exceptions::function_mismatch("Argument count mismatch"); + } + + const value_t& arg = arg_arr.IsArray() ? arg_arr.GetArray()[index++] : arg_arr; + return parse_arg(arg); + } } // namespace details } // namespace rapidjson } // namespace adapters template<> -inline std::string adapters::rapidjson_adapter::to_bytes( - const adapters::rapidjson::doc_t& serial_obj) -{ - rapidjson::StringBuffer buffer; - rapidjson::Writer writer(buffer); - serial_obj.Accept(writer); - return buffer.GetString(); -} - -template<> -inline std::string adapters::rapidjson_adapter::to_bytes(adapters::rapidjson::doc_t&& serial_obj) +[[nodiscard]] inline std::string adapters::rapidjson_adapter::to_bytes( + adapters::rapidjson::doc_t&& serial_obj) { - rapidjson::StringBuffer buffer; + rapidjson::StringBuffer buffer{}; rapidjson::Writer writer(buffer); std::move(serial_obj).Accept(writer); return buffer.GetString(); } template<> -inline adapters::rapidjson::doc_t adapters::rapidjson_adapter::from_bytes(const std::string& bytes) -{ - adapters::rapidjson::doc_t d; - d.SetObject(); - d.Parse(bytes.c_str()); - return d; -} - -template<> -inline adapters::rapidjson::doc_t adapters::rapidjson_adapter::from_bytes(std::string&& bytes) +[[nodiscard]] inline adapters::rapidjson::doc_t adapters::rapidjson_adapter::from_bytes( + std::string&& bytes) { - adapters::rapidjson::doc_t d; + adapters::rapidjson::doc_t d{}; d.SetObject(); d.Parse(std::move(bytes).c_str()); return d; @@ -220,12 +345,12 @@ inline adapters::rapidjson::doc_t adapters::rapidjson_adapter::from_bytes(std::s template<> template -adapters::rapidjson::doc_t pack_adapter::serialize_pack( - const packed_func& pack) +[[nodiscard]] adapters::rapidjson::doc_t pack_adapter::serialize_pack( + const ::rpc::details::packed_func& pack) { using namespace adapters::rapidjson; - doc_t d; + doc_t d{}; auto& alloc = d.GetAllocator(); d.SetObject(); @@ -233,7 +358,7 @@ adapters::rapidjson::doc_t pack_adapter::serialize_ if constexpr (!std::is_void_v) { - value_t result; + value_t result{}; if (pack) { @@ -249,6 +374,7 @@ adapters::rapidjson::doc_t pack_adapter::serialize_ { const auto& container = pack.get_result(); result.SetArray(); + result.Reserve(static_cast<::rapidjson::SizeType>(container.size()), alloc); for (const auto& val : container) { @@ -274,37 +400,41 @@ adapters::rapidjson::doc_t pack_adapter::serialize_ d.AddMember("result", result, alloc); } - value_t args; + value_t args{}; args.SetArray(); - + args.Reserve(static_cast<::rapidjson::SizeType>(sizeof...(Args)), alloc); const auto& argTup = pack.get_args(); + rpc::details::for_each_tuple(argTup, [&args, &alloc](auto&& x) - { adapters::rapidjson::details::push_arg(std::forward(x), args, alloc); }); + { adapters::rapidjson::details::push_args(std::forward(x), args, alloc); }); - d.AddMember("args", args, alloc); + d.AddMember("args", std::move(args), alloc); return d; } template<> template -packed_func pack_adapter::deserialize_pack( - const adapters::rapidjson::doc_t& serial_obj) +[[nodiscard]] ::rpc::details::packed_func pack_adapter< + adapters::rapidjson_adapter>::deserialize_pack(const adapters::rapidjson::doc_t& serial_obj) { using namespace adapters::rapidjson; [[maybe_unused]] unsigned i = 0; - typename packed_func::args_t args{ adapters::rapidjson::details::parse_arg( - serial_obj["args"], i)... }; + typename ::rpc::details::packed_func::args_t args{ + adapters::rapidjson::details::parse_args(serial_obj["args"], i)... + }; if constexpr (std::is_void_v) { - packed_func pack(serial_obj["func_name"].GetString(), std::move(args)); + ::rpc::details::packed_func pack( + serial_obj["func_name"].GetString(), std::move(args)); - if (serial_obj.HasMember("err_mesg")) + if (serial_obj.HasMember("except_type")) { - pack.set_err_mesg(serial_obj["err_mesg"].GetString()); + pack.set_exception(serial_obj["err_mesg"].GetString(), + static_cast(serial_obj["except_type"].GetInt())); } return pack; @@ -315,69 +445,17 @@ packed_func pack_adapter::deserialize_p { const value_t& result = serial_obj["result"]; - if constexpr (std::is_same_v) - { - return packed_func( - serial_obj["func_name"].GetString(), result.GetString(), std::move(args)); - } - else if constexpr (rpc::details::is_container_v) - { - using subvalue_t = typename R::value_type; - R container; - container.reserve(result.Size()); - - unsigned j = 0; - - for (const auto& val : result.GetArray()) - { - container.push_back( - adapters::rapidjson::details::parse_arg(val, j)); - } - - return packed_func( - serial_obj["func_name"].GetString(), container, std::move(args)); - } - else if constexpr (std::is_arithmetic_v) - { - if constexpr (std::is_same_v || std::is_same_v || std::is_same_v) - { - return packed_func( - serial_obj["func_name"].GetString(), result.GetInt(), std::move(args)); - } - else if constexpr (std::is_same_v || std::is_same_v) - { - return packed_func( - serial_obj["func_name"].GetString(), result.GetUint(), std::move(args)); - } - else - { - return packed_func( - serial_obj["func_name"].GetString(), result.Get(), std::move(args)); - } - } - else if constexpr (rpc::details::is_serializable_v) - { - doc_t d; - d.CopyFrom(result, d.GetAllocator()); - return packed_func(serial_obj["func_name"].GetString(), - R::template deserialize(d), std::move(args)); - } - else - { - doc_t d; - d.CopyFrom(result, d.GetAllocator()); - return packed_func(serial_obj["func_name"].GetString(), - adapters::rapidjson_adapter::template deserialize(d), args); - } + return ::rpc::details::packed_func(serial_obj["func_name"].GetString(), + adapters::rapidjson::details::parse_arg(result), std::move(args)); } - packed_func pack( + ::rpc::details::packed_func pack( serial_obj["func_name"].GetString(), std::nullopt, std::move(args)); - if (serial_obj.HasMember("err_mesg")) + if (serial_obj.HasMember("except_type")) { - pack.set_err_mesg(serial_obj["err_mesg"].GetString()); + pack.set_exception(serial_obj["err_mesg"].GetString(), + static_cast(serial_obj["except_type"].GetInt())); } return pack; @@ -385,27 +463,28 @@ packed_func pack_adapter::deserialize_p } template<> -inline std::string pack_adapter::get_func_name( +[[nodiscard]] inline std::string pack_adapter::get_func_name( const adapters::rapidjson::doc_t& serial_obj) { return serial_obj["func_name"].GetString(); } template<> -inline void pack_adapter::set_err_mesg( - adapters::rapidjson::doc_t& serial_obj, const std::string& mesg) +inline void pack_adapter::set_exception( + adapters::rapidjson::doc_t& serial_obj, const rpc::exceptions::rpc_exception& ex) { auto& alloc = serial_obj.GetAllocator(); - if (serial_obj.HasMember("err_mesg")) + if (serial_obj.HasMember("except_type")) { - serial_obj["HasMember"].SetString(mesg.c_str(), alloc); + serial_obj["except_type"].SetInt(static_cast(ex.get_type())); + serial_obj["err_mesg"].SetString(ex.what(), alloc); } else { - adapters::rapidjson::value_t v; - v.SetString(mesg.c_str(), alloc); - serial_obj.AddMember("err_mesg", v, alloc); + serial_obj.AddMember("except_type", static_cast(ex.get_type()), alloc); + serial_obj.AddMember( + "err_mesg", adapters::rapidjson::value_t{}.SetString(ex.what(), alloc), alloc); } } } // namespace rpc diff --git a/include/rpc_dispatch_helper.hpp b/include/rpc_dispatch_helper.hpp index 558306dd..efd3c4a7 100644 --- a/include/rpc_dispatch_helper.hpp +++ b/include/rpc_dispatch_helper.hpp @@ -109,9 +109,9 @@ #endif #if defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL) -# define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) extern RETURN (*FUNCNAME)(__VA_ARGS__) +# define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) extern RETURN (* const FUNCNAME)(__VA_ARGS__) #elif defined(RPC_HPP_CLIENT_IMPL) -# define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) inline RETURN (*FUNCNAME)(__VA_ARGS__) = nullptr +# define RPC_HEADER_FUNC(RETURN, FUNCNAME, ...) inline RETURN (* const FUNCNAME)(__VA_ARGS__) = nullptr #endif #if defined(RPC_HPP_SERVER_IMPL) || defined(RPC_HPP_MODULE_IMPL) diff --git a/meson.build b/meson.build deleted file mode 100644 index d47b417b..00000000 --- a/meson.build +++ /dev/null @@ -1,136 +0,0 @@ -# BSD 3-Clause License -# -# Copyright (c) 2020-2021, Jackson Harmer -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, this -# list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -project('rpc.hpp', 'cpp', - version : '0.6.1', - license : 'BSD-3-Clause', - default_options : [ - 'cpp_std=c++17', - 'warning_level=3', - ], - meson_version : '>=0.50.0' -) - -cpp_compiler = meson.get_compiler('cpp').get_id() - -if cpp_compiler == 'gcc' - project_warnings = [ - '-Wall', - '-Wextra', - '-Wpedantic', - '-Wshadow', - '-Wnon-virtual-dtor', - '-Wold-style-cast', - '-Wcast-align', - '-Wunused', - '-Woverloaded-virtual', - '-Wconversion', - '-Wsign-conversion', - '-Wnull-dereference', - '-Wdouble-promotion', - '-Wformat=2', - '-Weffc++', - '-Wuseless-cast', - '-Wlogical-op', - '-Wduplicated-branches', - '-Wduplicated-cond', - '-Wmisleading-indentation' - ] -elif cpp_compiler == 'clang' - project_warnings = [ - '-Weverything', - '-Wno-c++98-compat', - '-Wno-c++98-compat-pedantic', - '-Wno-c++98-c++11-compat', - '-Wno-c++98-c++11-compat-binary-literal', - '-Wno-c++98-c++11-c++14-compat', - '-Wno-c++20-compat', - '-Wno-padded', - '-Wno-exit-time-destructors', - '-Wno-missing-prototypes', - '-Wno-documentation', - '-Wno-documentation-unknown-command', - '-Wno-weak-vtables', - '-Wno-reserved-id-macro' - ] -elif cpp_compiler == 'msvc' - project_warnings = [ - '/W4', - '/experimental:external', - '/external:W0', - '/external:anglebrackets', - '/permissive-', - '/wd4619', - '/w14242', - '/w14254', - '/w14263', - '/w14265', - '/w14287', - '/we4289', - '/w14296', - '/w14311', - '/w14545', - '/w14546', - '/w14547', - '/w14549', - '/w14555', - '/w14640', - '/w14826', - '/w14905', - '/w14906', - '/w14928', - '/we4834', - '/bigobj' - ] -endif - -include_dirs = include_directories('./include') -rpc_hpp_dep = declare_dependency(include_directories : include_dirs) -header_list = ['include/rpc.hpp', 'include/rpc_dispatch_helper.hpp'] -install_headers(header_list) - -if get_option('build_adapter_boost_json') or get_option('build_adapter_njson') or get_option('build_adapter_rapidjson') - subdir('include/rpc_adapters') -endif - -if get_option('build_examples') - subdir('examples') -endif - -if get_option('build_testing') - subdir('tests') -endif - -if get_option('build_benchmark') - if not get_option('build_testing') - error('Tests must be enabled for benchmarking!') - endif - subdir('benchmarks') -endif diff --git a/meson_options.txt b/meson_options.txt deleted file mode 100644 index e95f04fd..00000000 --- a/meson_options.txt +++ /dev/null @@ -1,7 +0,0 @@ -option('build_adapter_boost_json', type : 'boolean', value : false) -option('build_adapter_njson', type : 'boolean', value : false) -option('build_adapter_rapidjson', type : 'boolean', value : false) - -option('build_examples', type : 'boolean', value : false) -option('build_benchmark', type : 'boolean', value : false) -option('build_testing', type : 'boolean', value : false) diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index b0bb4337..3f3b5023 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -71,8 +71,9 @@ if(NOT TARGET asio_lib) endif() endif() -add_executable(rpc_test "rpc.test.cpp") +add_executable(rpc_test "test_client/rpc.test.cpp") target_link_libraries(rpc_test PRIVATE rpc_hpp doctest_lib asio_lib) +target_precompile_headers(rpc_test PRIVATE "test_client/pch.hpp") if(${BUILD_ADAPTER_BITSERY}) target_link_libraries(rpc_test PRIVATE bitsery_adapter) @@ -100,8 +101,9 @@ doctest_discover_tests(rpc_test ADD_LABELS 0) find_package(Threads REQUIRED) -add_executable(test_server "rpc.server.cpp") +add_executable(test_server "test_server/rpc.server.cpp") target_link_libraries(test_server PRIVATE rpc_hpp asio_lib Threads::Threads) +target_precompile_headers(test_server PRIVATE "test_server/pch.hpp") if(${BUILD_ADAPTER_BITSERY}) target_link_libraries(test_server PRIVATE bitsery_adapter) diff --git a/tests/meson.build b/tests/meson.build deleted file mode 100644 index 3385ecb8..00000000 --- a/tests/meson.build +++ /dev/null @@ -1,56 +0,0 @@ -# BSD 3-Clause License -# -# Copyright (c) 2020-2021, Jackson Harmer -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, this -# list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -asio_dep = dependency('asio') -doctest_dep = dependency('doctest', version : ['>=2.4']) -thread_dep = dependency('threads') - -test_dependencies = [rpc_hpp_dep, asio_dep, doctest_dep, thread_dep] -test_defines = [] - -if get_option('build_adapter_boost_json') - test_dependencies += [boost_json_adapter_dep] - test_defines += ['-DRPC_HPP_ENABLE_BOOST_JSON'] -endif - -if get_option('build_adapter_njson') - test_dependencies += [njson_adapter_dep] - test_defines += ['-DRPC_HPP_ENABLE_NJSON'] -endif - -if get_option('build_adapter_rapidjson') - test_dependencies += [rapidjson_adapter_dep] - test_defines += ['-DRPC_HPP_ENABLE_RAPIDJSON'] -endif - -rpc_test_exe = executable('rpc_test', 'rpc.test.cpp', dependencies : test_dependencies, install : false, cpp_args : [project_warnings, test_defines]) -test('rpc_test', rpc_test_exe) - -test_server_exe = executable('test_server', 'rpc.server.cpp', dependencies : test_dependencies, install : false, cpp_args : [project_warnings, test_defines]) diff --git a/tests/test_client/pch.hpp b/tests/test_client/pch.hpp new file mode 100644 index 00000000..f134bdc5 --- /dev/null +++ b/tests/test_client/pch.hpp @@ -0,0 +1,41 @@ +#pragma once + +// Standard Library +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +// 3rd Party +#include + +#if defined(RPC_HPP_ENABLE_BITSERY) +# include +# include +# include +# include +# include +# include +#endif + +#if defined(RPC_HPP_ENABLE_BOOST_JSON) +# include +#endif + +#if defined(RPC_HPP_ENABLE_NJSON) +# include +#endif + +#if defined(RPC_HPP_ENABLE_RAPIDJSON) +# include +# include +# include +#endif diff --git a/tests/rpc.client.hpp b/tests/test_client/rpc.client.hpp similarity index 83% rename from tests/rpc.client.hpp rename to tests/test_client/rpc.client.hpp index 3f12c688..7018739a 100644 --- a/tests/rpc.client.hpp +++ b/tests/test_client/rpc.client.hpp @@ -74,7 +74,11 @@ class TestClient final : public rpc::client_interface asio::connect(m_socket, m_resolver.resolve(host, port)); } - std::string getIP() const { return m_socket.remote_endpoint().address().to_string(); } + // nodiscard because string is being allocated for return + [[nodiscard]] std::string getIP() const + { + return m_socket.remote_endpoint().address().to_string(); + } private: void send(const typename Serial::bytes_t& mesg) override @@ -82,11 +86,17 @@ class TestClient final : public rpc::client_interface asio::write(m_socket, asio::buffer(mesg, mesg.size())); } + void send(typename Serial::bytes_t&& mesg) override + { + const auto sz = mesg.size(); + asio::write(m_socket, asio::buffer(std::move(mesg), sz)); + } + // nodiscard because data is lost after receive [[nodiscard]] typename Serial::bytes_t receive() override { - const auto numBytes = m_socket.read_some(asio::buffer(m_buffer, 64U * 1024UL)); - return typename Serial::bytes_t{ m_buffer, m_buffer + numBytes }; + const auto numBytes = m_socket.read_some(asio::buffer(m_buffer, 64UL * 1024UL)); + return typename Serial::bytes_t{ &m_buffer[0], &m_buffer[numBytes] }; } asio::io_context m_io{}; @@ -99,7 +109,7 @@ template TestClient& GetClient(); template<> -TestClient& GetClient() +[[nodiscard]] inline TestClient& GetClient() { static TestClient client("127.0.0.1", "5000"); return client; @@ -107,7 +117,7 @@ TestClient& GetClient() #if defined(RPC_HPP_ENABLE_RAPIDJSON) template<> -inline TestClient& GetClient() +[[nodiscard]] inline TestClient& GetClient() { static TestClient client("127.0.0.1", "5001"); return client; @@ -116,7 +126,7 @@ inline TestClient& GetClient() #if defined(RPC_HPP_ENABLE_BOOST_JSON) template<> -inline TestClient& GetClient() +[[nodiscard]] inline TestClient& GetClient() { static TestClient client("127.0.0.1", "5002"); return client; @@ -125,7 +135,7 @@ inline TestClient& GetClient() #if defined(RPC_HPP_ENABLE_BITSERY) template<> -inline TestClient& GetClient() +[[nodiscard]] inline TestClient& GetClient() { static TestClient client("127.0.0.1", "5003"); return client; diff --git a/tests/rpc.test.cpp b/tests/test_client/rpc.test.cpp similarity index 77% rename from tests/rpc.test.cpp rename to tests/test_client/rpc.test.cpp index 9a55e929..da6916c8 100644 --- a/tests/rpc.test.cpp +++ b/tests/test_client/rpc.test.cpp @@ -34,18 +34,18 @@ ///OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /// -#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN #define RPC_HPP_CLIENT_IMPL #include "rpc.client.hpp" -#include "static_funcs.hpp" -#include "test_structs.hpp" +#include "../static_funcs.hpp" +#include "../test_structs.hpp" +#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN #include #if defined(RPC_HPP_ENABLE_BITSERY) const uint64_t rpc::adapters::bitsery::config::max_func_name_size = 30; -const uint64_t rpc::adapters::bitsery::config::max_string_size = 2048U; +const uint64_t rpc::adapters::bitsery::config::max_string_size = 2048; const uint64_t rpc::adapters::bitsery::config::max_container_size = 100; #endif @@ -196,9 +196,10 @@ TEST_CASE_TEMPLATE("AddOneToEachRef", TestType, RPC_TEST_TYPES) TEST_CASE_TEMPLATE("Fibonacci", TestType, RPC_TEST_TYPES) { constexpr uint64_t expected = 10946; + constexpr uint64_t input = 20; auto& client = GetClient(); - const auto test = client.template call_func("Fibonacci", uint64_t{ 20 }); + const auto test = client.template call_func("Fibonacci", input); REQUIRE(expected == test); } @@ -266,12 +267,8 @@ TEST_CASE_TEMPLATE("HashComplex", TestType, RPC_TEST_TYPES) const std::string expected = "467365747274747d315a473a527073796c7e707b85"; auto& client = GetClient(); - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; + const ComplexObject cx{ 24, "Franklin D. Roosevelt", false, true, + { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 } }; const auto test = client.template call_func("HashComplex", cx); @@ -283,12 +280,8 @@ TEST_CASE_TEMPLATE("HashComplexRef", TestType, RPC_TEST_TYPES) const std::string expected = "467365747274747d315a473a527073796c7e707b85"; auto& client = GetClient(); - ComplexObject cx; - cx.flag1 = false; - cx.flag2 = true; - cx.id = 24; - cx.name = "Franklin D. Roosevelt"; - cx.vals = { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 }; + ComplexObject cx{ 24, "Franklin D. Roosevelt", false, true, + { 0, 1, 4, 6, 7, 8, 11, 15, 17, 22, 25, 26 } }; // initialize empty string to pass std::string test{}; @@ -303,36 +296,87 @@ TEST_CASE_TEMPLATE("Function not found", TestType, RPC_TEST_TYPES) { auto& client = GetClient(); - const auto exp = [&client]() + const auto exp = [&client] { - [[maybe_unused]] int _unused = client.template call_func("FUNC_WHICH_DOES_NOT_EXIST"); + std::ignore = client.template call_func("FUNC_WHICH_DOES_NOT_EXIST"); }; - REQUIRE_THROWS_WITH( - exp(), "RPC error: Called function: \"FUNC_WHICH_DOES_NOT_EXIST\" not found!"); + REQUIRE_THROWS_AS(exp(), rpc::exceptions::function_not_found); +} + +TEST_CASE_TEMPLATE("FunctionMismatch", TestType, RPC_TEST_TYPES) +{ + auto& client = GetClient(); + + const auto wrong_param = [&client] + { + std::ignore = client.template call_func("SimpleSum", 2, std::string{ "Hello, world" }); + }; + + const auto wrong_return = [&client] + { + std::ignore = client.template call_func("SimpleSum", 1, 2); + }; + + const auto float_to_int = [&client] + { + std::ignore = client.template call_func("SimpleSum", 2.4, 1.2); + }; + + const auto int_to_float = [&client] + { + std::ignore = client.template call_func("StdDev", -4, 125.325, 552.125, 55, 2599.6, + 1245.125663, 9783.49, 125.12, 553.3333333333, 2266.1); + }; + + const auto less_params = [&client] + { + std::ignore = client.template call_func("StdDev", -4.2, 125.325); + }; + + const auto more_params = [&client] + { + std::ignore = client.template call_func("StdDev", -4.2, 125.325, 552.125, 55.123, + 2599.6, 1245.125663, 9783.49, 125.12, 553.3333333333, 2266.1, 111.222, 1234.56789); + }; + + REQUIRE_THROWS_AS(wrong_param(), rpc::exceptions::function_mismatch); + REQUIRE_THROWS_AS(wrong_return(), rpc::exceptions::function_mismatch); + REQUIRE_THROWS_AS(float_to_int(), rpc::exceptions::function_mismatch); + REQUIRE_THROWS_AS(int_to_float(), rpc::exceptions::function_mismatch); + REQUIRE_THROWS_AS(less_params(), rpc::exceptions::function_mismatch); + REQUIRE_THROWS_AS(more_params(), rpc::exceptions::function_mismatch); } TEST_CASE_TEMPLATE("ThrowError", TestType, RPC_TEST_TYPES) { auto& client = GetClient(); - const auto exp = [&client]() + const auto exp = [&client] { - [[maybe_unused]] int _unused = client.template call_func("ThrowError"); + client.call_func("ThrowError"); }; - REQUIRE_THROWS_WITH(exp(), "THIS IS A TEST ERROR!"); + REQUIRE_THROWS_AS(exp(), rpc::exceptions::remote_exec_error); } TEST_CASE("KillServer") { auto& client = GetClient(); + const auto exp = [&client] + { + std::ignore = client.template call_func("SimpleSum", 1, 2); + }; + try { client.call_func("KillServer"); } catch (...) { + // Exception is expected so continue } + + REQUIRE_THROWS_AS(exp(), rpc::exceptions::client_receive_error); } diff --git a/tests/test_server/pch.hpp b/tests/test_server/pch.hpp new file mode 100644 index 00000000..4c8302ec --- /dev/null +++ b/tests/test_server/pch.hpp @@ -0,0 +1,51 @@ +#pragma once + +// Standard Library +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +// 3rd Party +#include + +#if defined(RPC_HPP_ENABLE_BITSERY) +# include +# include +# include +# include +# include +# include +#endif + +#if defined(RPC_HPP_ENABLE_BOOST_JSON) +# include +#endif + +#if defined(RPC_HPP_ENABLE_NJSON) +# include +#endif + +#if defined(RPC_HPP_ENABLE_RAPIDJSON) +# include +# include +# include +#endif diff --git a/tests/rpc.server.cpp b/tests/test_server/rpc.server.cpp similarity index 90% rename from tests/rpc.server.cpp rename to tests/test_server/rpc.server.cpp index fca63d5c..48d9ea19 100644 --- a/tests/rpc.server.cpp +++ b/tests/test_server/rpc.server.cpp @@ -63,24 +63,20 @@ using rpc::adapters::boost_json_adapter; using rpc::adapters::bitsery_adapter; const uint64_t rpc::adapters::bitsery::config::max_func_name_size = 30; -const uint64_t rpc::adapters::bitsery::config::max_string_size = 2048U; -const uint64_t rpc::adapters::bitsery::config::max_container_size = 100; +const uint64_t rpc::adapters::bitsery::config::max_string_size = 2048; +const uint64_t rpc::adapters::bitsery::config::max_container_size = 1'000; #endif #include #include -#include #include #include #include -#include #include #include #include -static bool RUNNING = false; -static std::mutex MUTEX; -static std::condition_variable cv; +std::atomic RUNNING{ false }; [[noreturn]] void ThrowError() noexcept(false) { @@ -88,22 +84,19 @@ static std::condition_variable cv; } // NOTE: This function is only for testing purposes. Obviously you would not want this in a production server! -inline void KillServer() noexcept +void KillServer() noexcept { - std::unique_lock lk{ MUTEX }; RUNNING = false; - lk.unlock(); - cv.notify_one(); } // cached -inline size_t StrLen(const std::string& str) +size_t StrLen(const std::string& str) { return str.size(); } // cached -inline std::vector AddOneToEach(std::vector vec) +std::vector AddOneToEach(std::vector vec) { for (auto& n : vec) { @@ -113,7 +106,7 @@ inline std::vector AddOneToEach(std::vector vec) return vec; } -inline void AddOneToEachRef(std::vector& vec) +void AddOneToEachRef(std::vector& vec) { for (auto& n : vec) { @@ -121,13 +114,13 @@ inline void AddOneToEachRef(std::vector& vec) } } -int (*CountChars)(const std::string&, char) = [](const std::string& str, char c) +int (*const CountChars)(const std::string&, char) = [](const std::string& str, char c) { return static_cast( std::count_if(str.begin(), str.end(), [c](const char x) { return x == c; })); }; -void (*AddOne)(size_t&) = [](size_t& n) +void (*const AddOne)(size_t&) = [](size_t& n) { n += 1; }; @@ -149,9 +142,8 @@ void FibonacciRef(uint64_t& number) } // cached -inline double StdDev(const double n1, const double n2, const double n3, const double n4, - const double n5, const double n6, const double n7, const double n8, const double n9, - const double n10) +double StdDev(const double n1, const double n2, const double n3, const double n4, const double n5, + const double n6, const double n7, const double n8, const double n9, const double n10) { const auto avg = Average( n1 * n1, n2 * n2, n3 * n3, n4 * n4, n5 * n5, n6 * n6, n7 * n7, n8 * n8, n9 * n9, n10 * n10); @@ -191,7 +183,6 @@ std::vector GenRandInts(const uint64_t min, const uint64_t max, const std::string HashComplex(const ComplexObject& cx) { std::stringstream hash; - auto values = cx.vals; if (cx.flag1) @@ -231,7 +222,6 @@ void dump_cache(TestServer& server, [[maybe_unused]] R (*func)(Args...), const std::string& func_name, const std::string& dump_dir) { auto& cache = server.template get_func_cache(func_name); - std::string file_name = func_name; std::replace(file_name.begin(), file_name.end(), '<', '('); @@ -266,7 +256,6 @@ void dump_cache(TestServer& server, [[maybe_unused]] R (*func)(Args...), } ss << *it << ']'; - ofile << key << '\034' << ss.str() << '\n'; } } @@ -277,7 +266,6 @@ void load_cache(TestServer& server, [[maybe_unused]] R (*func)(Args...), const std::string& func_name, const std::string& dump_dir) { auto& cache = server.template get_func_cache(func_name); - std::string file_name = func_name; std::replace(file_name.begin(), file_name.end(), '<', '('); @@ -307,7 +295,6 @@ void load_cache(TestServer& server, [[maybe_unused]] R (*func)(Args...), std::stringstream ss2(val_str); ss2 >> value; - cache[ss.str()] = value; } else if constexpr (std::is_same_v) @@ -354,9 +341,10 @@ int main(const int argc, char* argv[]) asio::io_context io_context{}; RUNNING = true; + std::vector threads; + #if defined(RPC_HPP_ENABLE_NJSON) TestServer njson_server{ io_context, 5000U }; - const std::string njson_dump_path("dump_cache"); if (std::filesystem::exists(njson_dump_path) @@ -374,30 +362,32 @@ int main(const int argc, char* argv[]) LOAD_CACHE(njson_server, CountChars, njson_dump_path); } - std::thread(&TestServer::Run, &njson_server).detach(); + threads.emplace_back(&TestServer::Run, &njson_server); std::cout << "Running njson server on port 5000...\n"; #endif #if defined(RPC_HPP_ENABLE_RAPIDJSON) TestServer rapidjson_server{ io_context, 5001U }; - std::thread(&TestServer::Run, &rapidjson_server).detach(); + threads.emplace_back(&TestServer::Run, &rapidjson_server); std::cout << "Running rapidjson server on port 5001...\n"; #endif #if defined(RPC_HPP_ENABLE_BOOST_JSON) TestServer bjson_server{ io_context, 5002U }; - std::thread(&TestServer::Run, &bjson_server).detach(); + threads.emplace_back(&TestServer::Run, &bjson_server); std::cout << "Running Boost.JSON server on port 5002...\n"; #endif #if defined(RPC_HPP_ENABLE_BITSERY) TestServer bitsery_server{ io_context, 5003U }; - std::thread(&TestServer::Run, &bitsery_server).detach(); + threads.emplace_back(&TestServer::Run, &bitsery_server); std::cout << "Running Bitsery server on port 5003...\n"; #endif - std::unique_lock lk{ MUTEX }; - cv.wait(lk, [] { return !RUNNING; }); + for (auto& th : threads) + { + th.join(); + } #if defined(RPC_HPP_ENABLE_NJSON) DUMP_CACHE(njson_server, SimpleSum, njson_dump_path); diff --git a/tests/rpc.server.hpp b/tests/test_server/rpc.server.hpp similarity index 79% rename from tests/rpc.server.hpp rename to tests/test_server/rpc.server.hpp index 06dba8e0..0bf515ae 100644 --- a/tests/rpc.server.hpp +++ b/tests/test_server/rpc.server.hpp @@ -36,13 +36,14 @@ #pragma once -#include "static_funcs.hpp" -#include "test_structs.hpp" +#include "../static_funcs.hpp" +#include "../test_structs.hpp" #include #include #include +#include #include #include #include @@ -55,6 +56,8 @@ using asio::ip::tcp; +extern std::atomic RUNNING; + // Forward declares [[noreturn]] void ThrowError() noexcept(false); void KillServer() noexcept; @@ -112,9 +115,9 @@ class TestServer final : public rpc::server_interface { } - [[noreturn]] void Run() + void Run() { - while (true) + while (RUNNING) { tcp::socket sock = m_accept.accept(); constexpr auto BUFFER_SZ = 64U * 1024UL; @@ -122,26 +125,11 @@ class TestServer final : public rpc::server_interface try { - while (true) + while (RUNNING) { asio::error_code error; const size_t len = sock.read_some(asio::buffer(data.get(), BUFFER_SZ), error); -#ifndef NDEBUG - if constexpr (std::is_same_v>) - { - std::cout << "Received bytes: ["; - - for (size_t i = 0; i < len; ++i) - { - std::cout << std::hex << std::setw(2) << std::setfill('0') - << static_cast(data[i]) << ' '; - } - - std::cout << "]\n"; - } -#endif - if (error == asio::error::eof) { break; @@ -153,24 +141,9 @@ class TestServer final : public rpc::server_interface throw asio::system_error(error); } - typename Serial::bytes_t bytes{ data.get(), data.get() + len }; + typename Serial::bytes_t bytes{ &data[0], &data[len] }; this->dispatch(bytes); -#ifndef NDEBUG - if constexpr (std::is_same_v>) - { - std::cout << "Return bytes: ["; - - for (const auto b : bytes) - { - std::cout << "0x" << std::hex << std::setw(2) << std::setfill('0') - << static_cast(b) << ' '; - } - - std::cout << "]\n"; - } -#endif - write(sock, asio::buffer(bytes, bytes.size())); } } @@ -192,7 +165,9 @@ class TestServer final : public rpc::server_interface RPC_ATTACH_CACHED_FUNCS(SimpleSum, StrLen, AddOneToEach, Fibonacci, Average, StdDev, AverageContainer, AverageContainer, HashComplex, CountChars) - throw std::runtime_error("RPC error: Called function: \"" + func_name + "\" not found!"); + throw rpc::exceptions::rpc_exception( + "RPC error: Called function: \"" + func_name + "\" not found!", + rpc::exceptions::Type::FuncNotFound); } tcp::acceptor m_accept; diff --git a/tests/test_structs.hpp b/tests/test_structs.hpp index 86a47ecc..ddccb8fb 100644 --- a/tests/test_structs.hpp +++ b/tests/test_structs.hpp @@ -165,9 +165,9 @@ inline ComplexObject njson_adapter::deserialize(const adapters::njson::njson_t& cx.flag2 = serial_obj["flag2"].get(); const auto& vals = serial_obj["vals"]; - if (vals.size() > 12) + if (vals.size() > cx.vals.size()) { - std::copy_n(vals.begin(), 12, cx.vals.begin()); + std::copy_n(vals.begin(), cx.vals.size(), cx.vals.begin()); } else { @@ -206,9 +206,9 @@ inline rpc::adapters::rapidjson::doc_t rapidjson_adapter::serialize(const Comple adapters::rapidjson::value_t vals_v; vals_v.SetArray(); - for (uint8_t i = 0; i < 12; ++i) + for (const auto byte : val.vals) { - vals_v.PushBack(val.vals[i], alloc); + vals_v.PushBack(byte, alloc); } d.AddMember("vals", vals_v, alloc); @@ -236,7 +236,9 @@ inline ComplexObject rapidjson_adapter::deserialize(const adapters::rapidjson::d const auto vals_v = serial_obj.FindMember("vals"); const auto& arr = vals_v->value.GetArray(); - for (unsigned i = 0; i < 12; ++i) + assert(arr.Size() == obj.vals.size()); + + for (unsigned i = 0; i < obj.vals.size(); ++i) { obj.vals[i] = static_cast(arr[i].GetUint()); }