From e25dd4be3323c54029cf3db04a4ff5c83678e473 Mon Sep 17 00:00:00 2001
From: nyatla <nyatla@47198e57-cb75-475f-84c4-a814cd6f29e0>
Date: Wed, 11 Sep 2013 09:58:09 +0000
Subject: [PATCH] git-svn-id: http://svn.osdn.jp/svnroot/mimic/trunk@322
 47198e57-cb75-475f-84c4-a814cd6f29e0

---
 lib/src/net/httpd/mod/NyLPC_cModWebSocket.h | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

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