四.Windows I/O模型之重叠IO(overlapped)模型

1.适用于除Windows CE之外的各种Windows平台.在使用这个模型之前应该确保该系统安装了Winsock2.重叠模型的基本设计原理是使用一个重叠的数据结构，一次投递一个或多个Winsock I/O请求。在重叠模型中，收发数据使用WSA开头的函数。

2.WSA_FLAG_OVERLAPPED标志:要使用重叠模型。在创建套接字的时候，必须加上该标志。
SOCKET s=WSASocket(AF_INET,SOCK_STREAM,0,NULL,0,WSA_FLAG_OVERLAPPED);
假如使用的是socket函数，而非WSASocket函数，那么会默认设置WSA_FLAG_OVERLAPPED标志。
若随一个WSAFLAGOVERLAPPED结构一起调用这些以WSA开头的函数(AcceptEx和TRansmiteFile函数例外)，函数会立即完成并返回，无论套接字是否设为阻塞模式

3.重叠模型在网络事件完成后，可以有两种方式通知应用程序：事件通知和完成例程

3.事件通知:事件对象与WSAOVERLAPPED进行绑定实现网络事件完成后通过事件进行通知。

4.WSAOVERLAPPED结构:
typedef struct WSAOverlapped
{
    DWORD Internal;
    DOWRD InternalHigh;
    DWORD Offset;
    DWORD OffsetHigh;
    WSAEVENT hEvent;
}WSAOVERLAPPED,FAR* LPWSAOVERLAPPED;
此处，程序员可以使用的是最后一个参数hEvent，其余的不用管。通过该参数，重叠结构可以与事件对象进行绑定，以实现网络事件完成后，通过事件对象进行通知应用程序。事件对象通知方式是通过创建一个事件对象，把该对象赋值给重叠结构的hEvent参数即可实现绑定。在此再次提醒大家注意：WSAWaitForMultipleEvents函数一次最多只能等待64个事件对象。

5.WSAGetOverlappedResult函数:重叠请求完成后，接着需要调用WSAGetOverlappedResult（取得重叠结构）函数，判断那个重叠调用到底是成功，还是失败.
BOOL WSAGetOverlappedResult(
    SOCKET s,//套接字
    LPWSAOVERLAPPED lpOverlapped,//重叠结构
    LPDWORD lpcbTransfer,//对应一个DWORD（双字节）变量，一次重叠实际传输(接收或者发送)的字节数
    BOOL fWait,//参数用于决定函数是否应该等待一次重叠操作完成。
    LPWORD lpdwFlags
    );
重叠操作完成，函数返回TRUE,否则，返回FALSE。返回FALSE通常都是有一下几种情况造成的.
(1)重叠I/O操作仍处在未完成状态
(2)重叠操作已经完成，但含有错误
(3)重叠操作的完成状态不可判决，因为在提供给函数WSAGetOverlappedResult的一个或多个参数中，存在着错误。
失败后，由lpcbTransfer参数指向的值不会进行更新，而且我们的应用程序应调用WSAGetLastError函数


6.基于事件通知的重叠模型编程步骤如下:
(1) 创建一个套接字,绑定本机端口，在指定的端口上监听连接请求。
(2)接受连接请求。
(3)为接受的套接字新建一个WSAOVERLAPPED结构，并为该结构分配一个事件对象句柄。也将事件对象句柄分配给一个事件数组，以便稍后由函数WSAWaitForMultipleEvents使用。
(4)在套接字上投递一个异步WSARecv请求，指定参数为WSAOVERLAPPED结构。注意函数通常会以失败告终，返回SOCKETERROR错误状态WSAIOPENDING（I/O操作尚未完成）。
(5)使用步骤3)的事件数组，调用WSAWaitForMultipleEvents函数，并等待与重叠调用关联在一起的事件进入“已传信”状态（换言之，等待那个事件的“触发”）。
(6)WSAWaitForMultipleEvents函数完成后，针对事件数组，调用WSAResetEvent（重设事件）函数，从而重设事件对象，并对完成的重叠请求进行处理。
(7)使用WSAGetOverlappedResult函数，判断重叠调用的返回状态是什么。
(8)在套接字上投递另一个重叠WSARecv请求。
(9)重复步骤5 ) ~ 8 )。

示例代码:

void main(void)
{
    WSABUF databuf;
    DWORD eventTotal=0;
    WSAEVENT eventArray[WSA_MAXIMUM_WAIT_EVENTS];
    WSAOVERLAPPED acceptOverlapped;
    SOCKET listensock,acceptsock;


    //初始化工作和一般socket通信相同 
    ...

    //接收连接
    acceptsock=accept(listensock,NULL,NULL);

    //创建事件，绑定事件对象与重叠结构
    eventArray[eventTotal]=WSACreateEvent();
    ZeroMemory(&acceptOverlapped,sizeof(WSAOVERLAPPED));
    acceptOverlapped.hEvent=eventArray[eventTotal];

    //数据缓冲区初始化
    databuf.len=DATA_BUFSIZE;
    databuf.buf=buffer;

    eventTotal++;

    //投递接收请求
    WSARecv(acceptsock,&databuf,1,&recvBytes,&flags,&acceptOverlapped,NULL);

    while(1)
    {
        //监视事件对象状态
        index=WSAWaitForMultipleEvents(eventTotal,eventArray,FALSE,WSA_INFINITE,FALSE);

        //人工充值事件
        WSAResetEvent(eventArray[eventTotal-WSA_WAIT_EVENT_0]);

        //获取I/O操作的完成情况
        WSAGetOverlappedResult(acceptsock,&acceptOverlapped,&bytesTransferred,FALSE,&flag);

        if(bytesTransferred==0)
        {
            closesocket(acceptsock);
            WSACloseEvent(eventArray[eventTotal-WSA_WAIT_EVENT_0]);
            return;
        }

        //处理接收过来的数据
        ...

        //再再次发送一个WSARecv请求
        flag=0;
        ZeroMemory(&acceptOverlapped,sizeof(WSAOVERLAPPED));

        databuf.LEN=DATA_BUFSIZE;
        databuf.buf=buf;
        WSARecv(acceptsock,&databuf,1,&recvbytes,&flag,&acceptOverlapped,NULL);
    }
    
}

注意:对于接受客户端连接的函数，还有一个AcceptEx函数，不过这个函数太过麻烦且对性能的提升没有太大的作用，暂时不打算学习

 

接下来学习基于完成例程的重叠IO模型:

7.基于完成例程的重叠模型的实现:
完成例程也就是回调函数。这种方式，就是设置一个回调函数，I/O请求完成后，自动调用回调函数即可。如果希望用完成例程为重叠I/O请求提供服务，在我们的应用程序中，必须为指定一个完成例程(回调函数)，同时指定一个WSAOVERLAPPED结构。一个完成例程(回调函数)必须拥有下述函数原型：

void CALLBACK CompletionROUTINE(
    DWORD dwError,//表明一个重叠操作的完成状态是什么
    DWORD cdTransferred,//参数指定了在重叠操作期间，实际传输的字节量是多大
    LPWSAOVERLAPPED lpOverlapped,//重叠结构
    DWORD dwFlags//目前尚未使用，应设为0
    );

8.基于完成例程和基于事件对象两种重叠模型之间的差异:在使用完成重叠模型时，WSAOVERLAPPED结构的事件字段hEvent并未使用；也就是说，我们不可将一个事件对象同重叠请求关联到一起。用完成例程发出了一个重叠I/O请求之后，作为我们的调用线程，一旦完成，它最终必须为完成例程提供服务。这样一来，便要求我们将自己的调用线程置于一种“可警告的等待状态”。并在I/O操作完成后，对完成例程加以处理。WSAWaitForMultipleEvents函数可用来将我们的线程置于一种可警告的等待状态。这样做的缺点在于，我们还必须有一个事件对象可用于WSAWaitForMultipleEvents函数。假定应用程序只用完成例程对重叠请求进行处理，便不可能有任何事件对象需要处理。作为一种变通方法，我们的应用程序可用Win32的SleepEx函数将自己的线程置为一种可警告等待状态。当然，亦可创建一个伪事件对象，不将它与任何东西关联在一起。假如调用线程经常处于繁忙状态，而且并不处在一种可警告的等待状态，那么根本不会有投递的完成例
程会得到调用。
SleepEx函数的行为实际上和WSAWaitForMultipleEvents差不多，只是它不需要任何事件对象。
9.SleepEx函数:

DWORD SleepEx(
    DWORD dwMillisecond,//等待时间
    BOOL bAlertable,//指定完成例程的执行方式
    )

第二个参数是否置于警觉状态，如果为FALSE，则一定要等待超时时间完毕之后才会返回，这里我们是希望重叠操作一完成就能返回，所以我们要设置为TRUE

10.window下，管理重叠io有三种方式:基于事件的重叠io模型，基于完成例程的重叠io模型，完成端口模型，相比之下，在性能方面前两种方式没有区别，第三种完成端口模型性能最优。因为前两种都需要自己来管理任务的分派，而完成端口是操作系统来管理任务的分派。虽然第一二中Io模型在性能上没有区别。但是，基于事件的重叠io模型要受到最多64个等待事件的限制。完成例程则没有这种限制。
11.完成历程的基本原理：在基于事件的重叠io模型中，io操作完成后，系统会以事件的方式通知应用程序。而对于完成例程来说，系统会在io操作完成后，直接调用应用程序提供的回调函数。区别也就仅此而已。对于完成例程，我们可以用一种非常形象的话来进行表述:完成例程的处理过程，也就像我们告诉系统，说“我想要在网络上接收网络数据，你去帮我办一下”（投递WSARecv操作），“不过我并不知道网络数据合适到达，总之在接收到网络数据之后，你直接就调用我给你的这个函数(比如_CompletionProess)，把他们保存到内存中或是显示到界面中等等，全权交给你处理了”，于是乎，系统在接收到网络数据之后，一方面系统会给我们一个通知，另外同时系统也会自动调用我们事先准备好的回调函数，就不需要我们自己操心了。
12.完成例程的函数基本上和基于事件的io模型的函数是相同的。只是在这里我们需要添加一个回调函数。回调函数原型如下：（函数名字随便起，但是参数类型不能错）：

    Void CALLBACK _CompletionRoutineFunc(
    DWORD dwError, // 标志咱们投递的重叠操作，比如WSARecv，完成的状态是什么
    DWORD cbTransferred, // 指明了在重叠操作期间，实际传输的字节量是多大
    LPWSAOVERLAPPED lpOverlapped, // 参数指明传递到最初的IO调用内的一个重叠结构
    DWORD dwFlags  // 返回操作结束时可能用的标志(一般没用)

);

13.定义了回调函数之后，还需要把回调函数与系统绑定之后，网络操作完成后才会自动调用回调函数。例如WSARecv绑定过程如下：

    int WSARecv(
    SOCKET s,            // 当然是投递这个操作的套接字
    LPWSABUF lpBuffers,  // 接收缓冲区，与Recv函数不同，这里需要一个由WSABUF结构构成的数组
    DWORD dwBufferCount, // 数组中WSABUF结构的数量，设置为1即可
    LPDWORD lpNumberOfBytesRecvd,//所接收到的字节数
    LPDWORD lpFlags,             // 说来话长了，我们这里设置为0 即可
    LPWSAOVERLAPPED lpOverlapped,  // “绑定”的重叠结构
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine //回调函数的指针
    ); 

    //注意：绑定动作就是通过填充最后一个参数进行实现的。
14.完成例程的实现步骤:
(1)创建一个套接字，开始在指定的端口上监听连接请求
(2)接收连接请求即调用accept函数，生成一个新的socket套接字
(3)准备重叠结构：需要注意的是，一个套接字对应一个或者多个io请求，一个io请求对应一个重叠结构
    WSAOVERLAPPED AcceptOverlapped；  
    ZeroMemory(&AcceptOverlapped, sizeof(WSAOVERLAPPED));      // 置零
(4)投递io请求（此处为WSARecv请求），使用重叠结构，回调函数填充参数:
    WSARecv(AcceptSocket,&DataBuf,1,&dwRecvBytes, &Flags,&AcceptOverlapped,_CompletionRoutine)
(5)重叠操作绑定完成后，接下来就是等待io请求的完成结果。有两种方式可以实现：调用WSAWaitForMultipleEvents函数或者SleepEx函数。

    通过WaitForMultipleEvents函数等待
    WSAEVENT EventArray[1];      
    EventArray[0] = WSACreateEvent();// 建立一个事件
    // 然后就等待重叠请求完成就可以了，注意保存返回值，这个很重要
    DWORD dwIndex = WSAWaitForMultipleEvents(1,EventArray,FALSE,WSA_INFINITE,TRUE);//注意fAlertable 参数即该函数最后                                            一个参数一定要设置为 TRUE
    通过SleepEx函数进行等待，效果是一样的：
    DWORD SleepEx(DWORD dwMilliseconds,  // 等待的超时时间，如果设置为INFINITE就会一直等待下去
              BOOL   bAlertable   // 是否置于警觉状态，如果为FALSE，则一定要等待超时时间完毕之后才会返回，这里我们是希望重叠操作一完成就能返回，所以同(1)一样，我们一定要设置为TRUE
              ); 

(6)通过等待函数的返回值取得io请求的结果:在等待函数中，正常情况下，在操作完成之后，应该是返回WAIT_IO_COMPLETION，如果返回的是 WAIT_TIMEOUT，则表示等待设置的超时时间到了，但是重叠操作依旧没有完成，应该通过循环再继续等待。如果是其他返回值，那就坏事了，说明网络通信出现了其他异常，程序就可以报错退出了

    if(dwIndex == WAIT_IO_COMPLETION)
    {
    TRACE("重叠操作完成.../n");
    }
    else if( dwIndex==WAIT_TIMEOUT )
    {
    TRACE(“超时了，继续调用等待函数”);
    }
    else
    {
        TRACE(“废了…”);
    }

(7)投递下一个io请求，重复4-7
15.读取io请求的最终结果数据：在WSARecv调用的时候，是传递了一个WSABUF的变量的，用于保存网络数据，而在我们写的完成例程回调函数里面，就可以取到客户端传送来的网络数据了。因为系统在调用我们完成例程函数的时候，其实网络操作已经完成了，WSABUF里面已经有我们需要的数据了，只是通过完成例程来进行后期的处理
示例代码:

//完成例程实现重叠io模型伪代码
SOCKET acceptSock;
WSABUF dataBuf;

void main()
{
    WSAOVERLAPPED overlapped;
    //1.初始化
    //...

    //2.接收连接请求
    acceptSock=accept(listenSock,NULL,NULL);

    //3.初始化重叠结构
    UINT flag=0;
    ZeroMemory(&overlapped,sizeof(WSAOVERLAPPED));
    dataBuf.len=DATA_BUFSIZE;
    dataBuf.buf=buf;

    if (WSARecv(acceptSock,&dataBuf,1,&recvBytes,&flag,&overlapped,workroutine)==SOCKET_ERROR)//最后一个参数时回调函数地址
    {
        if(WSAGetLastError()!=WSA_IO_PENDING)
        {
            printf("WSARecv() failed with error %d\n",WSAGetLastError());
            return;
        }
    }
    
    //创建事件
    eventArray[0]=WSACreateEvent();
    while (true)
    {
        int index=WSAWaitForMultipleEvents(1,eventArray,FALSE,WSA_INFINITE,TRUE);//最后一个参数最好为true
        if (index==WAIT_IO_COMPLETION)//io请求完成
        {
            break;
        }
        else//io请求出错
        {
            return;
        }
    }
    //调用回调函开始进行处理
}

void CALLBACK WorkRoutine(DWORD error,DWORD bytesTransferred,LPWSAOVERLAPPED overlapped,DWORD inflag)
{
    DWORD sendBytes,recvBytes;
    DWORD flags;

    if(error!=0||bytesTransferred==0)
    {
        closesocket(acceptSock);
        return;
    }

    flags=0;

    ZeroMemory(&overlapped,sizeof(WSAOVERLAPPED));
    dataBuf.len=DATA_BUFSIZE;
    dataBuf.data=buf;

    if (WSARecv(acceptSock,&dataBuf,1,&recvBytes,&flag,&overlapped,workroutine)==SOCKET_ERROR)//最后一个参数时回调函数地址
    {
        if(WSAGetLastError()!=WSA_IO_PENDING)
        {
            printf("WSARecv() failed with error %d\n",WSAGetLastError());
            return;
        }
    }
}