Commit: 85e8d2f89de56834111c67b7554311edb3870ef0 - SocketNet (git)

ソケットを使ってクライアントサーバプログラムを作成するための C# ライブラリ

Commit MetaInfo

• Révision: 85e8d2f89de56834111c67b7554311edb3870ef0 (tree)
• l'heure: 2015-08-23 14:23:34
• Auteur: tsntsumi <tsntsumi@tsnt...>
• Commiter: tsntsumi

Message de Log

mainpage.dox に UdpServer の説明を追加

Change Summary

• modified: doc/mainpage.dox

Modification

--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -1,9 +1,10 @@
 -*- Indented-Text -*-
 /** @mainpage
 @section overview 概要
-SocketNet は、ソケットを使ってクライアントサーバプログラムを作成するための C# フレームワークです。
-主に、サーバを作るための @link SocketNet.TcpServer @endlink クラスと、
-クライアントで使用する @link SocketNet.TcpConnection @endlink クラスで構成されます。
+@c SocketNet は、ソケットを使ってクライアントサーバプログラムを作成するための C# フレームワークです。
+主に、TCP サーバを作るための @c SocketNet.TcpServer クラスと、
+クライアントで使用する @c SocketNet.TcpConnection クラス、
+および UDP サーバを作るための @c SocketNet.UdpServer クラスで構成されます。
 
 @section license ライセンス
 
@@ -12,38 +13,56 @@ Lesser General Public License</a> バージョン 3 の元で配布していま
 
 @section sample サンプルプログラム
 
-SocketNet を使用したサンプルプログラムを以下のプロジェクトで提供しています。
+@c SocketNet を使用したサンプルプログラムを以下のプロジェクトで提供しています。
 
 - SampleChatServer -- コンソールベースの簡単なチャットサーバ。
 - SampleChatGtkClient -- Gtk# ベースの簡単なチャットクライアント。
-- SampleChatClient -- SampleChatSever と SampleChatClient の共通クラス。
+- SampleChatClient -- @c SampleChatServer と @c SampleChatClient の共通クラス。
+- SampleUdpChatGtkClient -- Gtk# ベースの簡単な UDP チャットクアプリケーション。
 
 @subsection chatserver SampleChatServer
 
-SampleChatServer はターミナルから起動する CLI コマンドです。
+@c SampleChatServer はターミナルから起動する CLI コマンドです。
 起動するとチャットクライアントからの接続を、ポート番号 50001 で待ち受けます。
 何かキーを入力すると終了します。
 
 クライアントから接続があったり、メッセージを受信したりするとコンソールに表示します。
 
-メッセージが「/LIST」のときは、現在接続しているクライアントの IP アドレスを表示します。
+メッセージが「 @c /LIST 」のときは、現在接続しているクライアントの IP アドレスを表示します。
 
 @subsection chatclient SampleChatGtkClient
 
-SampleChatGtkClient は Gtk# ベースの GUI アプリケーションです。
-起動したら SampleChatServer が実行されているパソコンの IP アドレスを入力して、
-Connect ボタンで接続します。
+@c SampleChatGtkClient は Gtk# ベースの GUI アプリケーションです。
+起動したら @c SampleChatServer が実行されているパソコンの IP アドレスを入力して、
+@c Connect ボタンで接続します。
 
-メッセージ入力エリアに文字を入力して Send ボタンをクリックすると、
+メッセージ入力エリアに文字を入力して @c Send ボタンをクリックすると、
 サーバにその文字が送信されます。
 サーバから送り返されたメッセージは、メッセージ表示エリアに表示されます。
 
-切断は Disconnect ボタンをクリックします。
+切断は @c Disconnect ボタンをクリックします。
+
+@subsection udpchatclient SampleUdpChatGtkClient
+
+@c SampleUdpChatGtkClient は Gtk# ベースの GUI アプリケーションです。
+起動したら受信用のポート番号を入力し、開始ボタンをクリックします。
+送信先のアドレスとして、もう一つの @c SampleUdpChatGtkClient が実行されているパソコンの
+IP アドレスか、ブロードキャストアドレス、ローカルブロードキャストアドレスと、
+ポート番号を入力します。
+
+メッセージ入力エリアに文字を入力して @c Send ボタンをクリックすると、
+送信先のアプリケーションにその文字が送信されます。
+ブロードキャストアドレスを指定した場合は、自分のメッセージ表示エリアにも表示されます。
+
+受信を停止するには @c Stop ボタンをクリックします。
 
 @section usage 使用法
 
+@subsection tcpserverusage TcpServer の使用法
+
 パケットの構造が、先頭 4 バイトにネットワークバイトオーダでペイロード長が格納されている場合は、
-単に SocketNet.TcpServer のインスタンスを生成して Start() メソッドを呼び出します。
+単に @c SocketNet.TcpServer のインスタンスを生成して
+@c SocketNet.TcpServer.Start() メソッドを呼び出します。
 
 @code
     var server = new TcpServer(IPAddress.Any, 50001, new Packet());
@@ -51,11 +70,11 @@ Connect ボタンで接続します。
     server.Start();
 @endcode
 
-上記のようにすることで、 server_DataReceived() がパケットを受信するごとに呼び出されます。
-server_DataReceived() に受信したときの処理を書いてください。
+上記のようにすることで、 @c server_DataReceived() がパケットを受信するごとに呼び出されます。
+@c server_DataReceived() に受信したときの処理を書いてください。
 
-パケットの構造が複雑な場合は、 SocketNet.Packet クラスを継承して、
-SocketNet.Packet.ObtainPayloadLength() をオーバライドします。
+パケットの構造が複雑な場合は、 @c SocketNet.Packet クラスを継承して、
+@c SocketNet.Packet.ObtainPayloadLength() をオーバライドします。
 
 例えば、ヘッダが 5 バイト、フッタが 2 バイトで、ペイロードの長さがヘッダの 3 バイト目に格納されている場合は、
 以下のようになるでしょう。
@@ -72,4 +91,19 @@ SocketNet.Packet.ObtainPayloadLength() をオーバライドします。
     }
 @endcode
 
+@subsection udpserverusage UdpServer 使用法
+
+ブロードキャスト UDP サーバを作成する場合は、
+@c SocketNet.UdpServer のインスタンスをファクトリメソッドで生成して
+@c SocketNet.UdpServer.Start() メソッドを呼び出します。
+
+@code
+    var server = UdpServer.CreateServer(50000);
+    udpServer.DataReceived = udpServer_DataReceived;
+    udpServer.Start();
+@endcode
+
+以上のようにすると、 @c udpServer_DataReceived() がデータを受信するごとに呼び出されます。
+@c udpServer_DataReceived() に受信したときの処理を書いてください。
+
 */