Class Index | File Index

Classes


Class MiMicJS.Rpc


Defined in: MiMicCore.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
MiMicJS.Rpc(i_event)
MiMicRPCのクライアントクラスです。 通信APIを提供します。
Method Summary
Method Attributes Method Name and Description
 
接続中のRPCコネクションを閉じます。 関数が終了するとonCloseイベントをコールバックします。
 
open(i_url)
RPCコネクションを開きます。 関数が終了するとonOpenイベントをコールバックします。
 
sendMethod(i_method, i_params, i_callback)
非同期でJSON RPCメソッドを送信します。
 
RPC回線を確実に閉じます。 この関数を実行すると、すべてのコールバックイベントはキャンセルされます。
Class Detail
MiMicJS.Rpc(i_event)
MiMicRPCのクライアントクラスです。 通信APIを提供します。
Parameters:
{HashMap} i_event
非同期イベントハンドラの連想配列です。登録できるメンバは以下の通りです。
  • onOpen:function() - open関数のコールバック関数です。
  • onClose:function() - close関数のコールバック関数です。
  • onError:function() - 何らかの異常で通信を継続できないエラーが発生し、コネクションを維持できない時に発生します。 このイベントが発生するとコネクションは閉じられます。
Method Detail
close()
接続中のRPCコネクションを閉じます。 関数が終了するとonCloseイベントをコールバックします。

open(i_url)
RPCコネクションを開きます。 関数が終了するとonOpenイベントをコールバックします。
Parameters:
i_url
ws://から始まるWebsocketサービスURLを指定します。

{int} sendMethod(i_method, i_params, i_callback)
非同期でJSON RPCメソッドを送信します。
Parameters:
{string} i_method
RPCメソッドの名前です。
{string} i_params
カンマ区切りのJSONスタイルの文字列です。この文字列は[....]に埋め込まれます。エスケープ文字列は使用できません。
{function(json)} i_callback
Resultを受け取るコールバック関数です。jsonにはResult JSONをパースしたオブジェクトが入ります。
Returns:
{int} メソッドIDを返します。

shutdown()
RPC回線を確実に閉じます。 この関数を実行すると、すべてのコールバックイベントはキャンセルされます。

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Sep 12 2014 09:40:44 GMT+0900 (JST)