2016年11月29日 星期二

C# 設定TcpClient連線時的TimeOut

我在設計一個測試主機是否存活的連線方式,通常除了Ping的方式之外,另外一種就是模擬telnet的連線方式,當伺服器的ICMP被關閉時,或是防火牆未開啟ICMP的通道時,Ping Host 就無法成功,但是通常伺服器都會開啟定服務埠來提供外部的服務,例如 Http(80)、DNS(43)、FTP(21)、RDP(3389)、HTTPS(443)、other Http(8080)、1433(SQL)等等。

此時可以透過基本的 Socket Connection 來確定該服務可以連線,基本上若是不存可以連線的埠,則 Connect 會發生拒絕連線的 Exception,但是在透過防火牆後的連線,有可能連拒絕連線的訊息都不會回應,導致 Connection被 Hang住,故在設計 Scoket Connect 時要有 Timeout 的設計,最好可以自己決定 Timeout 時間,但是 Socket 或 TcpClient 都沒有 Connect 的 Timeout 可以去設定,因此我們使用了 BeginConnect 非同步連線 + ManualResetEvent 等待中斷的事件來處理。


using System.Net.NetworkInformation;
using System.Net;
using System.Net.Sockets;
using System.IO;
using System.Threading;

namespace Test
{
    class tcptool
    {
        //可以取得的回覆訊息
        public string ReplyMessage;
     
        private static bool IsConnectionSuccessful = false;
        private static Exception socketexception;
        private static ManualResetEvent TimeoutEvent = new ManualResetEvent(false);

        public bool connectHost(string sHost, int port , bool onlyTest , int timeoutMS)
        {
            //將執行緒通知事件ManualResetEvent設定為未收到訊號,此時進入的事件會持續執行
            TimeoutEvent.Reset();
            socketexception = null;//清除例外承載物件
            TcpClient tcp = new TcpClient();
            ReplyMessage = "";

            try
            {
                //使用非同步連線方式,當連線完成後會通知CallBackMethod事件
                tcp.BeginConnect(sHost, port, new AsyncCallback(CallBackMethod), tcp);
             
                //進入執行緒等候,指定等候時間,並設定false=不在等候前結束處理程序
                //此時TimeoutEvent會等到被Set()並返回true,或是一直等候時間到期,還沒等到set()指令,就會返回false
                if (TimeoutEvent.WaitOne(timeoutMS , false))
                {
                    if (IsConnectionSuccessful)
                    {
                        //連線成功通知
                        NetworkStream stream = new NetworkStream(tcp.Client);
                        StreamWriter sw = new StreamWriter(stream);

                        sw.WriteLine("Hello");// 將資料寫入緩衝
                        sw.Flush(); // 刷新緩衝並將資料上傳到伺服器

                        if (!onlyTest)
                        {
                            //從伺服器接收的資料
                            StreamReader sr = new StreamReader(stream);
                            ReplyMessage = sr.ReadLine();
                        }
                        else
                        {
                            ReplyMessage = "Test successful!";
                        }
                    }
                    else
                    {
                        //沒有連線成功丟出Exception
                        throw socketexception;
                    }
                }
                else
                {
                    //當等候時間逾時
                    tcp.Close();
                    throw new TimeoutException("Time Out Exception !");
                }
            }
            catch (Exception ex)
            {
                ReplyMessage = " Exception:" + ex.Message;
                return false;
            }
            return true;
        }
        /// <summary>
        /// 當連線完成後,進入此事件處理
        /// </summary>
        /// <param name="asyncresult"></param>
        private static void CallBackMethod(IAsyncResult asyncresult)
        {
            try
            {
                IsConnectionSuccessful = false;
                //檢查回傳物件是否存在(存在代表連線成功)
                TcpClient tcpclient = asyncresult.AsyncState as TcpClient;
                if (tcpclient.Client != null)
                {
                    tcpclient.EndConnect(asyncresult);
                    IsConnectionSuccessful = true;
                }
            }
            catch (Exception ex)
            {
                //發生連線意外
                IsConnectionSuccessful = false;
                socketexception = ex;
            }
            finally
            {
                //通知等候結束
                TimeoutObject.Set();
            }
        }
    }
}

這裡要注意的是,如果只是要測試連線存在與否,必須要設定 onlyTest 為 true ,否則遇到某些伺服器沒有回應資料,可能會讓程式 Hang 在 ReplyMessage = sr.ReadLine(); 這一行上面。