(function(){\r
var NS=MiMicJS;\r
/**\r
- * @name MiMicJS#VERSION\r
* MiMicJsAPIのバージョン文字列。\r
+ * @name MiMicJS#VERSION\r
*/\r
NS.VERSION="MiMicJsAPI/2.0.0";\r
/**\r
+ * 配列要素、又は値がすべてInt値でない場合に例外を起こします。\r
* @name MiMicJS.assertInt\r
* @function\r
- * 配列要素、又は値がすべてInt値でない場合に例外を起こします。\r
* @params {[array]} v\r
* テストする配列\r
*/\r
}\r
}\r
/**\r
+ * 配列要素、、又は値がすべて数値でない場合に例外を起こします。\r
* @name MiMicJS.assertNumber\r
* @function\r
- * 配列要素、、又は値がすべて数値でない場合に例外を起こします。\r
* @params {[array]} v\r
* テストする配列\r
*/\r
}\r
};\r
/**\r
- * @private\r
* 数値であるかを確認します。\r
+ * @private\r
*/\r
NS.isNumber=function isNumber(o)\r
{\r
return (typeof o=='number');\r
};\r
/**\r
- * @private\r
* 整数であるかを確認します。\r
+ * @private\r
*/\r
NS.isInt=function isInt(o)\r
{\r
* <tr><td>7-0</td><td>ErrorID</td><td></td></tr>\r
* </table>\r
* @namespace\r
+ * @name MiMicJS.Error\r
* @example\r
* throw new MiMicException(MiMicError.NG);\r
*/\r
NS.Error=\r
{\r
- /** 成功を示すエラー値\r
- * @constant*/ \r
+ /** 成功を示します。\r
+ * @constant\r
+ * @name MiMicJS.Error.OK\r
+ */\r
OK:[0x00000000,"OK"],\r
- /** 失敗を示すエラー値。不明な場所で、不明な何かが、不明なエラーを起こしたことを示す。\r
- * @constant*/ \r
+ /** 詳細情報の無いエラーです。\r
+ * @constant\r
+ * @name MiMicJS.Error.NG\r
+ */ \r
NG:[0x40000000,"NG"],\r
+ /** Generatorを用いたコードで、前回のyieldが終了していないことを示します。\r
+ * @constant\r
+ * @name MiMicJS.Error.NG_YIELD_NOT_COMPLETED\r
+ */\r
NG_YIELD_NOT_COMPLETED:[0x40001001,"The previous function has not been completed."],\r
+ /** 関数の呼び出し順序が正しくないことを示します。\r
+ * @constant\r
+ * @name MiMicJS.Error.NG_ILLEGAL_CALL\r
+ */\r
NG_ILLEGAL_CALL:[0x40001002,"Illegal procedure call."],\r
+ /** 引数型の不一致を検出したことを示します。\r
+ * @constant\r
+ * @name MiMicJS.Error.NG_INVALID_ARG\r
+ */\r
NG_INVALID_ARG:[0x40001003,"Invalid arguments."],\r
/**\r
* エラーコードがOKか調べる。\r
* @function\r
+ * @name MiMicJS.Error.isOK\r
* @param {Object as [MiMicErrorCode]} v\r
* 評価するオブジェクト\r
* @return {Boolean}\r
var NS=MiMicJS; \r
/**\r
* 引数が1個のパターン。\r
- * @name MiMicException.2\r
+ * @name MiMicJS.MiMicException.2\r
* @function\r
* @param {object} e\r
* eのクラスにより、動作が異なる。\r
* スタックトレースは改行で連結された文字列である。messageプロパティに格納される。alert関数で表示することで、効率的なデバックが可能である。\r
* 引数の違いにより、数種類の呼び出し方がある。\r
* @constructor\r
+ * @name MiMicJS.MiMicException\r
* @param ...\r
* 詳細は、MiMicException.nを参照。\r
*/\r
/**\r
* MiMicErrorCode形式のエラーコードを保持する。\r
* @field {object as MiMicErrorCode}\r
+ * @name MiMicJS.MiMicException#code\r
*/\r
code:null,\r
/**\r
* エラーメッセージを保持する。この値は、改行区切りのコールスタックである。\r
* @field {string}\r
+ * @name MiMicJS.MiMicException#message\r
*/\r
message:"",\r
/**\r
* messageフィールドをalertで表示する。\r
+ * @name MiMicJS.MiMicException#alert\r
* @function\r
* @example\r
* try{\r
* toStringを上書きする。オブジェクトを文字列化する。\r
* 文字列は例外のコールスタックであり、デバックで役立つ。\r
* @function\r
+ * @name MiMicJS.MiMicException#toString\r
* @return {string}\r
* 現在のオブジェクトの状態（例外のコールスタック）\r
* @example\r
/**@private */\r
var NS=MiMicJS;\r
/**\r
- * @name MiMicJs.Rpc\r
- * @constructor\r
* MiMicRPCのクライアントクラスです。\r
* 通信APIを提供します。\r
+ * @name MiMicJS.Rpc\r
+ * @constructor\r
* @param {HashMap} i_event\r
* 非同期イベントハンドラの連想配列です。登録できるメンバは以下の通りです。\r
* <ul>\r
*/\r
_ws:null,\r
/**\r
+ * @private\r
+ * [READ ONLY]\r
+ * RPCの平均RTT[ms]です。\r
* @name MiMicJs.Rpc#RTT\r
- * [READ ONLY]\r
- * RPCの平均RTT[ms]です。\r
*/\r
rtt:0,\r
/** メソッドIDカウンタ。sendJsonを実行する毎にインクリメントされます。*/\r
_method_id:0,\r
/**\r
- * @name MiMicJS.Rpc#open\r
- * @function\r
* RPCコネクションを開きます。\r
* 関数が終了するとonOpenイベントをコールバックします。\r
+ * @name MiMicJS.Rpc#open\r
+ * @function\r
* @param i_url\r
* ws://から始まるWebsocketサービスURLを指定します。\r
*/\r
this._ws=ws;\r
},\r
/**\r
- * @name MiMicJS.Rpc#close\r
- * @function\r
* 接続中のRPCコネクションを閉じます。\r
* 関数が終了するとonCloseイベントをコールバックします。\r
+ * @name MiMicJS.Rpc#close\r
+ * @function\r
*/\r
close:function close()\r
{\r
}\r
},\r
/**\r
- * @name MiMicJS.Rpc#shutdown\r
* RPC回線を確実に閉じます。\r
* この関数を実行すると、すべてのコールバックイベントはキャンセルされます。\r
+ * @name MiMicJS.Rpc#shutdown\r
+ * @function\r
*/\r
shutdown:function shutdown()\r
{\r
}\r
},\r
/**\r
+ * 非同期でJSON RPCメソッドを送信します。\r
* @name MiMicJS.Rpc#sendMethod\r
* @function\r
- * 非同期でJSON RPCメソッドを送信します。\r
* @param {string} i_method\r
* RPCメソッドの名前です。\r
* @param {string} i_params\r
* カンマ区切りのJSONスタイルの文字列です。この文字列は[....]に埋め込まれます。エスケープ文字列は使用できません。\r
* @param {function(json)}i_callback\r
* Resultを受け取るコールベック関数です。jsonにはResult JSONをパースしたオブジェクトが入ります。\r
- * @return\r
+ * @return {int}\r
* メソッドIDを返します。\r
*/\r
sendMethod:function callJsonRpc(i_method,i_params,i_callback)\r
OSDN Git Service
