JSON RPC
JSON-RPC 2.0 library for C++
export.h
Go to the documentation of this file.
1#ifndef E66C1505_D447_4384_BB35_55B23FF31F0A
2#define E66C1505_D447_4384_BB35_55B23FF31F0A
3
4/**
5 * @file
6 * @brief Defines macros for exporting and importing symbols in the JSON RPC library.
7 *
8 * This file contains macros that control the visibility of symbols in the JSON RPC library.
9 * It handles the differences between static and dynamic linking, as well as platform-specific
10 * visibility attributes for Windows and Unix-like systems.
11 */
12
13/**
14 * @def WWA_JSONRPC_EXPORT
15 * @brief Macro for exporting symbols when building the library dynamically or importing symbols when using the library dynamically.
16 */
17
18/**
19 * @def WWA_JSONRPC_NO_EXPORT
20 * @brief Macro for hiding symbols.
21 */
22
23#ifdef WWA_JSONRPC_STATIC_DEFINE
24# define WWA_JSONRPC_EXPORT
25# define WWA_JSONRPC_NO_EXPORT
26#else
27# ifdef wwa_jsonrpc_EXPORTS
28/* We are building this library; export */
29# if defined _WIN32 || defined __CYGWIN__
30# define WWA_JSONRPC_EXPORT __declspec(dllexport)
31# define WWA_JSONRPC_NO_EXPORT
32# else
33# define WWA_JSONRPC_EXPORT [[gnu::visibility("default")]]
34# define WWA_JSONRPC_NO_EXPORT [[gnu::visibility("hidden")]]
35# endif
36# else
37/* We are using this library; import */
38# if defined _WIN32 || defined __CYGWIN__
39# define WWA_JSONRPC_EXPORT __declspec(dllimport)
40# define WWA_JSONRPC_NO_EXPORT
41# else
42# define WWA_JSONRPC_EXPORT [[gnu::visibility("default")]]
43# define WWA_JSONRPC_NO_EXPORT [[gnu::visibility("hidden")]]
44# endif
45# endif
46#endif
47
48#endif /* E66C1505_D447_4384_BB35_55B23FF31F0A */
wwa::json_rpc::dispatcher_private
Private implementation of the JSON RPC dispatcher class.
Definition dispatcher_p.h:25
wwa::json_rpc::dispatcher_private::get_and_increment_counter
static std::uint64_t get_and_increment_counter() noexcept
Generates a unique request ID.
Definition dispatcher_p.h:67
wwa::json_rpc::dispatcher
A class that manages JSON RPC method handlers and processes JSON RPC requests.
Definition dispatcher.h:77
wwa::json_rpc::dispatcher::do_process_request
virtual nlohmann::json do_process_request(const nlohmann::json &request, const std::any &data, bool is_batch, std::uint64_t unique_id)
Processes a single, non-batch JSON RPC request.
Definition dispatcher.cpp:34
wwa::json_rpc::dispatcher::operator=
dispatcher & operator=(dispatcher &&rhs)=default
Move assignment operator.
wwa::json_rpc::dispatcher::dispatcher
dispatcher(dispatcher &&rhs)=default
Move constructor.
wwa::json_rpc::dispatcher::add_ex
void add_ex(std::string_view method, F &&f, C instance)
Adds a method handler with a context parameter and a class instance.
Definition dispatcher.h:286
wwa::json_rpc::dispatcher::create_closure
constexpr auto create_closure(C inst, F &&f) const
Creates a closure for invoking a member function with JSON parameters.
Definition dispatcher.h:453
wwa::json_rpc::dispatcher::request_parsed
virtual void request_parsed(const jsonrpc_request &request, const std::any &data, std::uint64_t unique_id)
Invoked after the request has been parsed.
Definition dispatcher.cpp:95
wwa::json_rpc::dispatcher::add_internal_method
void add_internal_method(std::string_view method, handler_t &&handler)
Adds a method handler for the specified method.
Definition dispatcher.cpp:18
wwa::json_rpc::dispatcher::process_request
nlohmann::json process_request(const nlohmann::json &request, const std::any &data={})
Processes a JSON RPC request.
Definition dispatcher.cpp:23
wwa::json_rpc::dispatcher::request_failed
virtual void request_failed(const nlohmann::json &request_id, const std::exception *e, bool is_batch, std::uint64_t unique_id)
Invoked when a request fails.
Definition dispatcher.cpp:111
wwa::json_rpc::dispatcher::invoke
virtual nlohmann::json invoke(const std::string &method, const nlohmann::json &params, const dispatcher::context_t &ctx, std::uint64_t unique_id)
Invokes a method handler.
Definition dispatcher.cpp:100
wwa::json_rpc::dispatcher::add
void add(std::string_view method, F &&f)
Adds a method handler f for the method method.
Definition dispatcher.h:203
wwa::json_rpc::dispatcher::add
void add(std::string_view method, F &&f, C instance)
Adds a method to the dispatcher with the specified instance and function.
Definition dispatcher.h:221
wwa::json_rpc::dispatcher::process_batch_request
virtual nlohmann::json process_batch_request(const nlohmann::json &request, const std::any &data, std::uint64_t unique_id)
Processes a batch request.
Definition dispatcher.cpp:68
wwa::json_rpc::dispatcher::dispatcher
dispatcher()
Class constructor.
Definition dispatcher.cpp:14
wwa::json_rpc::dispatcher::dispatcher
dispatcher(const dispatcher &)=delete
wwa::json_rpc::dispatcher::operator=
dispatcher & operator=(const dispatcher &)=delete
wwa::json_rpc::dispatcher::~dispatcher
virtual ~dispatcher()
Class destructor.
wwa::json_rpc::dispatcher::add_ex
void add_ex(std::string_view method, F &&f)
Adds a method handler with a context parameter.
Definition dispatcher.h:263
wwa::json_rpc::dispatcher::d_ptr
std::unique_ptr< dispatcher_private > d_ptr
Pointer to the implementation (Pimpl idiom).
Definition dispatcher.h:411
wwa::json_rpc::exception
JSON RPC Exception class.
Definition exception.h:86
wwa::json_rpc::exception::exception
exception(const exception &)=default
Default copy constructor.
wwa::json_rpc::exception::~exception
~exception() override
Default destructor.
wwa::json_rpc::exception::m_data
nlohmann::json m_data
Custom data associated with the error.
Definition exception.h:231
wwa::json_rpc::exception::m_message
std::string m_message
Error message.
Definition exception.h:230
wwa::json_rpc::exception::code
int code() const noexcept
Returns the error code.
Definition exception.h:183
wwa::json_rpc::exception::message
const std::string & message() const noexcept
Returns the error message.
Definition exception.h:190
wwa::json_rpc::exception::exception
exception(exception &&)=default
Default move constructor.
wwa::json_rpc::exception::exception
exception(int code, std::string_view message)
Construct a new exception object.
Definition exception.h:145
wwa::json_rpc::exception::operator=
exception & operator=(const exception &rhs)=default
Default copy assignment operator.
wwa::json_rpc::exception::data
const nlohmann::json & data() const noexcept
Returns custom data associated with the error.
Definition exception.h:197
wwa::json_rpc::exception::operator=
exception & operator=(exception &&rhs)=default
Default move assignment operator.
wwa::json_rpc::exception::what
const char * what() const noexcept override
Returns the error message.
Definition exception.h:207
wwa::json_rpc::exception::to_json
nlohmann::json to_json() const
Returns the error message as an Error Object.
Definition exception.h:215
wwa::json_rpc::exception::exception
exception(int code, std::string_view message, const T &data)
Construct a new exception object with additional data.
Definition exception.h:134
wwa::json_rpc::exception::m_code
int m_code
Error code.
Definition exception.h:232
wwa::json_rpc::method_not_found_exception
Exception thrown when the method is not found.
Definition exception.h:238
wwa::json_rpc::method_not_found_exception::method_not_found_exception
method_not_found_exception(method_not_found_exception &&)=default
wwa::json_rpc::method_not_found_exception::operator=
method_not_found_exception & operator=(method_not_found_exception &&)=default
wwa::json_rpc::method_not_found_exception::operator=
method_not_found_exception & operator=(const method_not_found_exception &)=default
wwa::json_rpc::method_not_found_exception::~method_not_found_exception
~method_not_found_exception() override
Default destructor.
wwa::json_rpc::method_not_found_exception::method_not_found_exception
method_not_found_exception()
Definition exception.h:240
wwa::json_rpc::method_not_found_exception::method_not_found_exception
method_not_found_exception(const method_not_found_exception &)=default
WWA_JSONRPC_EXPORT
#define WWA_JSONRPC_EXPORT
Macro for exporting symbols when building the library dynamically or importing symbols when using the...
Definition export.h:42
wwa::json_rpc::exception::INVALID_PARAMS
static constexpr int INVALID_PARAMS
Invalid method parameter(s).
Definition exception.h:115
wwa::json_rpc::exception::INTERNAL_ERROR
static constexpr int INTERNAL_ERROR
Internal JSON-RPC error.
Definition exception.h:120
wwa::json_rpc::exception::METHOD_NOT_FOUND
static constexpr int METHOD_NOT_FOUND
The method does not exist or is not available.
Definition exception.h:110
wwa::json_rpc::exception::INVALID_REQUEST
static constexpr int INVALID_REQUEST
The JSON sent is not a valid Request object.
Definition exception.h:105
wwa::json_rpc::exception::PARSE_ERROR
static constexpr int PARSE_ERROR
Invalid JSON was received by the server.
Definition exception.h:100
wwa::json_rpc::err_method_not_found
static constexpr std::string_view err_method_not_found
Error message for when the method is not found.
Definition exception.h:50
wwa::json_rpc::err_not_jsonrpc_2_0_request
static constexpr std::string_view err_not_jsonrpc_2_0_request
Error message for when the request is not a JSON-RPC 2.0 request.
Definition exception.h:31
wwa::json_rpc::err_empty_batch
static constexpr std::string_view err_empty_batch
Error message for when the batch request is empty.
Definition exception.h:77
wwa::json_rpc::err_empty_method
static constexpr std::string_view err_empty_method
Error message for when the method is empty.
Definition exception.h:56
wwa::json_rpc::err_bad_request
static constexpr std::string_view err_bad_request
Error request for when the request is not valid.
Definition exception.h:38
wwa::json_rpc::err_bad_params_type
static constexpr std::string_view err_bad_params_type
Error message for when the parameters are not an array or an object.
Definition exception.h:62
wwa::json_rpc::err_invalid_params_passed_to_method
static constexpr std::string_view err_invalid_params_passed_to_method
Error message for when the parameters passed to the method are not correct.
Definition exception.h:44
wwa::json_rpc::err_bad_id_type
static constexpr std::string_view err_bad_id_type
Error message for when the ID is not a number, a string, or null.
Definition exception.h:70
wwa::json_rpc::details::convert_args
constexpr auto convert_args(const nlohmann::json &params, std::index_sequence< Indices... >)
Converts JSON parameters to a tuple of arguments based on the specified types.
Definition details.h:335
wwa::json_rpc::details
Contains the implementation details of the JSON RPC library.
Definition details.h:31
wwa::json_rpc::jsonrpc_request
Represents a JSON RPC request.
Definition request.h:22
Generated by doxygen 1.13.2