C#網路編程系列文章(四)之TcpListener實現同步TCP伺服器

本文介紹

TcpListener 類提供一些簡單方法，用於在阻止同步模式下偵聽和接受傳入串連請求。 可使用 TcpClient 或 Socket 來串連 TcpListener。 可使用 IPEndPoint、本地 IP 位址及連接埠號碼或者僅使用連接埠號碼，來建立 TcpListener。 可以將本地 IP 位址指定為 Any，將本地連接埠號碼指定為 0（如果希望基礎服務提供者為您分配這些值）。 如果您選擇這樣做，可在串連通訊端後使用 LocalEndpoint 屬性來標識已指定的資訊。使用 Start 方法，可開始偵聽傳入的串連請求。 Start 將對傳入串連進行排隊，直至您調用 Stop 方法或它已經完成 MaxConnections 排隊為止。 可使用 AcceptSocket 或 AcceptTcpClient 從傳入串連請求隊列提取串連。 這兩種方法將阻止。 如果要避免阻止，可首先使用 Pending 方法來確定隊列中是否有可用的串連請求。
雖然TcpListener已經封裝的比較不錯了，我們於是就使用它在構造一個比較不錯的同步TCP伺服器，這裡依然和前兩章一樣，給出伺服器中的代碼，代碼中注釋很詳細，我也會給出相關的封裝類。

TcpListener同步TCP伺服器

using System;using System.Collections.Generic;using System.Linq;using System.Text;using System.Net.Sockets;using System.Net;using System.Threading;namespace NetFrame.Net.TCP.Listener.Synchronous{    /// <summary>    /// TcpListener實現同步TCP伺服器    /// </summary>    public class TCPServer    {        #region Fields        /// <summary>        /// 伺服器程式允許的最大用戶端串連數        /// </summary>        private int _maxClient;        /// <summary>        /// 當前的串連的用戶端數        /// </summary>        private int _clientCount;        /// <summary>        /// 伺服器使用的非同步TcpListener        /// </summary>        private TcpListener _listener;        /// <summary>        /// 用戶端工作階段列表        /// </summary>        private List<TCPClientHandle> _clients;        private bool disposed = false;        #endregion        #region Properties        /// <summary>        /// 伺服器是否正在運行        /// </summary>        public bool IsRunning { get; private set; }        /// <summary>        /// 監聽的IP地址        /// </summary>        public IPAddress Address { get; private set; }        /// <summary>        /// 監聽的連接埠        /// </summary>        public int Port { get; private set; }        /// <summary>        /// 通訊使用的編碼        /// </summary>        public Encoding Encoding { get; set; }        #endregion        #region 構造器        /// <summary>        /// 同步TCP伺服器        /// </summary>        /// <param name="listenPort">監聽的連接埠</param>        public TCPServer(int listenPort)            : this(IPAddress.Any, listenPort, 1024)        {        }        /// <summary>        /// 同步TCP伺服器        /// </summary>        /// <param name="localEP">監聽的終結點</param>        public TCPServer(IPEndPoint localEP)            : this(localEP.Address, localEP.Port, 1024)        {        }        /// <summary>        /// 同步TCP伺服器        /// </summary>        /// <param name="localIPAddress">監聽的IP地址</param>        /// <param name="listenPort">監聽的連接埠</param>        /// <param name="maxClient">最大用戶端數量</param>        public TCPServer(IPAddress localIPAddress, int listenPort, int maxClient)        {            this.Address = localIPAddress;            this.Port = listenPort;            this.Encoding = Encoding.Default;            _maxClient = maxClient;            _clients = new List<TCPClientHandle>();            _listener = new TcpListener(new IPEndPoint(this.Address, this.Port));        }        #endregion        #region Method        /// <summary>        /// 啟動伺服器        /// </summary>        public void Start()        {            if (!IsRunning)            {                IsRunning = true;                _listener.Start();                Thread thread = new Thread(Accept);                thread.Start();            }        }        /// <summary>        /// 開始進行監聽        /// </summary>        private void Accept()        {            TCPClientHandle handle;            while (IsRunning)            {                TcpClient client = _listener.AcceptTcpClient();                if (_clientCount >= _maxClient)                {                    //TODO 觸發事件                }                else                {                    handle = new TCPClientHandle(client);                    _clientCount++;                    _clients.Add(handle);                    //TODO 建立一個處理用戶端的線程並啟動                    //使用線程池來操作                    new Thread(new ThreadStart(handle.RecevieData)).Start();                }            }        }        /// <summary>        /// 停止伺服器        /// </summary>        public void Stop()        {            if (IsRunning)            {                IsRunning = false;                _listener.Stop();                //TODO 關閉對所有用戶端的串連            }        }        /// <summary>        /// 發送函數        /// </summary>        public void Send(string msg, TcpClient client)        {            //TODO        }        #endregion        #region 事件        /// <summary>        /// 與用戶端的串連已建立事件        /// </summary>        public event EventHandler<TCPEventArgs> ClientConnected;        /// <summary>        /// 與用戶端的串連已斷開事件        /// </summary>        public event EventHandler<TCPEventArgs> ClientDisconnected;        /// <summary>        /// 觸發用戶端串連事件        /// </summary>        /// <param name="state"></param>        private void RaiseClientConnected(TCPClientHandle handle)        {            if (ClientConnected != null)            {                ClientConnected(this, new TCPEventArgs(handle));            }        }        /// <summary>        /// 觸發用戶端串連斷開事件        /// </summary>        /// <param name="client"></param>        private void RaiseClientDisconnected(Socket client)        {            if (ClientDisconnected != null)            {                ClientDisconnected(this, new TCPEventArgs("串連斷開"));            }        }        /// <summary>        /// 接收到資料事件        /// </summary>        public event EventHandler<TCPEventArgs> DataReceived;        private void RaiseDataReceived(TCPClientHandle handle)        {            if (DataReceived != null)            {                DataReceived(this, new TCPEventArgs(handle));            }        }        /// <summary>        /// 資料發送事件        /// </summary>        public event EventHandler<TCPEventArgs> CompletedSend;        /// <summary>        /// 觸發資料發送事件        /// </summary>        /// <param name="state"></param>        private void RaiseCompletedSend(TCPClientHandle handle)        {            if (CompletedSend != null)            {                CompletedSend(this, new TCPEventArgs(handle));            }        }        /// <summary>        /// 網路錯誤事件        /// </summary>        public event EventHandler<TCPEventArgs> NetError;        /// <summary>        /// 觸發網路錯誤事件        /// </summary>        /// <param name="state"></param>        private void RaiseNetError(TCPClientHandle handle)        {            if (NetError != null)            {                NetError(this, new TCPEventArgs(handle));            }        }        /// <summary>        /// 例外狀況事件        /// </summary>        public event EventHandler<TCPEventArgs> OtherException;        /// <summary>        /// 觸發例外狀況事件        /// </summary>        /// <param name="state"></param>        private void RaiseOtherException(TCPClientHandle handle, string descrip)        {            if (OtherException != null)            {                OtherException(this, new TCPEventArgs(descrip, handle));            }        }        private void RaiseOtherException(TCPClientHandle handle)        {            RaiseOtherException(handle, "");        }        #endregion        #region Close        /// <summary>        /// 關閉一個與用戶端之間的會話        /// </summary>        /// <param name="handle">需要關閉的用戶端工作階段對象</param>        public void Close(TCPClientHandle handle)        {            if (handle != null)            {                _clients.Remove(handle);                handle.Dispose();                _clientCount--;                //TODO 觸發關閉事件            }        }        /// <summary>        /// 關閉所有的用戶端工作階段,與所有的用戶端串連會斷開        /// </summary>        public void CloseAllClient()        {            foreach (TCPClientHandle handle in _clients)            {                Close(handle);            }            _clientCount = 0;            _clients.Clear();        }        #endregion        #region 釋放        /// <summary>        /// Performs application-defined tasks associated with freeing,         /// releasing, or resetting unmanaged resources.        /// </summary>        public void Dispose()        {            Dispose(true);            GC.SuppressFinalize(this);        }        /// <summary>        /// Releases unmanaged and - optionally - managed resources        /// </summary>        /// <param name="disposing"><c>true</c> to release         /// both managed and unmanaged resources; <c>false</c>         /// to release only unmanaged resources.</param>        protected virtual void Dispose(bool disposing)        {            if (!this.disposed)            {                if (disposing)                {                    try                    {                        Stop();                        if (_listener != null)                        {                            _listener = null;                        }                    }                    catch (SocketException)                    {                        //TODO 異常                    }                }                disposed = true;            }        }        #endregion    }}

用戶端處理封裝類

using System;using System.Collections.Generic;using System.Linq;using System.Text;using System.Net.Sockets;using System.IO;namespace NetFrame.Net.TCP.Listener.Synchronous{    /// <summary>    /// TcpListener實現同步TCP伺服器 的用戶端串連處理類    /// </summary>    public class TCPClientHandle    {        private TcpClient _tcpclient;        private BinaryReader rs;        private BinaryWriter ws;        /// <summary>        /// 標識是否與用戶端相串連        /// </summary>        private bool _is_connect;        public bool IsConnect        {            get { return _is_connect; }            set { _is_connect = value; }        }        /// <summary>        /// 資料接受緩衝區        /// </summary>        private byte[] _recvBuffer;        public TCPClientHandle(TcpClient client)        {            _tcpclient = client;            rs = new BinaryReader(client.GetStream());            ws = new BinaryWriter(client.GetStream());            // NetworkStream ns = tmpTcpClient.GetStream();            // if(ns.CanRead&&ns.CanWrite)            _recvBuffer=new byte[client.ReceiveBufferSize];        }        /// <summary>        /// 接受資料        /// </summary>        public void RecevieData()        {            int len = 0;            while (_is_connect)            {                try                {                    len = rs.Read(_recvBuffer, 0, _recvBuffer.Length);                }                catch (Exception)                {                    break;                }                if (len == 0)                {                    //the client has disconnected from server                    break;                }                //TODO 處理收到的資料                            }        }        /// <summary>        /// 向用戶端發送資料        /// </summary>        /// <param name="msg"></param>        public void SendData(string msg)        {            byte[] data = Encoding.Default.GetBytes(msg);            try            {                ws.Write(data, 0, data.Length);                ws.Flush();            }            catch (Exception)            {                //TODO 處理異常            }        }        #region 事件        //TODO 訊息發送事件        //TODO 資料收到事件        //TODO 異常處理事件        #endregion        #region 釋放        /// <summary>        /// Performs application-defined tasks associated with freeing,         /// releasing, or resetting unmanaged resources.        /// </summary>        public void Dispose()        {            _is_connect = false;            if (_tcpclient != null)            {                _tcpclient.Close();                _tcpclient = null;            }            GC.SuppressFinalize(this);        }        #endregion    }}

Tcp伺服器事件參數類

using System;using System.Collections.Generic;using System.Linq;using System.Text;namespace NetFrame.Net.TCP.Listener.Synchronous{    /// <summary>    /// 同步TcpListener TCP伺服器事件類別    /// </summary>    public class TCPEventArgs : EventArgs    {        /// <summary>        /// 提示資訊        /// </summary>        public string _msg;        /// <summary>        /// 用戶端狀態封裝類        /// </summary>        public TCPClientHandle _handle;        /// <summary>        /// 是否已經處理過了        /// </summary>        public bool IsHandled { get; set; }        public TCPEventArgs(string msg)        {            this._msg = msg;            IsHandled = false;        }        public TCPEventArgs(TCPClientHandle handle)        {            this._handle = handle;            IsHandled = false;        }        public TCPEventArgs(string msg, TCPClientHandle handle)        {            this._msg = msg;            this._handle = handle;            IsHandled = false;        }    }}

以上就是C#網路編程系列文章(四)之TcpListener實現同步TCP伺服器的內容，更多相關內容請關注topic.alibabacloud.com（www.php.cn）！

