完成端口中的单句柄数据结构与单IO数据结构的理解与设计

本文作者：sodme
本文出处：http://blog.csdn.net/sodme
声明：本文可以不经作者同意任意转载、复制、传播，但任何对本文的引用均须保留本文的作者、出处及本行声明信息！谢谢！

　　完成端口模型，针对于WIN平台的其它异步网络模型而言，最大的好处，除了性能方面的卓越外，还在于完成端口在传递网络事件的通知时，可以一并传递与此事件相关的应用层数据。这个应用层数据，体现在两个方面：一是单句柄数据，二是单IO数据。

　　GetQueuedCompletionStatus函数的原型如下：
　　WINBASEAPI
　　BOOL
　　WINAPI
　　GetQueuedCompletionStatus(
    　　IN  HANDLE CompletionPort,
   　　 OUT LPDWORD lpNumberOfBytesTransferred,
    　　OUT PULONG_PTR lpCompletionKey,
    　　OUT LPOVERLAPPED *lpOverlapped,
    　　IN  DWORD dwMilliseconds
    　);
　　其中，我们把第三个参数lpCompletionKey称为完成键，由它传递的数据称为单句柄数据。我们把第四个参数lpOverlapped称为重叠结构体，由它传递的数据称为单IO数据。

　　以字面的意思来理解，lpCompletionKey内包容的东西应该是与各个socket一一对应的，而lpOverlapped是与每一次的wsarecv或wsasend操作一一对应的。

　　在网络模型的常见设计中，当一个客户端连接到服务器后，服务器会通过accept或AcceptEx创建一个socket，而应用层为了保存与此socket相关的其它信息（比如：该socket所对应的sockaddr_in结构体数据，该结构体内含客户端IP等信息，以及为便于客户端的逻辑包整理而准备的数据整理缓冲区等），往往需要创建一个与该socket一一对应的客户端底层通信对象，这个对象可以负责保存仅在网络层需要处理的数据成员和方法，然后我们需要将此客户端底层通信对象放入一个类似于list或map的容器中，待到需要使用的时候，使用容器的查找算法根据socket值找到它所对应的对象然后进行我们所需要的操作。

　　让人非常高兴的是，完成端口“体贴入微”，它已经帮我们在每次的完成事件通知时，稍带着把该socket所对应的底层通信对象的指针送给了我们，这个指针就是lpCompletionKey。也就是说，当我们从GetQueuedCompletionStatus函数取得一个数据接收完成的通知，需要将此次收到的数据放到该socket所对应的通信对象整理缓冲区内对数据进行整理时，我们已经不需要去执行list或map等的查找算法，而是可以直接定位这个对象了，当客户端连接量很大时，频繁查表还是很影响效率的。哇哦，太帅了，不是吗？呵呵。

　　基于以上的认识，我们的lpCompletionKey对象可以设计如下：
　　typedef struct PER_HANDLE_DATA
　　{
　　　　SOCKET socket;　　　　　　　　　　   //本结构体对应的socket值
　　　　sockaddr_in addr;　　　　　　　　　　//用于存放客户端IP等信息
　　　　char DataBuf[ 2*MAX_BUFFER_SIZE ];　　//整理缓冲区,用于存放每次整理时的数据
　　}

　　PER_HANDLE_DATA与socket的绑定，通过CreateIOCompletionPort完成，将该结构体地址作为该函数的第三个参数传入即可。而PER_HANDLE_DATA结构体中addr成员，是在accept执行成功后进行赋值的。DataBuf则可以在每次WSARecv操作完成，需要整理缓冲区数据时使用。

　　下面我们再来看看完成端口的收、发操作中所使用到的重叠结构体OVERLAPPED。

　　关于重叠IO的知识，请自行GOOGLE相关资料。简单地说，OVERLAPPED是应用层与核心层交互共享的数据单元，如果要执行一个重叠IO操作，必须带有OVERLAPPED结构。在完成端口中，它允许应用层对OVERLAPPED结构进行扩展和自定义，允许应用层根据自己的需要在OVERLAPPED的基础上形成新的扩展OVERLAPPED结构。一般地，扩展的OVERLAPPED结构中，要求放在第一个的数据成员是原OVERLAPPED结构。我们可以形如以下方式定义自己的扩展OVERLAPPED结构：
　　typedef struct PER_IO_DATA
　　{
　　　　OVERLAPPED ovl;
　　　　WSABUF           buf;
　　　　char                    RecvDataBuf[ MAX_BUFFER_SIZE ];   //接收缓冲区
　　　　char                    SendDataBuf[ MAX_BUFFER_SIZE ];   //发送缓冲区
　　　　OpType              opType;                                                       //操作类型：发送、接收或关闭等
　　}
　　
　　在执行WSASend和WSARecv操作时，应用层会将扩展OVERLAPPED结构的地址传给核心，核心完成相应的操作后，仍然通过原有的这个结构传递操作结果，比如“接收”操作完成后，RecvDataBuf里存放便是此次接收下来的数据。

　　根据各自应用的不同，不同的完成端口设计者可能会设计出不同的PER_HANDLE_DATA
和PER_IO_DATA，我这里给出的设计也只是针对自己的应用场合的，不一定就适合你。但我想，最主要的还是要搞明白PER_HANDLE_DATA和PER_IO_DATA两种结构体的含义、用途，以及调用流程。