C# で ソケット通信の基礎的サーバー作成(TcpListener + TcpClient)

• ナイス！：

  10

• 閲覧数：7039
• 付箋（アドバイス）指数中→

*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*

C# で ソケット通信の基礎的サーバー作成(TcpListener + TcpClient)

*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*

「C# で ソケット通信のサーバー用プログラムを作成する方法」における一連の説明（知恵ノート）において、ここでは、「C# で ソケット通信の基礎的サーバー作成(TcpListener + TcpClient)」について説明します。

総合の目次

参考

<関連サンプル>
サンプル 「C# で ソケット通信の基礎的サーバー作成(Socket + Socket)」

 http://note.chiebukuro.yahoo.co.jp/detail/n1656

サンプル 「C# で ソケット通信の基礎的サーバー作成(TcpListener + TcpClient)」

（本サンプル）

サンプル 「C# で ソケット通信の基礎的サーバー作成(TcpListener + Socket)」

http://note.chiebukuro.yahoo.co.jp/detail/n1658

<関連性の内容>
本サンプルは、なるべく単純な構造にしたサーバー用のサンプルです。上記の関連サンプルも同様に、単純なサーバーですので本質は同じです。
違いは、Visual C# から用意されているクラスが、違う種類を使っているだけですので、サーバーとしての機能の本質は同じです。

はじめに

ここでは、Visual C# の Socketクラスで、基礎的なサーバーを作成する方法について解説します。
正確には、
(１) サーバーとしての主となる処理をTcpListenerクラスを使い、
(２) 実際にクライアントへ電文を送受信する処理部は、TcpClientクラスを使います。

送受信部のスレッド化への対応/未対応

サーバー機能の主制御用クラスの種類

クライアントへの対処を直接行なう処理で使うクラスの種類

本サンプルの種類のまとめ

サンプルコード

こで取り上げるサンプルは、なるべく複雑にならない範囲で、ある程度は、実際に通信を確かめられるものとします。

本サンプの仕様

フォームデザイン等の前準備

<プロジェクトの作成>
本サンプルの確認用に、新規にプロジェクトを作成して下さい。
プロジェクトの種類は、「Windowsフォームアプリケーション」です。

<フォームのデザイン>
デザイン画面で、Label（ラベル）を１個と、TextBox （テキストボックス） を１個と、 Button （ボタン）を２個貼り付けて下さい。

<イベントプロシージャの作成>

デザイン画面のフォームをダブルクリックして、Form1_Load() メソッドを作って下さい。

次に、デザイン画面のフォームが選択された状態で、「プロパティ」画面の「イベント」ボタン（雷マークのボタン）をクリックして下さい。
その「プロパティ」画面で、FormClosed と言う項目をダブルクリックして下さい。
そうすると、Form1_FormClosed()メソッドが作成されます。

また、先程貼り付けたデザイン画面上のボタン「button1」をダブルクリックして、button1_Click() メソッド を作って下さい。
同様にボタン「button2」もダブルクリックして、button2_Click() メソッド を作って下さい。

コード

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;

namespace ServerByTcpListener
{

    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();

            // スレッドからテキストボックスをアクセスすることを指定
            Control.CheckForIllegalCrossThreadCalls = false;
        }

        //============
        // メンバー変数
        private System.Net.Sockets.TcpListener server;  // リスナー(接続待ちや受信等を行なうｵﾌﾞｼﾞｪｸﾄ)
        private System.Threading.Thread ListeningCallbackThread;   // 接続待ちスレッド
        private volatile bool SLTAlive;  // 接続待ちスレッド終了指示フラグ(volatile が指定されていることに注意)

        //============
        // フォーム起動時イベント
        private void Form1_Load(object sender, EventArgs e)
        {

            this.Text = "ｻｰﾊﾞｰ";   // ﾌｫｰﾑのﾀｲﾄﾙ名
            button1.Text = "ｻｰﾊﾞｰ開始"; // 開始ﾎﾞﾀﾝの表示文字
            button2.Text = "ｻｰﾊﾞｰ終了"; // 終了ﾎﾞﾀﾝの表示文字
            label1.Text = "";       // 状態表示用ﾗﾍﾞﾙを初期化

            // スレッド終了指示フラグを未終了に初期化
            SLTAlive = false;

        }

        //============
        // フォーム閉鎖時イベント
        private void Form1_FormClosed(object sender, FormClosedEventArgs e)
        {
            // ｻｰﾊﾞｱﾌﾟﾘを終了するにもかかわらず、接続待ちｽﾚｯﾄﾞを終了していない場合の処理
            if (SLTAlive)
            {

                // スレッド終了指示フラグを終了に設定
                SLTAlive = false;

                // 接続要求受け入れの終了
                server.Stop();

                // 念のためスレッドをnull設定
                ListeningCallbackThread = null;

            }

        }

        //============
        // 接続待ち開始ボタンのクリックイベント
        private void button1_Click(object sender, EventArgs e)
        {

            if (!SLTAlive)  // まだ接続待ちｽﾚｯﾄﾞを生成していない場合
            {

                // 接続待ち用スレッドを作成
                ListeningCallbackThread = new System.Threading.Thread(ListeningCallback);

                // 接続待ち用スレッドを開始
                ListeningCallbackThread.Start();

                // スレッド終了指示フラグを未終了に設定
                SLTAlive = true;

            }

        }

        //============
        // 接続待ち終了ボタンのクリックイベント
        private void button2_Click(object sender, EventArgs e)
        {

            if (SLTAlive)  // 接続待ちｽﾚｯﾄﾞが作成されていて使える場合
            {

                if (server != null)
                {
                    // 接続要求受け入れの終了
                    server.Stop();
                }

                // スレッド終了指示フラグを終了に設定
                SLTAlive = false;

                label1.Text = "サーバー終了";

            }

        }

        //============
        // 接続待ちスレッド用メソッド
        private void ListeningCallback()
        {

            // リスナー(接続要求受け入れ待機)を生成
            server = new System.Net.Sockets.TcpListener(System.Net.IPAddress.Parse("127.0.0.1"), 9000);
            // *** server = new System.Net.Sockets.TcpListener(System.Net.IPAddress.Any, 9000);

            // 接続要求受け入れ開始
            server.Start();
            label1.Text = "サーバー開始";

            try
            {

                // 受信の受付を行なうための無限ループ
                while (SLTAlive)    // ｽﾚｯﾄﾞ終了指示ﾌﾗｸﾞでの終了指示がある場合はﾙｰﾌﾟ終了
                {

                    // 受信接続キュー内で、接続待ちがあるか判断
                    if (server.Pending() == true)
                    {
                        // クライアントからの接続を受け付ける
                        System.Net.Sockets.TcpClient ClientSocket = server.AcceptTcpClient(); // TCPｸﾗｲｱﾝﾄ

                        // 通信ストリームの取得
                        System.Net.Sockets.NetworkStream stream = ClientSocket.GetStream();

                        // クライアントからの電文の受信
                        byte[] ReceiveData = new byte[2000];
                        int DataLength = stream.Read(ReceiveData, 0, ReceiveData.Length);   // 電文の列長
                        string str = System.Text.Encoding.Unicode.GetString(ReceiveData, 0, DataLength);
                        textBox1.Text = str;    // 受信データ

                        // 返信電文をクライアントへ送信
                        byte[] SendBuffer = System.Text.Encoding.Unicode.GetBytes("本ｻｰﾊﾞｰの御利用ありがとう御座います。");
                        stream.Write(SendBuffer, 0, SendBuffer.Length);
                        stream.Flush(); // フラッシュ(強制書き出し)

                        // TCPｸﾗｲｱﾝﾄをｸﾛｰｽﾞ
                        ClientSocket.Close();
                    }

                    // 短時間だけ待機
                    System.Threading.Thread.Sleep(100);
                }
            }
            catch (Exception ex)
            {
                label1.Text = "サーバー終了";
            }
        }

    }

}

実行結果

備考

http://note.chiebukuro.yahoo.co.jp/detail/n1808

さいごに

ここでは、サーバー用プログラムを実際に試すことが、主要目的になっています。
なお、サーバーシステムの作成は、いろいろと難しい技術が必要です。
そのことから、初心者や中級者の中には、敷居が高い存在に感じる人もいると思います。
よって、本サンプルでは、なるべく単純にした通信プログラムで、実際に確かめてもらうことを目的にしています。
どのような様子のものかを、最初のさわり程度でも知っていれば、次のステップへ進みやすいと思います。

この知恵ノートのライター

グレード：1-3

その他の知恵ノート（648件）

C# 背景画像とキャラクター画像...

C#でソケット通信のサーバー用...

C# で Excel ファイルのデータ...

C# で作ったスレッドを一時中断...

C# で Excel ファイルのデータ...

[ノート一覧]