JSON RPC
JSON-RPC 2.0 library for C++
dispatcher_p.h
Go to the documentation of this file.
1#ifndef FB656817_7041_48D5_80B2_347168163158
2#define FB656817_7041_48D5_80B2_347168163158
3
4/**
5 * @file
6 * @brief Contains the private implementation details of the JSON RPC dispatcher class.
7 * @internal
8 */
9
10#include <atomic>
11#include <string>
12#include <unordered_map>
13#include <utility>
14
15#include "dispatcher.h"
16
17namespace wwa::json_rpc {
18
19/**
20 * @brief Private implementation of the JSON RPC dispatcher class.
21 * @internal
22 *
23 * This class contains the private members and methods used by the `dispatcher` class to manage method handlers.
24 */
26public:
27 /**
28 * @brief Adds a method handler.
29 *
30 * @param method The name of the method.
31 * @param handler The handler function.
32 *
33 * @details This method registers a handler function for a given method name.
34 * The handler function will be invoked when a request for the specified method is received.
35 */
36 void add_handler(std::string&& method, dispatcher::handler_t&& handler)
37 {
38 this->m_methods.try_emplace(std::move(method), std::move(handler));
39 }
40
41 /**
42 * @brief Finds a method handler.
43 *
44 * @param method The name of the method.
45 * @return The handler function for the specified method.
46 * @retval nullptr Handler not found
47 *
48 * @details This method returns the handler function for the specified method name.
49 * If no handler is found, it returns a null pointer.
50 */
51 dispatcher::handler_t find_handler(const std::string& method) const
52 {
53 if (const auto it = this->m_methods.find(method); it != this->m_methods.end()) {
54 return it->second;
55 }
56
57 return nullptr;
58 }
59
60 /**
61 * @brief Generates a unique request ID.
62 *
63 * @return A unique request ID.
64 *
65 * @details This method generates a unique request ID by incrementing an atomic counter.
66 */
67 static std::uint64_t get_and_increment_counter() noexcept
68 {
69 return dispatcher_private::m_id_counter.fetch_add(1, std::memory_order_relaxed);
70 }
71
72private:
73 /** @brief Map of method names to handler functions. */
75
76 static inline std::atomic_uint64_t m_id_counter = 0; ///< Counter for generating unique request IDs.
77};
78
79} // namespace wwa::json_rpc
80
81#endif /* FB656817_7041_48D5_80B2_347168163158 */
Private implementation of the JSON RPC dispatcher class.
static std::uint64_t get_and_increment_counter() noexcept
Generates a unique request ID.
std::unordered_map< std::string, dispatcher::handler_t > m_methods
Map of method names to handler functions.
void add_handler(std::string &&method, dispatcher::handler_t &&handler)
Adds a method handler.
dispatcher::handler_t find_handler(const std::string &method) const
Finds a method handler.
static std::atomic_uint64_t m_id_counter
Counter for generating unique request IDs.
A class that manages JSON RPC method handlers and processes JSON RPC requests.
Definition dispatcher.h:77
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.
dispatcher & operator=(dispatcher &&rhs)=default
Move assignment operator.
dispatcher(dispatcher &&rhs)=default
Move constructor.
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
constexpr auto create_closure(C inst, F &&f) const
Creates a closure for invoking a member function with JSON parameters.
Definition dispatcher.h:453
virtual void request_parsed(const jsonrpc_request &request, const std::any &data, std::uint64_t unique_id)
Invoked after the request has been parsed.
void add_internal_method(std::string_view method, handler_t &&handler)
Adds a method handler for the specified method.
nlohmann::json process_request(const nlohmann::json &request, const std::any &data={})
Processes a JSON RPC request.
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.
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.
void add(std::string_view method, F &&f)
Adds a method handler f for the method method.
Definition dispatcher.h:203
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
virtual nlohmann::json process_batch_request(const nlohmann::json &request, const std::any &data, std::uint64_t unique_id)
Processes a batch request.
dispatcher()
Class constructor.
dispatcher(const dispatcher &)=delete
dispatcher & operator=(const dispatcher &)=delete
virtual ~dispatcher()
Class destructor.
void add_ex(std::string_view method, F &&f)
Adds a method handler with a context parameter.
Definition dispatcher.h:263
std::unique_ptr< dispatcher_private > d_ptr
Pointer to the implementation (Pimpl idiom).
Definition dispatcher.h:411
JSON RPC Exception class.
Definition exception.h:86
exception(const exception &)=default
Default copy constructor.
~exception() override
Default destructor.
nlohmann::json m_data
Custom data associated with the error.
Definition exception.h:231
std::string m_message
Error message.
Definition exception.h:230
int code() const noexcept
Returns the error code.
Definition exception.h:183
const std::string & message() const noexcept
Returns the error message.
Definition exception.h:190
exception(exception &&)=default
Default move constructor.
exception(int code, std::string_view message)
Construct a new exception object.
Definition exception.h:145
exception & operator=(const exception &rhs)=default
Default copy assignment operator.
const nlohmann::json & data() const noexcept
Returns custom data associated with the error.
Definition exception.h:197
exception & operator=(exception &&rhs)=default
Default move assignment operator.
const char * what() const noexcept override
Returns the error message.
Definition exception.h:207
nlohmann::json to_json() const
Returns the error message as an Error Object.
Definition exception.h:215
exception(int code, std::string_view message, const T &data)
Construct a new exception object with additional data.
Definition exception.h:134
int m_code
Error code.
Definition exception.h:232
Exception thrown when the method is not found.
Definition exception.h:238
method_not_found_exception(method_not_found_exception &&)=default
method_not_found_exception & operator=(method_not_found_exception &&)=default
method_not_found_exception & operator=(const method_not_found_exception &)=default
~method_not_found_exception() override
Default destructor.
method_not_found_exception(const method_not_found_exception &)=default
#define WWA_JSONRPC_EXPORT
Macro for exporting symbols when building the library dynamically or importing symbols when using the...
Definition export.h:42
static constexpr int INVALID_PARAMS
Invalid method parameter(s).
Definition exception.h:115
static constexpr int INTERNAL_ERROR
Internal JSON-RPC error.
Definition exception.h:120
static constexpr int METHOD_NOT_FOUND
The method does not exist or is not available.
Definition exception.h:110
static constexpr int INVALID_REQUEST
The JSON sent is not a valid Request object.
Definition exception.h:105
static constexpr int PARSE_ERROR
Invalid JSON was received by the server.
Definition exception.h:100
static constexpr std::string_view err_method_not_found
Error message for when the method is not found.
Definition exception.h:50
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
static constexpr std::string_view err_empty_batch
Error message for when the batch request is empty.
Definition exception.h:77
static constexpr std::string_view err_empty_method
Error message for when the method is empty.
Definition exception.h:56
static constexpr std::string_view err_bad_request
Error request for when the request is not valid.
Definition exception.h:38
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
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
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
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
Contains the implementation details of the JSON RPC library.
Definition details.h:31
Represents a JSON RPC request.
Definition request.h:22