git-svn-id: http://svn.osdn.jp/svnroot/mimic/trunk@322 47198e57-cb75-475f-84c4-a814cd...

diff --git a/lib/src/net/httpd/mod/NyLPC_cModWebSocket.h b/lib/src/net/httpd/mod/NyLPC_cModWebSocket.h
index 7f4fbe4..0a09d2b 100644 (file)
--- a/lib/src/net/httpd/mod/NyLPC_cModWebSocket.h
+++ b/lib/src/net/httpd/mod/NyLPC_cModWebSocket.h
@@ -90,14 +90,24 @@ NyLPC_TBool NyLPC_cModWebSocket_execute(NyLPC_TcModWebSocket_t* i_inst,NyLPC_TcH
 \r
 \r
 /**\r
+ * i_bufに最大i_buf_lenバイトのデータを受信します。\r
  * @return\r
- * n>0:データ受信\r
+ * n>0:受信成功。nバイトのデータを受信した。\r
  * 0  :タイムアウト。コネクションの状態は変化しない。\r
- * -1 :エラー コネクションはNyLPC_TcModWebSocket_ST_CLOSEDへ遷移する。\r
+ * -1 :エラー。 コネクションはNyLPC_TcModWebSocket_ST_CLOSEDへ遷移する。\r
  */\r
 NyLPC_TInt16 NyLPC_cModWebSocket_read(NyLPC_TcModWebSocket_t* i_inst,void* i_buf,NyLPC_TInt16 i_buf_len);\r
-\r
+/**\r
+ * i_bufからi_lenバイトのデータを送信します。データは１ペーロードとしてクライアントへ送信されます。\r
+ * @return\r
+ * true: 送信に成功した。\r
+ * false:送信に失敗した。 コネクションはNyLPC_TcModWebSocket_ST_CLOSEDへ遷移する。\r
+ */\r
 NyLPC_TBool NyLPC_cModWebSocket_write(NyLPC_TcModWebSocket_t* i_inst,void* i_buf,NyLPC_TInt16 i_len);\r
+/**\r
+ * CLOSEパケットを送信してコネクションを閉じます。\r
+ * i_codeにはWebsocketのコード\r
+ */\r
 void NyLPC_cModWebSocket_close(NyLPC_TcModWebSocket_t* i_inst,NyLPC_TUInt16 i_code);\r
 \r
 #ifdef __cplusplus\r