TsgcWSPServer_sgcメソッド › RPCError

RPCError メソッド

保留中の RPC リクエストに JSON-RPC エラーオブジェクトで返答します。

構文

procedure RPCError(aID: String; aCode: Integer; aMessage: String; aData: String = '');

パラメータ

名前タイプ説明
aIDStringOnRPC によって最初に受信されたRPCリクエストのID。呼び出し元クライアントに返信をルーティングするために使用します。
aCodeIntegerJSON-RPC エラーコード(例:メソッドが見つからない場合は -32601、またはアプリケーション定義の負のコード)。
aMessageStringerror.message フィールドに格納される人間が読めるエラーメッセージ。
aDataStringerror.dataフィールドに配置されるオプションの実装定義ペイロード。省略するには空のままにします。

解説

OnRPC ハンドラーからリクエストされたメソッドを実行できない場合に呼び出します。サーバーは aID を発行した接続を検索し、保留中のメソッドトラッカーを削除して、JSON-RPC 2.0 エラー返信を送信します。クライアントはそれを OnRPCError イベントを通じて表面化させます。

使用例

oProtocol.RPCError(aID, -32602, 'Invalid params', 'missing "amount"');

メソッドに戻る