C#高性能Socket服务器IOCP实现

引言

我一直在探寻一个高性能的Socket客户端代码。以前,我使用Socket类写了一些基于传统异步编程模型的代码(BeginSend、BeginReceive,等等)也看过很多博客的知识,在linux中有poll和epoll来实现,在windows下面

微软MSDN中也提供了SocketAsyncEventArgs这个类来实现IOCP 地址:https://msdn.microsoft.com/zh-cn/library/system.net.sockets.socketasynceventargs.aspx

看我主页简介免费C++学习资源,视频教程、职业规划、面试详解、学习路线、开发工具

每晚8点直播讲解C++编程技术。

NET Framework中的APM也称为Begin/End模式。这是因为会调用Begin方法来启动异步操作,然后返回一个IAsyncResult 对象。可以选择将一个代理作为参数提供给Begin方法,异步操作完成时会调用该方法。或者,一个线程可以等待 IAsyncResult.AsyncWaitHandle。当回调被调用或发出等待信号时,就会调用End方法来获取异步操作的结果。这种模式很灵活,使用相对简单,在 .NET Framework 中非常常见。

但是,您必须注意,如果进行大量异步套接字操作,是要付出代价的。针对每次操作,都必须创建一个IAsyncResult对象,而且该对象不能被重复使用。由于大量使用对象分配和垃圾收集,这会影响性能。为了解决这个问题,新版本提供了另一个使用套接字上执行异步I/O的方法模式。这种新模式并不要求为每个套接字操作分配操作上下文对象。

代码下载:http://download.csdn.net/detail/zhujunxxxxx/8431289 这里的代码优化了的

目标

在上面微软提供的例子我觉得不是很完整,没有具体一个流程,只是受到客户端消息后发送相同内容给客户端,初学者不容易看懂流程,因为我花了一天的时间来实现一个功能齐全的IOCP服务器,

效果如下

代码

首先是ICOPServer.cs 这个类是IOCP服务器的核心类,目前这个类是网络上比较全的代码,MSDN上面的例子都没有我的全

usingSystem;usingSystem.Collections.Generic;usingSystem.Linq;usingSystem.Text;usingSystem.Net.Sockets;usingSystem.Net;usingSystem.Threading;namespaceServerTest{///

///IOCP SOCKET服务器///publicclassIOCPServer:IDisposable{constintopsToPreAlloc =2;#regionFields//////服务器程序允许的最大客户端连接数///privateint_maxClient;//////监听Socket,用于接受客户端的连接请求///privateSocket _serverSock;//////当前的连接的客户端数///privateint_clientCount;//////用于每个I/O Socket操作的缓冲区大小///privateint_bufferSize =1024;//////信号量///Semaphore _maxAcceptedClients;//////缓冲区管理///BufferManager _bufferManager;//////对象池///SocketAsyncEventArgsPool _objectPool;privatebooldisposed =false;#endregion#regionProperties//////服务器是否正在运行///publicboolIsRunning {get;privateset; }//////监听的IP地址///publicIPAddress Address {get;privateset; }//////监听的端口///publicintPort {get;privateset; }//////通信使用的编码///publicEncoding Encoding {get;set; }#endregion#regionCtors//////异步IOCP SOCKET服务器//////监听的端口///最大的客户端数量publicIOCPServer(intlistenPort,intmaxClient)        :this(IPAddress.Any, listenPort, maxClient){        }//////异步Socket TCP服务器//////监听的终结点///最大客户端数量publicIOCPServer(IPEndPoint localEP,intmaxClient)        :this(localEP.Address, localEP.Port, maxClient){        }//////异步Socket TCP服务器//////监听的IP地址///监听的端口///最大客户端数量publicIOCPServer(IPAddress localIPAddress,intlistenPort,intmaxClient){this.Address = localIPAddress;this.Port = listenPort;this.Encoding = Encoding.Default;            _maxClient = maxClient;            _serverSock =newSocket(localIPAddress.AddressFamily, SocketType.Stream, ProtocolType.Tcp);            _bufferManager =newBufferManager(_bufferSize * _maxClient * opsToPreAlloc, _bufferSize);            _objectPool =newSocketAsyncEventArgsPool(_maxClient);            _maxAcceptedClients =newSemaphore(_maxClient, _maxClient);        }#endregion#region初始化//////初始化函数///publicvoidInit(){// Allocates one large byte buffer which all I/O operations use a piece of. This gaurds // against memory fragmentation_bufferManager.InitBuffer();// preallocate pool of SocketAsyncEventArgs objectsSocketAsyncEventArgs readWriteEventArg;for(inti =0; i < _maxClient; i++)            {//Pre-allocate a set of reusable SocketAsyncEventArgsreadWriteEventArg =newSocketAsyncEventArgs();                readWriteEventArg.Completed +=newEventHandler(OnIOCompleted);                readWriteEventArg.UserToken =null;// assign a byte buffer from the buffer pool to the SocketAsyncEventArg object_bufferManager.SetBuffer(readWriteEventArg);// add SocketAsyncEventArg to the pool_objectPool.Push(readWriteEventArg);            }        }#endregion#regionStart//////启动///publicvoidStart(){if(!IsRunning)            {                Init();                IsRunning =true;                IPEndPoint localEndPoint =newIPEndPoint(Address, Port);// 创建监听socket_serverSock =newSocket(localEndPoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);//_serverSock.ReceiveBufferSize = _bufferSize;//_serverSock.SendBufferSize = _bufferSize;if(localEndPoint.AddressFamily == AddressFamily.InterNetworkV6)                {// 配置监听socket为 dual-mode (IPv4 & IPv6) // 27 is equivalent to IPV6_V6ONLY socket option in the winsock snippet below,_serverSock.SetSocketOption(SocketOptionLevel.IPv6, (SocketOptionName)27,false);                    _serverSock.Bind(newIPEndPoint(IPAddress.IPv6Any, localEndPoint.Port));                }else{                    _serverSock.Bind(localEndPoint);                }// 开始监听_serverSock.Listen(this._maxClient);// 在监听Socket上投递一个接受请求。StartAccept(null);            }        }#endregion#regionStop//////停止服务///publicvoidStop(){if(IsRunning)            {                IsRunning =false;                _serverSock.Close();//TODO 关闭对所有客户端的连接}        }#endregion#regionAccept//////从客户端开始接受一个连接操作///privatevoidStartAccept(SocketAsyncEventArgs asyniar){if(asyniar ==null)            {                asyniar =newSocketAsyncEventArgs();                asyniar.Completed +=newEventHandler(OnAcceptCompleted);            }else{//socket must be cleared since the context object is being reusedasyniar.AcceptSocket =null;            }            _maxAcceptedClients.WaitOne();if(!_serverSock.AcceptAsync(asyniar))            {                ProcessAccept(asyniar);//如果I/O挂起等待异步则触发AcceptAsyn_Asyn_Completed事件//此时I/O操作同步完成,不会触发Asyn_Completed事件,所以指定BeginAccept()方法}        }//////accept 操作完成时回调函数//////Object who raised the event.///SocketAsyncEventArg associated with the completed accept operation.privatevoidOnAcceptCompleted(objectsender, SocketAsyncEventArgs e){            ProcessAccept(e);        }//////监听Socket接受处理//////SocketAsyncEventArg associated with the completed accept operation.privatevoidProcessAccept(SocketAsyncEventArgs e){if(e.SocketError == SocketError.Success)            {                Socket s = e.AcceptSocket;//和客户端关联的socketif(s.Connected)                {try{                        Interlocked.Increment(ref_clientCount);//原子操作加1SocketAsyncEventArgs asyniar = _objectPool.Pop();                        asyniar.UserToken = s;                        Log4Debug(String.Format("客户 {0} 连入, 共有 {1} 个连接。", s.RemoteEndPoint.ToString(), _clientCount));if(!s.ReceiveAsync(asyniar))//投递接收请求{                            ProcessReceive(asyniar);                        }                    }catch(SocketException ex)                    {                        Log4Debug(String.Format("接收客户 {0} 数据出错, 异常信息: {1} 。", s.RemoteEndPoint, ex.ToString()));//TODO 异常处理}//投递下一个接受请求StartAccept(e);                }            }        }#endregion#region发送数据//////异步的发送数据/////////publicvoidSend(SocketAsyncEventArgs e,byte[] data){if(e.SocketError == SocketError.Success)            {                Socket s = e.AcceptSocket;//和客户端关联的socketif(s.Connected)                {                    Array.Copy(data,0, e.Buffer,0, data.Length);//设置发送数据//e.SetBuffer(data, 0, data.Length); //设置发送数据if(!s.SendAsync(e))//投递发送请求,这个函数有可能同步发送出去,这时返回false,并且不会引发SocketAsyncEventArgs.Completed事件{// 同步发送时处理发送完成事件ProcessSend(e);                    }else{                        CloseClientSocket(e);                    }                }            }        }//////同步的使用socket发送数据//////////////////publicvoidSend(Socket socket,byte[] buffer,intoffset,intsize,inttimeout){            socket.SendTimeout =0;intstartTickCount = Environment.TickCount;intsent =0;// how many bytes is already sentdo{if(Environment.TickCount > startTickCount + timeout)                {//throw new Exception("Timeout.");}try{                    sent += socket.Send(buffer, offset + sent, size - sent, SocketFlags.None);                }catch(SocketException ex)                {if(ex.SocketErrorCode == SocketError.WouldBlock ||                    ex.SocketErrorCode == SocketError.IOPending ||                    ex.SocketErrorCode == SocketError.NoBufferSpaceAvailable)                    {// socket buffer is probably full, wait and try againThread.Sleep(30);                    }else{throwex;// any serious error occurr}                }            }while(sent < size);        }//////发送完成时处理函数//////与发送完成操作相关联的SocketAsyncEventArg对象privatevoidProcessSend(SocketAsyncEventArgs e){if(e.SocketError == SocketError.Success)            {                Socket s = (Socket)e.UserToken;//TODO}else{                CloseClientSocket(e);            }        }#endregion#region接收数据//////接收完成时处理函数//////与接收完成操作相关联的SocketAsyncEventArg对象privatevoidProcessReceive(SocketAsyncEventArgs e){if(e.SocketError == SocketError.Success)//if (e.BytesTransferred > 0 && e.SocketError == SocketError.Success){// 检查远程主机是否关闭连接if(e.BytesTransferred >0)                {                    Socket s = (Socket)e.UserToken;//判断所有需接收的数据是否已经完成if(s.Available ==0)                    {//从侦听者获取接收到的消息。 //String received = Encoding.ASCII.GetString(e.Buffer, e.Offset, e.BytesTransferred);//echo the data received back to the client//e.SetBuffer(e.Offset, e.BytesTransferred);byte[] data =newbyte[e.BytesTransferred];                        Array.Copy(e.Buffer, e.Offset, data,0, data.Length);//从e.Buffer块中复制数据出来,保证它可重用stringinfo = Encoding.Default.GetString(data);                        Log4Debug(String.Format("收到 {0} 数据为 {1}", s.RemoteEndPoint.ToString(), info));//TODO 处理数据//增加服务器接收的总字节数。}if(!s.ReceiveAsync(e))//为接收下一段数据,投递接收请求,这个函数有可能同步完成,这时返回false,并且不会引发SocketAsyncEventArgs.Completed事件{//同步接收时处理接收完成事件ProcessReceive(e);                    }                }            }else{                CloseClientSocket(e);            }        }#endregion#region回调函数//////当Socket上的发送或接收请求被完成时,调用此函数//////激发事件的对象///与发送或接收完成操作相关联的SocketAsyncEventArg对象privatevoidOnIOCompleted(objectsender, SocketAsyncEventArgs e){// Determine which type of operation just completed and call the associated handler.switch(e.LastOperation)            {caseSocketAsyncOperation.Accept:                    ProcessAccept(e);break;caseSocketAsyncOperation.Receive:                    ProcessReceive(e);break;default:thrownewArgumentException("The last operation completed on the socket was not a receive or send");            }        }#endregion#regionClose//////关闭socket连接//////SocketAsyncEventArg associated with the completed send/receive operation.privatevoidCloseClientSocket(SocketAsyncEventArgs e){            Log4Debug(String.Format("客户 {0} 断开连接!", ((Socket)e.UserToken).RemoteEndPoint.ToString()));            Socket s = e.UserTokenasSocket;            CloseClientSocket(s, e);        }//////关闭socket连接/////////privatevoidCloseClientSocket(Socket s, SocketAsyncEventArgs e){try{                s.Shutdown(SocketShutdown.Send);            }catch(Exception)            {// Throw if client has closed, so it is not necessary to catch.}finally{                s.Close();            }            Interlocked.Decrement(ref_clientCount);            _maxAcceptedClients.Release();            _objectPool.Push(e);//SocketAsyncEventArg 对象被释放,压入可重用队列。}#endregion#regionDispose//////Performs application-defined tasks associated with freeing,///releasing, or resetting unmanaged resources.///publicvoidDispose(){            Dispose(true);            GC.SuppressFinalize(this);        }//////Releases unmanaged and - optionally - managed resources//////trueto release///both managed and unmanaged resources;false///to release only unmanaged resources.protectedvirtualvoidDispose(booldisposing){if(!this.disposed)            {if(disposing)                {try{                        Stop();if(_serverSock !=null)                        {                            _serverSock =null;                        }                    }catch(SocketException ex)                    {//TODO 事件}                }                disposed =true;            }        }#endregionpublicvoidLog4Debug(stringmsg){            Console.WriteLine("notice:"+ msg);        }    }}

BufferManager.cs 这个类是缓存管理类,是采用MSDN上面的例子一样的 地址: https://msdn.microsoft.com/zh-cn/library/bb517542.aspx

SocketAsyncEventArgsPool.cs 这个类也是来自MSDN的 地址:https://msdn.microsoft.com/zh-cn/library/system.net.sockets.socketasynceventargs.aspx

需要的话自己到MSDN网站上去取,我就不贴出来了

服务器端

staticvoidMain(string[] args){    IOCPServer server =newIOCPServer(8088,1024);    server.Start();    Console.WriteLine("服务器已启动....");    System.Console.ReadLine();}

客户端

客户端代码也是很简单

staticvoidMain(string[] args){    IPAddress remote = IPAddress.Parse("192.168.3.4");    client c =newclient(8088, remote);    c.connect();    Console.WriteLine("服务器连接成功!");while(true)    {        Console.Write("send>");stringmsg = Console.ReadLine();if(msg =="exit")break;        c.send(msg);    }    c.disconnect();    Console.ReadLine();}

client.cs

publicclassclient{publicTcpClient _client;publicintport;publicIPAddress remote;publicclient(intport, IPAddress remote){this.port = port;this.remote = remote;    }publicvoidconnect(){this._client =newTcpClient();        _client.Connect(remote, port);    }publicvoiddisconnect(){        _client.Close();    }publicvoidsend(stringmsg){byte[] data = Encoding.Default.GetBytes(msg);        _client.GetStream().Write(data,0, data.Length);    }}

IOCPClient类,使用SocketAsyncEventArgs类建立一个Socket客户端。虽然MSDN说这个类特别设计给网络服务器应用,但也没有限制在客户端代码中使用APM。下面给出了IOCPClient类的样例代码:

publicclassIOCPClient{///

///连接服务器的socket///privateSocket _clientSock;//////用于服务器执行的互斥同步对象///privatestaticMutex mutex =newMutex();//////Socket连接标志///privateBoolean _connected =false;privateconstintReceiveOperation =1, SendOperation =0;privatestaticAutoResetEvent[]    autoSendReceiveEvents =newAutoResetEvent[]    {newAutoResetEvent(false),newAutoResetEvent(false)    };//////服务器监听端点///privateIPEndPoint _remoteEndPoint;publicIOCPClient(IPEndPoint local, IPEndPoint remote){        _clientSock =newSocket(local.AddressFamily, SocketType.Stream, ProtocolType.Tcp);        _remoteEndPoint = remote;    }#region连接服务器//////连接远程服务器///publicvoidConnect(){        SocketAsyncEventArgs connectArgs =newSocketAsyncEventArgs();        connectArgs.UserToken = _clientSock;        connectArgs.RemoteEndPoint = _remoteEndPoint;        connectArgs.Completed +=newEventHandler(OnConnected);        mutex.WaitOne();if(!_clientSock.ConnectAsync(connectArgs))//异步连接{            ProcessConnected(connectArgs);        }    }//////连接上的事件/////////voidOnConnected(objectsender, SocketAsyncEventArgs e){        mutex.ReleaseMutex();//设置Socket已连接标志。 _connected = (e.SocketError == SocketError.Success);    }//////处理连接服务器//////privatevoidProcessConnected(SocketAsyncEventArgs e){//TODO}#endregion#region发送消息//////向服务器发送消息//////publicvoidSend(byte[] data){        SocketAsyncEventArgs asyniar =newSocketAsyncEventArgs();        asyniar.Completed +=newEventHandler(OnSendComplete);        asyniar.SetBuffer(data,0, data.Length);        asyniar.UserToken = _clientSock;        asyniar.RemoteEndPoint = _remoteEndPoint;        autoSendReceiveEvents[SendOperation].WaitOne();if(!_clientSock.SendAsync(asyniar))//投递发送请求,这个函数有可能同步发送出去,这时返回false,并且不会引发SocketAsyncEventArgs.Completed事件{// 同步发送时处理发送完成事件ProcessSend(asyniar);        }    }//////发送操作的回调方法/////////privatevoidOnSendComplete(objectsender, SocketAsyncEventArgs e){//发出发送完成信号。 autoSendReceiveEvents[SendOperation].Set();        ProcessSend(e);    }//////发送完成时处理函数//////与发送完成操作相关联的SocketAsyncEventArg对象privatevoidProcessSend(SocketAsyncEventArgs e){//TODO}#endregion#region接收消息//////开始监听服务端数据//////publicvoidStartRecive(SocketAsyncEventArgs e){//准备接收。 Socket s = e.UserTokenasSocket;byte[] receiveBuffer =newbyte[255];        e.SetBuffer(receiveBuffer,0, receiveBuffer.Length);        e.Completed +=newEventHandler(OnReceiveComplete);        autoSendReceiveEvents[ReceiveOperation].WaitOne();if(!s.ReceiveAsync(e))        {            ProcessReceive(e);        }    }//////接收操作的回调方法/////////privatevoidOnReceiveComplete(objectsender, SocketAsyncEventArgs e){//发出接收完成信号。 autoSendReceiveEvents[ReceiveOperation].Set();        ProcessReceive(e);    }//////接收完成时处理函数//////与接收完成操作相关联的SocketAsyncEventArg对象privatevoidProcessReceive(SocketAsyncEventArgs e){if(e.SocketError == SocketError.Success)        {// 检查远程主机是否关闭连接if(e.BytesTransferred >0)            {                Socket s = (Socket)e.UserToken;//判断所有需接收的数据是否已经完成if(s.Available ==0)                {byte[] data =newbyte[e.BytesTransferred];                    Array.Copy(e.Buffer, e.Offset, data,0, data.Length);//从e.Buffer块中复制数据出来,保证它可重用//TODO 处理数据}if(!s.ReceiveAsync(e))//为接收下一段数据,投递接收请求,这个函数有可能同步完成,这时返回false,并且不会引发SocketAsyncEventArgs.Completed事件{//同步接收时处理接收完成事件ProcessReceive(e);                }            }        }    }#endregionpublicvoidClose(){        _clientSock.Disconnect(false);    }//////失败时关闭Socket,根据SocketError抛出异常。//////privatevoidProcessError(SocketAsyncEventArgs e){        Socket s = e.UserTokenasSocket;if(s.Connected)        {//关闭与客户端关联的Sockettry{                s.Shutdown(SocketShutdown.Both);            }catch(Exception)            {//如果客户端处理已经关闭,抛出异常 }finally{if(s.Connected)                {                    s.Close();                }            }        }//抛出SocketException thrownewSocketException((Int32)e.SocketError);    }//////释放SocketClient实例///publicvoidDispose(){        mutex.Close();        autoSendReceiveEvents[SendOperation].Close();        autoSendReceiveEvents[ReceiveOperation].Close();if(_clientSock.Connected)        {            _clientSock.Close();        }    }}

这个类我没有测试,但是理论上是没问题的。

看我主页简介免费C++学习资源,视频教程、职业规划、面试详解、学习路线、开发工具

每晚8点直播讲解C++编程技术。

你可能感兴趣的:(C#高性能Socket服务器IOCP实现)