C# Socket连接请求超时机制

转自：http://www.cnblogs.com/weidagang2046/archive/2009/02/07/1385977.html
作者：RazanPaul
译者：Todd Wei
原文：http://www.codeproject.com/KB/IP/TimeOutSocket.aspx
介绍
您可能注意到了，.Net的System.Net.Sockets.TcpClient和System.Net.Sockets.Socket都没有直接为Connect/BeginConnect提供超时控制机制。因此，当服务器未处于监听状态，或者发生网络故障时，客户端连接请求会被迫等待很长一段时间，直到抛出异常。默认的等待时间长达20~30s。.Net Socket库的SocketOptionName.SendTimeout提供了控制发送数据的超时时间，但并非本文讨论的连接请求的超时时间。
背景
这个问题最初源于我的某个项目，在解决以后，我曾将关键代码发表在自己的博客上。我注意到不少人对此表示感谢，所以我想这是一个常见的问题，或许很多人都需要解决它。
实现
下面是实现的关键代码：

[csharp]  view plain copy print ?

1. class TimeOutSocket  
2. {  
3.     private static bool IsConnectionSuccessful= false;  
4.     private static Exception socketexception;  
5.     private static ManualResetEvent TimeoutObject= new ManualResetEvent(false);  
6.   
7.     public static TcpClient Connect(IPEndPoint remoteEndPoint,int timeoutMSec)  
8.     {  
9.         TimeoutObject.Reset();  
10.         socketexception = null;  
11.   
12.         string serverip= Convert.ToString(remoteEndPoint.Address);  
13.         int serverport= remoteEndPoint.Port;            
14.         TcpClient tcpclient = new TcpClient();  
15.          
16.         tcpclient.BeginConnect(serverip, serverport,  
17.             new AsyncCallback(CallBackMethod), tcpclient);  
18.   
19.         if (TimeoutObject.WaitOne(timeoutMSec,false))  
20.         {  
21.             if (IsConnectionSuccessful)  
22.             {  
23.                 return tcpclient;  
24.             }  
25.             else  
26.             {  
27.                 throw socketexception;  
28.             }  
29.         }  
30.         else  
31.         {  
32.             tcpclient.Close();  
33.             throw new TimeoutException("TimeOut Exception");  
34.         }  
35.     }  
36.     private static void CallBackMethod(IAsyncResult asyncresult)  
37.     {  
38.         try  
39.         {  
40.             IsConnectionSuccessful = false;  
41.             TcpClient tcpclient = asyncresult.AsyncStateas TcpClient;  
42.               
43.             if (tcpclient.Client!= null)  
44.             {  
45.                 tcpclient.EndConnect(asyncresult);  
46.                 IsConnectionSuccessful = true;  
47.             }  
48.         }  
49.         catch (Exception ex)  
50.         {  
51.             IsConnectionSuccessful = false;  
52.             socketexception = ex;  
53.         }  
54.         finally  
55.         {  
56.             TimeoutObject.Set();  
57.         }  
58.     }  
59. }  

这里，ManualResetEvent的WaitOne(TimeSpan, Boolean)起到了主要的作用。它将阻止当前线程，直到ManualResetEvent对象被Set或者超过timeout时间。上面的代码中，调用BeginConnect后通过WaitOne方法阻止当前线程，如果在timeoutMSec时间内连接成功，将在CallBackMethod回调中调用TimeoutObject.Set，解除被阻塞的连接线程并返回；否则，连接线程会在等待超时后，主动关闭连接并抛出TimeoutException。
总结
虽然实现非常简单，但或许很多人都需要连接请求超时机制，如果有任何问题，我会尽力为您解答。
[译注]
作者介绍了一种异步连接+WaitOne的连接请求超时机制。其中的实现细节有值得商榷的地方，比如：a.static成员带来的线程安全性问题；b.可以考虑利用IAsyncResult.AsyncWaitHandle，不必另行创建ManualResetEvent。但瑕不掩瑜，感谢作者的解决思路。
------------------------ gdjlc备注 -----------------------------------------
如果不用TcpClient，直接用Socket，可改为：

[csharp]  view plain copy print ?

1. class TimeOutSocket  
2.        {  
3.            private static bool IsConnectionSuccessful = false;  
4.            private static Exception socketexception;  
5.            private static System.Threading.ManualResetEvent TimeoutObject = new System.Threading.ManualResetEvent(false);  
6.   
7.            public static Socket Connect(IPEndPoint remoteEndPoint, int timeoutMSec)  
8.            {  
9.                TimeoutObject.Reset();  
10.                socketexception = null;       
11.          
12.                Socket socketClient = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);  
13.                socketClient.BeginConnect(remoteEndPoint, new AsyncCallback(CallBackMethod), socketClient);  
14.   
15.                if (TimeoutObject.WaitOne(timeoutMSec, false))  
16.                {  
17.                    if (IsConnectionSuccessful)  
18.                        return socketClient;  
19.                    else  
20.                        throw socketexception;                       
21.                }  
22.                else  
23.                {  
24.                    socketClient.Close();  
25.                    throw new TimeoutException("TimeOut Exception");                      
26.                }  
27.   
28.            }  
29.            private static void CallBackMethod(IAsyncResult asyncresult)  
30.            {  
31.                try  
32.                {  
33.                    IsConnectionSuccessful = false;  
34.                    Socket socketClient = asyncresult.AsyncState as Socket;  
35.   
36.                    if (socketClient != null)  
37.                    {  
38.                        socketClient.EndConnect(asyncresult);  
39.                        IsConnectionSuccessful = true;  
40.                    }  
41.                }  
42.                catch (Exception ex)  
43.                {  
44.                    IsConnectionSuccessful = false;  
45.                    socketexception = ex;  
46.                }  
47.                finally  
48.                {  
49.                    TimeoutObject.Set();  
50.                }  
51.            }  
52.        }