protorpc.remote
パッケージは、次の関数を提供します。
- is_error_status(status)
-
RPC ステータスがエラーかどうかを判断します。
引数- status
- エラーの有無を確認するために初期化された RpcStatus メッセージです。
- check_rpc_status(status)
-
エラー ステータスを送出する例外に変換します。
引数- status
- エラーの有無を確認するために初期化された RpcStatus メッセージです。
status
の状態がエラーの場合は、RpcError が発生します。 - method(request_type=message_types.VoidMessage, response_type=message_types.VoidMessage)
-
メソッドをリモートにするためにメソッドを修飾します。
引数- request_type=message_types.VoidMessage
- 想定されるリクエストのメッセージの種類です。
- response_type=message_types.VoidMessage
- 想定されるレスポンスのメッセージの種類です。
修飾されたリモート メソッドを返します。リモート メソッドには、次のプロパティを持つ
remote
属性が含まれます。- メソッド
- 元の未修飾メソッドです。
- request_type
- 想定されるリクエストのメッセージの種類です。
- response_type
- 想定されるレスポンスのメッセージの種類です。
request_type
やresponse_type
パラメータが messages.Message の適切なサブクラスではない場合は、TypeError が発生します。 - get_remote_method(method)
-
リモート メソッドの場合は、リモート メソッド情報オブジェクトを返します。それ以外の場合は None を返します。
引数- メソッド
- 取得するメソッドです。