续 手把手教你玩转网络编程模型之完成例程(Completion Routine)篇（上）
四． 完成例程的实现步骤
基础知识方面需要知道的就是这么多，下面我们配合代码，来一步步的讲解如何亲手实现一个完成例程模型（前面几步的步骤和基于事件通知的重叠I/O方法是一样的）。
【第一步】创建一个套接字，开始在指定的端口上监听连接请求
和其他的SOCKET初始化全无二致，直接照搬即可，在此也不多费唇舌了，需要注意的是为了一目了然，我去掉了错误处理，平常可不要这样啊，尽管这里出错的几率比较小。
- WSADATA wsaData;
- WSAStartup(MAKEWORD(2,2),&wsaData);
-
- ListenSocket = socket(AF_INET,SOCK_STREAM,IPPROTO_TCP);
-
- SOCKADDR_IN ServerAddr;
- ServerAddr.sin_family=AF_INET;
- ServerAddr.sin_addr.S_un.S_addr =htonl(INADDR_ANY);
- ServerAddr.sin_port=htons(11111);
-
-
- bind(ListenSocket,(LPSOCKADDR)&ServerAddr, sizeof(ServerAddr));
-
- listen(ListenSocket, 5);
WSADATA wsaData;
WSAStartup(MAKEWORD(2,2),&wsaData);
ListenSocket = socket(AF_INET,SOCK_STREAM,IPPROTO_TCP); //创建TCP套接字
SOCKADDR_IN ServerAddr; //分配端口及协议族并绑定
ServerAddr.sin_family=AF_INET;
ServerAddr.sin_addr.S_un.S_addr =htonl(INADDR_ANY);
ServerAddr.sin_port=htons(11111); // 在11111端口监听
// 端口号可以随意更改，但最好不要少于1024
bind(ListenSocket,(LPSOCKADDR)&ServerAddr, sizeof(ServerAddr)); // 绑定套接字
listen(ListenSocket, 5); //开始监听
【第二步】接受一个入站的连接请求
一个accept就完了，都是一样一样一样一样的啊~~~~~~~~~~
至于AcceptEx的使用，在完成端口中我会讲到，这里就先不一次灌输这么多了，不消化啊^_^
- AcceptSocket = accept (ListenSocket, NULL,NULL) ;
AcceptSocket = accept (ListenSocket, NULL,NULL) ;
当然，这里是我偷懒，如果想要获得连入客户端的信息（记得论坛上也常有人问到），accept的后两个参数就不要用NULL，而是这样
- SOCKADDR_IN ClientAddr;
- int addr_length=sizeof(ClientAddr);
- AcceptSocket = accept(ListenSocket,(SOCKADDR*)&ClientAddr, &addr_length);
-
- LPCTSTR lpIP = inet_ntoa(ClientAddr.sin_addr);
- UINT nPort = ClientAddr.sin_port;
SOCKADDR_IN ClientAddr; // 定义一个客户端得地址结构作为参数
int addr_length=sizeof(ClientAddr);
AcceptSocket = accept(ListenSocket,(SOCKADDR*)&ClientAddr, &addr_length);
// 于是乎，我们就可以轻松得知连入客户端的信息了
LPCTSTR lpIP = inet_ntoa(ClientAddr.sin_addr); // 连入客户端的 IP
UINT nPort = ClientAddr.sin_port; // 连入客户端的Port
【第三步】准备好我们的重叠结构
有新的套接字连入以后，新建立一个WSAOVERLAPPED重叠结构(当然也可以提前建立好)，准备绑定到我们的重叠操作上去。这里也可以看到和上一篇中的明显区别，就是不用再为WSAOVERLAPPED结构绑定一个hEvent了。
-
- WSAOVERLAPPED AcceptOverlapped；
- ZeroMemory(&AcceptOverlapped, sizeof(WSAOVERLAPPED));
// 这里只定义一个，实际上是每一个SOCKET的每一个操作都需要绑定一个重叠结构的，所以在实际使用面对多个客户端的时候要定义为数组，详见示例代码；
WSAOVERLAPPED AcceptOverlapped；
ZeroMemory(&AcceptOverlapped, sizeof(WSAOVERLAPPED)); // 置零
【第四步】开始在套接字上投递WSARecv请求，需要将第三步准备的WSAOVERLAPPED结构和我们定义的完成例程函数为参数
各个变量都已经初始化OK以后，我们就可以开始进行具体的Socket通信函数调用了，然后让系统内部的重叠结构来替我们管理I/O请求，我们只用等待网络通信完成后调用咱们的回调函数就OK了。
这个步骤的重点就是 绑定一个Overlapped变量和一个完成例程函数
-
-
- if(WSARecv(
- AcceptSocket,
- &DataBuf,
- 1,
- &dwRecvBytes,
- &Flags,
- &AcceptOverlapped,
- _CompletionRoutine) == SOCKET_ERROR)
- {
- if(WSAGetLastError() != WSA_IO_PENDING)
- {
- ReleaseSocket(nSockIndex);
- continue;
- }
- }
- }
// 将WSAOVERLAPPED结构指定为一个参数,在套接字上投递一个异步WSARecv()请求
// 并提供下面的作为完成例程的_CompletionRoutine回调函数(函数名字)
if(WSARecv(
AcceptSocket,
&DataBuf,
1,
&dwRecvBytes,
&Flags,
&AcceptOverlapped,
_CompletionRoutine) == SOCKET_ERROR) // 注意我们传入的回调函数指针
{
if(WSAGetLastError() != WSA_IO_PENDING)
{
ReleaseSocket(nSockIndex);
continue;
}
}
}
【第五步】 调用WSAWaitForMultipleEvents函数或者SleepEx函数等待重叠操作返回的结果
我们在前面提到过，投递完WSARecv操作，并绑定了Overlapped结构和完成例程函数之后，我们基本就是完事大吉了，等了系统自己去完成网络通信，并在接收到数据的时候，会自动调用我们的完成例程函数。
而我们在主线程中需要做的事情只有：做别的事情，并且等待系统完成了完成例程调用后的返回结果。
就是说在WSARecv调用发起完毕之后，我们不得不在后面再紧跟上一些等待完成结果的代码。有两种办法可以实现：
1) 和上一篇重叠I/O中讲到的一样，我们可以使用WSAWaitForMultipleEvent来等待重叠操作的事件通知， 方法如下：
-
-
-
- WSAEVENT EventArray[1];
- EventArray[0] = WSACreateEvent();
-
-
- DWORD dwIndex = WSAWaitForMultipleEvents(1,EventArray,FALSE,WSA_INFINITE,TRUE);
// 因为WSAWaitForMultipleEvents() API要求
// 在一个或多个事件对象上等待, 但是这个事件数组已经不是和SOCKET相关联的了
// 因此不得不创建一个伪事件对象.
WSAEVENT EventArray[1];
EventArray[0] = WSACreateEvent(); // 建立一个事件
////////////////////////////////////////////////////////////////////////////////
// 然后就等待重叠请求完成就可以了，注意保存返回值，这个很重要
DWORD dwIndex = WSAWaitForMultipleEvents(1,EventArray,FALSE,WSA_INFINITE,TRUE);
这里参数的含义我就不细说了，MSDN上一看就明白，调用这个函数以后，线程就会置于一个警觉的等待状态，注意 fAlertable 参数一定要设置为 TRUE。
2) 可以直接使用SleepEx函数来完成等待，效果都是一样的。
SleepEx函数调用起来就简单得多，它的函数原型定义是这样的
- DWORD SleepEx(
- DWORD dwMilliseconds,
- BOOL bAlertable
- );
DWORD SleepEx(
DWORD dwMilliseconds, // 等待的超时时间，如果设置为INFINITE就会一直等待下去
BOOL bAlertable // 是否置于警觉状态，如果为FALSE，则一定要等待超时时间完毕之后才会返回，这里我们是希望重叠操作一完成就能返回，所以同(1)一样，我们一定要设置为TRUE
);
调用这个函数的时候，同样注意用一个DWORD类型变量来保存它的返回值，后面会派上用场。
【第六步】通过等待函数的返回值取得重叠操作的完成结果
这是我们最关心的事情，费了那么大劲投递的这个重叠操作究竟是个什么结果呢？就是通过上一步中我们调用的等待函数的DWORD类型的返回值，正常情况下，在操作完成之后，应该是返回WAIT_IO_COMPLETION，如果返回的是 WAIT_TIMEOUT，则表示等待设置的超时时间到了，但是重叠操作依旧没有完成，应该通过循环再继续等待。如果是其他返回值，那就坏事了，说明网络通信出现了其他异常，程序就可以报错退出了……
判断返回值的代码大致如下：
-
-
- if(dwIndex == WAIT_IO_COMPLETION)
- {
- TRACE("重叠操作完成.../n");
- }
- else if( dwIndex==WAIT_TIMEOUT )
- {
- TRACE(“超时了，继续调用等待函数”);
- }
- else
- {
- TRACE(“废了…”);
- }
///////////////////////////////////////////////////////////////////////////////////
// 返回WAIT_IO_COMPLETION表示一个重叠请求完成例程代码的结束。继续为更多的完成例程服务
if(dwIndex == WAIT_IO_COMPLETION)
{
TRACE("重叠操作完成.../n");
}
else if( dwIndex==WAIT_TIMEOUT )
{
TRACE(“超时了，继续调用等待函数”);
}
else
{
TRACE(“废了…”);
}
操作完成了之后，就说明我们上一个操作已经成功了，成功了之后做什么？当然是继续投递下一个重叠操作了啊…..继续上面的循环。
【第七步】继续回到第四步，在套接字上继续投递WSARecv请求，重复步骤4-7
大家可以参考我的代码，在这里就先不写了，因为各位都一定比我smart，领悟了关键所在以后，稍作思考就可以灵活变通了。
【第八步】“享受”接收到的数据
朋友们看到这里一定会问，我忙活了这么久，那客户端传来的数据在哪里接收啊？怎么一点都没有提到呢……
这个问题问得好，我们写了这么多代码图个什么呢？
其实想要读取客户端的数据很简单，因为我们在WSARecv调用的时候，是传递了一个WSABUF的变量的，用于保存网络数据，而在我们写的完成例程回调函数里面，就可以取到客户端传送来的网络数据了。
因为系统在调用我们完成例程函数的时候，其实网络操作已经完成了，WSABUF里面已经有我们需要的数据了，只是通过完成例程来进行后期的处理。具体可以参考示例代码。 而DataBuf.buf就是一个char*字符串指针，听凭你的处理吧，我就不多说了。
一． 实际应用中应该完善的地方
其实我一直都很想把我以前做的工程中的代码贴出来给大家分享，但是代码实在是太繁杂了，仅仅把网络通信的部分剥离出来，不经过测试的话，肯定还会有其他的很多问题，反而误导了初学者，不过我的计划是在写下一个“完成端口”部分的时候，直接把项目中的一部分代码拿出来试试看吧……
总之网络服务器端程序，在实际应用的时候，关键的几点就是：
1) 要考虑到客户端很多、通信量很大的时候，如何去处理，如何尽可能的减小开销，提高效率；
2) 多个线程之间共用一些变量的时候，一定要注意到同步问题；
3) 作为一个网络程序，出现异常是家常便饭，一定要把代码写得尽可能的健壮，要尽量全面的考虑处理各种各样的错误；
4) 尽量不要出现各种字符缓冲区的问题，写安全的代码，防止被黑客利用……(这点似乎扯远了，但是确实是一个很现实的问题)。
其他的问题，还希望各位这方面的网络专家使劲批评指正，因为代码是很多年前的了，一定存在着很多的问题。
--- Finished at DLUT
--- 2009-02-16
