■ Socket クラスに依る TCP 非同期通信の方法 ■
複数のクライアントが同時に接続出来る TCP を利用したクライアントサーバー型チャットアプリケー
ションをTcpClient と TcpListener クラスを使わずに、Socket クラスを使って作る方法を紹介する。
■ 初めに
此処では、複数のクライアントが同時に接続出来る TCP を利用したクライアントサーバー型チャット
アプリケーション（DOBON Chat）のサンプルを示し、其の要点を解説する。
.NET Framework では TCP を利用したデータ通信を行う為のクラスとして、TcpClient 及び TcpListener クラス（共に System.Net.Sockets 名前空間）が用意されて居る。此等のクラスは内部で Socket クラス（System.Net.Sockets 名前空間）を使用して居り、Socket クラスをより簡単に扱える様 にする為のクラスで有ると謂える。併し、Socket クラスを直接扱う場合と比べて機能的に劣り、而も取 り扱いの難しさも然程変わらない。其処で此処では、TcpClient とTcpListener クラスを使わずに、Socket クラスを使ってサーバーとクライアントを作成して居る（TcpClient と TcpListener を使用した簡単な サンプルは、「DOBON.NET .NET Tips - TCP クライアント・サーバープログラムを作成する」に有る）。 ■ 対象読者 .NET でのネットワークプログラミング（特にソケットを使った TCP 非同期通信）に興味が有る方を対 象として居る。但し、此処ではネットワークや.NET プログラミングの基本的な事柄に付いては説明し ないので、不明な点はMSDN ライブラリ等で調べて欲しい。
チ
チャ
ャッ
ット
トア
アプ
プリ
リ
■ 必要な環境
サンプル（DobonChat）は Visual Studio .NET 2003 で作成され、.NET Framework 1.1 で動作確認を して居るが、.NET Framework 1.0 でも問題なく動作すると思う。 ■ クライアントの作成 クライアントはサーバーに接続し、データの送受信を行う。Socket クラスの場合、データの送信には Send、受信には Receive メソッドを使えば簡単で有る（巻末に一例が有る）。併し、チャットアプリケ ーションの場合、少なくともReceive メソッドを其の儘呼び出す訳には行かない。Receive メソッドは データを受信する迄スレッドをブロックする為（ブロッキングモードの場合）、其の間データの送信は おろか、何も出来なく成る。何時データが送られて来るか解らないチャットでは常にデータの受信を待 機して居なければ成らない為、此れは致命的で有る。 データの受信を待機しつゝ、送信も出来る様にするには、ポーリングに依る方法（参考資料3）や、Socket クラスの非同期メソッドに依る方法（参考資料 1,2）が有る。ポーリングに依る方法では、Socket.Poll メソッド（又は、Available プロパティ）でデータの読み取りが可能かループやタイマーで監視し、読 み取れると判断出来れば、Receive メソッドで受信する様にする。ポーリングは此の様に無駄なループ を繰り返す為、CPU に負担を懸けると謂う欠点が有る。
一方非同期メソッドに依る方法では、Socket の BeginReceive と EndReceive メソッドを使用する。此 処では此の方法を採用して居る。 非同期受信では、先ずBeginReceive メソッドを呼び出す事に依り、データの受信が開始される。Receive メソッドではデータを受信しない限り処理が次へ進まないが、BeginReceive メソッドは直ぐに終了し、 ブロックしない。BeginReceive を呼び出した後にデータを受信すると、指定したコールバックメソッ ドが実行される。此のコールバックメソッドでEndReceive メソッドを呼び出し、データを受信し、再 びBeginReceive メソッドを呼び出して非同期受信を再開する様にする。 以下に非同期メソッドを使ってデータを受信する簡単な例を示す。Connect メソッドを使って既にサー バーと接続して居るSocket を此の StartReceive メソッドに渡す事に依り、データの非同期受信が開始 され、データを受信するとUTF-8 でデコードし、コンソールに出力して居る。 VB ' 非同期データ受信の為の状態オブジェクト Private Class AsyncStateObject
Public Socket As System.Net.Sockets.Socket Public ReceiveBuffer() As Byte
Public ReceivedData As System.IO.MemoryStream
Public Sub New(ByVal soc As System.Net.Sockets.Socket) Me.Socket = soc
Me.ReceiveBuffer = New Byte(1023) {}
Me.ReceivedData = New System.IO.MemoryStream End Sub
End Class
Private Shared Sub StartReceive _
(ByVal soc As System.Net.Sockets.Socket) Dim so As New AsyncStateObject(soc) ' 非同期受信を開始
soc.BeginReceive(so.ReceiveBuffer, 0, so.ReceiveBuffer.Length, _ System.Net.Sockets.SocketFlags.None, _
New System.AsyncCallback(AddressOf ReceiveDataCallback), so) End Sub
' BeginReceive のコールバック
Private Shared Sub ReceiveDataCallback(ByVal ar As System.IAsyncResult) ' 状態オブジェクトの取得
Dim so As AsyncStateObject = CType(ar.AsyncState, AsyncStateObject)
' 読み込んだ長さを取得 Dim len As Integer = 0 Try len = so.Socket.EndReceive(ar) Catch ex As System.ObjectDisposedException ' 閉じた時 System.Console.WriteLine("閉じました。") Return End Try ' 切断されたか調べる If len <= 0 Then System.Console.WriteLine("切断されました。") so.Socket.Close() Return End If ' 受信したデータを蓄積する so.ReceivedData.Write(so.ReceiveBuffer, 0, len) If so.Socket.Available = 0 Then ' 最後迄受信した時、受信したデータを文字列に変換 Dim str As String = _ System.Text.Encoding.UTF8.GetString(so.ReceivedData.ToArray()) ' 受信した文字列を表示 System.Console.WriteLine(str) so.ReceivedData.Close()
so.ReceivedData = New System.IO.MemoryStream End If ' 再び受信開始 so.Socket.BeginReceive(so.ReceiveBuffer, 0, _ so.ReceiveBuffer.Length, _ System.Net.Sockets.SocketFlags.None, _
End Sub
C#
// 非同期データ受信の為の状態オブジェクト private class AsyncStateObject
{
public System.Net.Sockets.Socket Socket; public byte[] ReceiveBuffer;
public System.IO.MemoryStream ReceivedData;
public AsyncStateObject(System.Net.Sockets.Socket soc) {
this.Socket = soc;
this.ReceiveBuffer = new byte[1024];
this.ReceivedData = new System.IO.MemoryStream(); }
}
// データ受信スタート
private static void StartReceive(System.Net.Sockets.Socket soc) {
AsyncStateObject so = new AsyncStateObject(soc); // 非同期受信を開始 soc.BeginReceive(so.ReceiveBuffer, 0, so.ReceiveBuffer.Length, System.Net.Sockets.SocketFlags.None, new System.AsyncCallback(ReceiveDataCallback), so); } // BeginReceive のコールバック
private static void ReceiveDataCallback(System.IAsyncResult ar) {
// 状態オブジェクトの取得
AsyncStateObject so = (AsyncStateObject) ar.AsyncState; // 読み込んだ長さを取得 int len = 0; try { len = so.Socket.EndReceive(ar); } catch (System.ObjectDisposedException) { // 閉じた時 System.Console.WriteLine("閉じました。"); return;
} // 切断されたか調べる if (len <= 0) { System.Console.WriteLine("切断されました。"); so.Socket.Close(); return; } // 受信したデータを蓄積する so.ReceivedData.Write(so.ReceiveBuffer, 0, len); if (so.Socket.Available == 0) { // 最後迄受信した時、受信したデータを文字列に変換 string str = System.Text.Encoding.UTF8.GetString( so.ReceivedData.ToArray()); // 受信した文字列を表示 System.Console.WriteLine(str); so.ReceivedData.Close();
so.ReceivedData = new System.IO.MemoryStream(); } // 再び受信開始 so.Socket.BeginReceive(so.ReceiveBuffer, 0, so.ReceiveBuffer.Length, System.Net.Sockets.SocketFlags.None, new System.AsyncCallback(ReceiveDataCallback), so); } 此処で注意しなければ成らないのが、コールバックメソッドは、初めに BeginReceive を呼び出したス レッドとは別のスレッドで実行されると謂う事で有る。詰り、スレッドの同期が必要に成るケースが充 分有り得る。例えばSocket クラスはスレッドセーフではないので、上記の様な非同期受信を行い乍 Send メソッド等を呼び出す場合には、lock（VB.NET では、SyncLock）等を使用してスレッドの同期を行 う必要が有ると謂う事に成る（実際に此の様にして居るサンプルは殆ど見ないが）。亦、受信したデー タをテキストボックスに表示する場合等、コールバックメソッドからコントロールのメソッドを呼び出 す時は、Invoke メソッド（又は BeginInvoke メソッド）を使用してコントロールのスレッドにマーシ ャリングする。 Socket クラスにはデータの受信以外に、リモートホストへの接続（BeginConnect、EndConnect メソ ッド）、データの送信（BeginSend、EndSend メソッド）の為の非同期メソッドも用意されて居る。 ■ サーバーの作成 サーバーでは、Socket.Bind メソッドでバインドし、Listen メソッドでクライアントの接続を待機し、 Accept メソッドで接続を受け入れると謂うのが基本的な流れで有る。併し、Accept メソッドは接続要
求がない限りブロックし続けて了う。 此の対処法としては、先程と同様に、ポーリング（参照資料3）、非同期メソッド（参照資料 2）、更に、 スレッド化（参照資料1）と謂った方法が考えられる。ポーリングでは、先と同じく、Poll メソッドで 接続の要求がないかループで監視し、有れば Accept メソッドで受け入れる様にする。スレッド化に依 る方法では、Accept メソッドの呼び出しを別のスレッドで行う様にする（此の方法では接続の待機を中 止する為に、スレッドセーフでない Socket クラスの Close メソッドを別のスレッドから呼び出す事に 成る）。
「DOBON Chat」では、非同期メソッドの BeginAccept、EndAccept メソッドを使用して居る。以下 にBeginAccept メソッドを使った簡単な例を示す。Listen メソッドが既に呼び出されて居る Socket を 此のStartAccept メソッドに渡す事に依り、クライアントからの接続を非同期で待機する。
VB
' クライアントの接続待ちスタート
Private Shared Sub StartAccept(ByVal server As System.Net.Sockets.Socket) ' 接続要求待機を開始する
server.BeginAccept(New System.AsyncCallback(AddressOf AcceptCallback), server) End Sub
' BeginAccept のコールバック
Private Shared Sub AcceptCallback(ByVal ar As System.IAsyncResult) ' サーバーSocket の取得
Dim server As System.Net.Sockets.Socket = CType(ar.AsyncState, System.Net.Sockets.Socket)
' 接続要求を受け入れる
Dim client As System.Net.Sockets.Socket = Nothing Try ' クライアント Socket の取得 client = server.EndAccept(ar) Catch System.Console.WriteLine("閉じました。") Return End Try ' クライアントが接続した時の処理を此処に書く ' 此処では文字列を送信して、直ぐに閉じて居る client.Send(System.Text.Encoding.UTF8.GetBytes("こんにちは。")) client.Shutdown(System.Net.Sockets.SocketShutdown.Both) client.Close() ' 接続要求待機を再開する
server.BeginAccept(New System.AsyncCallback(AddressOf AcceptCallback), server) End Sub
C#
// クライアントの接続待ちスタート
{
// 接続要求待機を開始する
server.BeginAccept(new System.AsyncCallback(AcceptCallback), server); }
// BeginAccept のコールバック
private static void AcceptCallback(System.IAsyncResult ar) {
// サーバーSocket の取得
System.Net.Sockets.Socket server = (System.Net.Sockets.Socket) ar.AsyncState;
// 接続要求を受け入れる
System.Net.Sockets.Socket client = null; try { // クライアント Socket の取得 client = server.EndAccept(ar); } catch { System.Console.WriteLine("閉じました。"); return; } // クライアントが接続した時の処理を此処に書く // 此処では文字列を送信して、直ぐに閉じて居る client.Send(System.Text.Encoding.UTF8.GetBytes("こんにちは。")); client.Shutdown(System.Net.Sockets.SocketShutdown.Both); client.Close(); // 接続要求待機を再開する server.BeginAccept(
new System.AsyncCallback(AcceptCallback), server); } EndAccept メソッドに依り、接続したクライアントとの通信に使用する Socket オブジェクトが返され る。上記のコードでは、接続したクライアントに文字列を UTF-8 でエンコードしたデータを送信し、 直ぐに接続を閉じて居る。 チャットアプリケーションのサーバーでは、或るクライアントから受信したメッセージを接続中の総て のクライアントに送信する必要が有る。此れは単純に、クライアントからデータを受信したら、接続中 の一つ一つのクライアントのSocket.Send（又は、BeginSend）メソッドを呼び出してデータを送信す る様にすれば良い。 ■ 独自のアプリケーションプロトコルの定義 以上で、チャットアプリケーションを作成する為の知識が揃いました。此れで当初の目的には達したと 謂って良い。
併し、文字列の遣り取りが出来る様に成ったとは謂え、此れ丈では実用的なチャットアプリケーション には程遠い。現状では、クライアント側で現在チャットに参加して居るメンバーを表示する事も、送ら れて来たメッセージを表示する時に其の送信者を併記する事も出来ないので有る。更に、プライベート メッセージ（指定した人にしかメッセージを送信しない）等の機能は何の様に実装すれば良いのか。 此の様に様々な機能を持つチャットアプリケーションを作成する為には、予めサーバーとクライアント の間で機能に応じた「決まり」を用意して置く必要が有る。此れは、アプリケーション層プロトコルと 呼ばれる物で有る。 此の「決まり」は極簡単な物で構わない（ちゃんとした物を作るならば、RFC、特にチャットアプリケ ーションではIRCが参考に成るだろう）。良く有る「決まり」の形式は、文字列のコマンドと一つ以上 のパラメータから成り、夫々をスペース文字で区切り、CR-LF（キャリッジリターン+ラインフィード） で終わると謂う物で有る。 例えば、クライアントがプライベートメッセージを送信する時は、 PRIVMSG "メッセージの送信先" "メッセージの内容"CR-LF と謂う内容の文字列を UTF-8 でエンコードしたデータを送信すると決めて置く。此の様にして置く事 に依り、サーバーは「PRIVMSG」で始まり「CR-LF」で終わる文字列を受信した時に、其れがクライ アントがプライベートメッセージの送信を要求して居る合図で有ると解り、メッセージの内容と送信先 を正しく理解する事が出来る。 同様に、サーバーからクライアントへのプライベートメッセージの送信でも、 PRIVMSG "メッセージの送信者" "メッセージの内容"CR-LF と謂う決まりにして置けば、クライアントが「PRIVMSG」で始めるデータを受信した時、其のデータ が自分丈に送られて来たプライベートメッセージで有り、誰が何の様なメッセージを送って来たのかが 解る。 此の様なコマンド（上記の例では「PRIVMSG」）を増やして行く事に依り、機能を拡張する事が出来る。 ■ 纏め 此の記事では、TCP を利用した複数クライアントが接続可能なチャットアプリケーションの作り方を説 明した。ポイントを纏めると次の様に成る。 ・チャットアプリケーションでは長時間ブロックするメソッドの使用は厳禁で有る為（例外有り）、非 同期メソッドの活用が有効で有る。 ・非同期メソッドに依り呼び出されるコールバックメソッドは個別のスレッドで実行される為、スレッ ドの同期等の対策が必要と成る。 ・既存のアプリケーション層プロトコルを利用しないならば、独自のアプリケーション層プロトコルを 定義しなければ成らない。
■ 参考資料
１．MSDN ライブラリ『Creating a Multi-User TCP Chat Application』
２．CodeGuru『Asynchronous Socket Programming in C#』
３．CSharpFriends.com『Non-blocking Sockets (A Chat Program)』
４．MSDN ライブラリ『非同期クライアント ソケットの使用』
５．MSDN ライブラリ『非同期サーバー ソケットの使用』
６．MSDN ライブラリ『非同期クライアント ソケットの例』
７．MSDN ライブラリ『非同期サーバー ソケットの例』
■ Socket を使って HTTP でファイルをダウンロードし表示する ■ Socket クラスを使って HTTP サーバーに GET 要求し、応答を受信する方法を、具体例而巳示す。通常 は、「WebRequest、WebResponse クラスを使ってファイルをダウンロードし表示する」の様な方法で 充分で有る。説明は一切しないので、興味のある方而巳参考にして欲しい。 VB ' GET リクエストを送信するサーバー名とパス Dim server As String = "www.google.co.jp" Dim path As String = "/"
' リクエストメッセージを作成する
Dim reqMsg As String = "GET " + path + " HTTP/1.1" + vbCrLf + _ "Host: " + server + vbCrLf + "Connection: Close" + vbCrLf + vbCrLf
' 文字列を byte 配列に変換
Dim enc As System.Text.Encoding = System.Text.Encoding.GetEncoding("shift_jis") Dim reqBytes As Byte() = enc.GetBytes(reqMsg)
' ホスト名から IP アドレスを取得
Dim hostadd As System.Net.IPAddress = System.Net.Dns.Resolve(server).AddressList(0) ' 又は
' System.Net.IPAddress hostadd = System.Net.Dns.GetHostByName(server).AddressList(0)
' IPEndPoint を取得
Dim ephost As New System.Net.IPEndPoint(hostadd, 80)
' Socket の作成
Dim sock As New System.Net.Sockets.Socket( _ System.Net.Sockets.AddressFamily.InterNetwork, _ System.Net.Sockets.SocketType.Stream, _ System.Net.Sockets.ProtocolType.Tcp) ' 接続 sock.Connect(ephost) ' リクエストメッセージを送信
sock.Send(reqBytes, reqBytes.Length, System.Net.Sockets.SocketFlags.None)
' 受信する
Dim resBytes(1023) As Byte
Dim mem As New System.IO.MemoryStream While True
Dim resSize As Integer = _
sock.Receive(resBytes, resBytes.Length, System.Net.Sockets.SocketFlags.None) If resSize = 0 Then
Exit While End If
mem.Write(resBytes, 0, resSize) End While
Dim resMsg As String = enc.GetString(mem.GetBuffer(), 0, CInt(mem.Length)) mem.Close() ' 閉じる sock.Shutdown(System.Net.Sockets.SocketShutdown.Both) sock.Close() ' 受信したメッセージを表示する Console.WriteLine(resMsg) C# // GET リクエストを送信するサーバー名とパス string server = "www.google.co.jp";
string path = "/";
// リクエストメッセージを作成する
string reqMsg = "GET " + path + " HTTP/1.1¥r¥n" + "Host: " + server + "¥r¥n" +
"Connection: Close¥r¥n¥r¥n";
// 文字列を byte 配列に変換
System.Text.Encoding enc System.Text.Encoding.GetEncoding("shift_jis"); byte [] reqBytes = enc.GetBytes(reqMsg);
// ホスト名から IP アドレスを取得
System.Net.IPAddress hostadd = System.Net.Dns.Resolve(server).AddressList[0]; // 又は
// System.Net.IPAddress hostadd = System.Net.Dns.GetHostByName(server).AddressList[0];
// IPEndPoint を取得
System.Net.IPEndPoint ephost = new System.Net.IPEndPoint(hostadd, 80);
// Socket の作成 System.Net.Sockets.Socket sock = new System.Net.Sockets.Socket( System.Net.Sockets.AddressFamily.InterNetwork, System.Net.Sockets.SocketType.Stream, System.Net.Sockets.ProtocolType.Tcp); // 接続 sock.Connect(ephost); // リクエストメッセージを送信
sock.Send(reqBytes, reqBytes.Length, System.Net.Sockets.SocketFlags.None);
byte [] resBytes = new byte[1024];
System.IO.MemoryStream mem = new System.IO.MemoryStream(); while (true) { int resSize = sock.Receive(resBytes, resBytes.Length, System.Net.Sockets.SocketFlags.None); if (resSize == 0) break; mem.Write(resBytes, 0, resSize); }
string resMsg = enc.GetString(mem.GetBuffer(), 0, (int) mem.Length); mem.Close(); // 閉じる sock.Shutdown(System.Net.Sockets.SocketShutdown.Both); sock.Close(); // 受信したメッセージを表示する Console.WriteLine(resMsg);
