JSON-RPCのリクエストを表すクラスです。
[詳解]
#include "nn/nlib/msgpack/jsonrpc/JsonRpcRequest.h"
JSON-RPCのリクエストを表すクラスです。
- 説明
- JSON-RPCのRPC呼び出しは、JSONで記述されたリクエストをサーバーに送信することで行われます。 JSON-RPCのリクエストは、次の4つのキーを含むJSONの連想配列です。
- jsonrpc:
- 値には"2.0"という文字列が入ります。
- method:
- 値は文字列で、リモートで呼び出す関数名が設定されます。
- params:
- リモートで呼び出す関数に渡されるパラメータです。
- id:
JsonRpcClient::GenerateId()
で作成された32bitの正の整数が指定されます。 サーバーはリクエストに対するレスポンスに同じid
をつけて関連付けます。
もしidがリクエストに含まれない場合は、そのリクエストはnotification(サーバーはリクエストに返信しない)です。
JsonRpcRequest.h の 30 行目に定義があります。
§ GetId()
nn::nlib::msgpack::jsonrpc::JsonRpcRequest::GetId |
( |
| ) |
const |
|
inlinenoexcept |
このリクエストのid
を取得します。0の場合はリクエストはnotificationとなります。
- 戻り値
- JSON-RPCリクエストの
id
JsonRpcRequest.h の 36 行目に定義があります。
§ GetMethod()
nn::nlib::msgpack::jsonrpc::JsonRpcRequest::GetMethod |
( |
| ) |
const |
|
inlinenoexcept |
§ GetParams() [1/2]
nn::nlib::msgpack::jsonrpc::JsonRpcRequest::GetParams |
( |
| ) |
const |
|
inlinenoexcept |
§ GetParams() [2/2]
nn::nlib::msgpack::jsonrpc::JsonRpcRequest::GetParams |
( |
| ) |
|
|
inlinenoexcept |
§ MoveParamsFrom()
nn::nlib::msgpack::jsonrpc::JsonRpcRequest::MoveParamsFrom |
( |
MpObject & |
params | ) |
|
|
inlinenoexcept |
§ SetId()
nn::nlib::msgpack::jsonrpc::JsonRpcRequest::SetId |
( |
reqid_t |
id | ) |
|
|
inlinenoexcept |
§ SetMethod()
nn::nlib::msgpack::jsonrpc::JsonRpcRequest::SetMethod |
( |
const char * |
method | ) |
|
|
noexcept |
リクエストのメソッド名を設定します。
- 引数
-
- 戻り値
- 成功した場合は
true
- 説明
- メソッド名の文字列はコピーされます。 その際の動的メモリ確保に失敗した場合は
false
を返します。
このクラス詳解は次のファイルから抽出されました: