#22_BasicTaskScheduler基本任务调度器（二）——Live555源码阅读(一)任务调度相关类
[TOC]
这是Live555源码阅读的第二部分，包括了任务调度相关的三个类。任务调度是Live555源码中很重要的部分。
本文由乌合之众 lym瞎编，欢迎转载 my.oschina.net/oloroso
##SingleStep方法
这是这里最重要的一个方法。每一次调用都是一次真正的处理数据的过程。 前面的延时队列DelayQueue、处理程序链表HanlerSet、触发器数组fTriggeredEventHandlers和fTriggeredEventClientDatas都是在这里被真正的调度起来的。 这一段的代码很长，过程有点多。要联系了前面讲过的内容来看才能比较好理解。这里要注意的fLastHandledSocketNum成员的操作。因为其在别的位置都没有修改过，只在这里轮询处理的时候，如果有处理了fHandlers中某个节点的时候才会去设置。再一个要思考的是，fHandlers中的元素是**从何而来的？**在BasicTaskScheduler的两个基类中都没有对fHandlers成员有相关的操作。
这个函数做了三件事情。
-
获取延时队列头结点的延时剩余时间，作为select操作的超时时间。调用select监控三个集合。 如果select调用成功了，那么就开始轮询HandlerSet对象fHandlers中的节点，有符合条件的就使用其内部保存的函数指针和数据指针以及条件掩码来调用函数。
-
处理等待触发事件集里面的事件。
-
处理延时队列中到达延时时间的节点。
void BasicTaskScheduler::SingleStep(unsigned maxDelayTime) { //拷贝三个集合去给select调用做参数 fd_set readSet = fReadSet; // make a copy for this select() call fd_set writeSet = fWriteSet; // ditto fd_set exceptionSet = fExceptionSet; // ditto //获取延时队列头结点的延时剩余时间(作为select超时时间) DelayInterval const& timeToDelay = fDelayQueue.timeToNextAlarm(); struct timeval tv_timeToDelay; tv_timeToDelay.tv_sec = timeToDelay.seconds(); tv_timeToDelay.tv_usec = timeToDelay.useconds(); // Very large "tv_sec" values cause select() to fail. // Don't make it any larger than 1 million seconds (11.5 days) // 控制在1百万秒以内 const long MAX_TV_SEC = MILLION; if (tv_timeToDelay.tv_sec > MAX_TV_SEC) { tv_timeToDelay.tv_sec = MAX_TV_SEC; } // Also check our "maxDelayTime" parameter (if it's > 0): if (maxDelayTime > 0 && (tv_timeToDelay.tv_sec > (long)maxDelayTime / MILLION || (tv_timeToDelay.tv_sec == (long)maxDelayTime / MILLION && tv_timeToDelay.tv_usec > (long)maxDelayTime%MILLION))) { tv_timeToDelay.tv_sec = maxDelayTime / MILLION; tv_timeToDelay.tv_usec = maxDelayTime%MILLION; }
1//调用select来监控集合 2int selectResult = select(fMaxNumSockets, &readSet, &writeSet, &exceptionSet, &tv_timeToDelay);//------------------------------------------------------------------------------------------ //select出错返回，处理错误 if (selectResult < 0) { #if defined(WIN32) || defined(_WIN32) int err = WSAGetLastError(); // For some unknown reason, select() in Windoze sometimes fails with WSAEINVAL if // it was called with no entries set in "readSet". If this happens, ignore it: if (err == WSAEINVAL && readSet.fd_count == 0) { err = EINTR; // To stop this from happening again, create a dummy socket: int dummySocketNum = socket(AF_INET, SOCK_DGRAM, 0); FD_SET((unsigned)dummySocketNum, &fReadSet); } if (err != EINTR) { #else if (errno != EINTR && errno != EAGAIN) { #endif // Unexpected error - treat this as fatal: #if !defined(_WIN32_WCE) perror("BasicTaskScheduler::SingleStep(): select() fails"); #endif //内部错误，调用abort() internalError(); } } //----------------------------------------------------------------------------- //开始处理 // Call the handler function for one readable socket: HandlerIterator iter(fHandlers); HandlerDescriptor handler; // To ensure forward progress through the handlers, begin past the last // socket number that we handled: //注意fLastHandledSocketNum如果不为-1，说明已经调度过某些任务了 if (fLastHandledSocketNum >= 0) { while ((handler = iter.next()) != NULL) { //从链表中找上一次最后调度的处理程序描述对象 if (handler->socketNum == fLastHandledSocketNum) break; } if (handler == NULL) { fLastHandledSocketNum = -1; //没有找到 iter.reset(); // start from the beginning instead 迭代器回到起点 } } //轮询处理 //如果上面最后一个Handle == NULL成立了，那么这里不会进入，iter.next()还是会返回NULL //也就是说上次最后被调度的对象被找到了，这里的循环才会进入 //这是为了提高效率，因为找到了最后一个被调度的元素，那么其之前的元素就都已经被调度过了 while ((handler = iter.next()) != NULL) { int sock = handler->socketNum; // alias 别名 int resultConditionSet = 0; // 结果条件(状态)集合 if (FD_ISSET(sock, &readSet) && FD_ISSET(sock, &fReadSet)/sanity理智 check/) resultConditionSet |= SOCKET_READABLE; //添加可读属性 if (FD_ISSET(sock, &writeSet) && FD_ISSET(sock, &fWriteSet)/sanity check/) resultConditionSet |= SOCKET_WRITABLE; //添加可写属性 if (FD_ISSET(sock, &exceptionSet) && FD_ISSET(sock, &fExceptionSet)/sanity check/) resultConditionSet |= SOCKET_EXCEPTION; //添加异常属性 if ((resultConditionSet&handler->conditionSet) != 0 && handler->handlerProc != NULL) { fLastHandledSocketNum = sock; // Note: we set "fLastHandledSocketNum" before calling the handler, // in case the handler calls "doEventLoop()" reentrantly. //调用相关处理 (*handler->handlerProc)(handler->clientData, resultConditionSet); break; } } //如果没有找到上次最后被调度的对象，并且fLastHandledSocketNum标识存在 if (handler == NULL && fLastHandledSocketNum >= 0) { // We didn't call a handler, but we didn't get to check all of them, // so try again from the beginning: // 我们没有给一个处理程序，但我们没有去检查所有这些，所以试着重新开始： iter.reset(); //回到链表头 //从链表第头开始轮询处理 while ((handler = iter.next()) != NULL) { int sock = handler->socketNum; // alias int resultConditionSet = 0; if (FD_ISSET(sock, &readSet) && FD_ISSET(sock, &fReadSet)/sanity check/) resultConditionSet |= SOCKET_READABLE; if (FD_ISSET(sock, &writeSet) && FD_ISSET(sock, &fWriteSet)/sanity check/) resultConditionSet |= SOCKET_WRITABLE; if (FD_ISSET(sock, &exceptionSet) && FD_ISSET(sock, &fExceptionSet)/sanity check/) resultConditionSet |= SOCKET_EXCEPTION;
1 if ((resultConditionSet&handler->conditionSet) != 0 && handler->handlerProc != NULL) { 2 //设置fLastHandledSocketNum为最后一个被调用的处理程序的标识 3 fLastHandledSocketNum = sock; 4 // Note: we set "fLastHandledSocketNum" before calling the handler, 5 // in case the handler calls "doEventLoop()" reentrantly. 6 (*handler->handlerProc)(handler->clientData, resultConditionSet); 7 break; 8 } 9 } 10 // 没有一个合适的处理程序被调用 11 if (handler == NULL) fLastHandledSocketNum = -1;//because we didn't call a handler 12}//==========================================================================================
1// Also handle any newly-triggered event (Note that we do this *after* calling a socket handler, 2// in case the triggered event handler modifies The set of readable sockets.) 3// 处理等待触发的事件，这个在fTriggersAwaitingHandling中被标识 4if (fTriggersAwaitingHandling != 0) { 5 if (fTriggersAwaitingHandling == fLastUsedTriggerMask) { 6 //只有一个等待触发的事件 7 // Common-case optimization for a single event trigger: 8 fTriggersAwaitingHandling = 0; 9 if (fTriggeredEventHandlers[fLastUsedTriggerNum] != NULL) { 10 //函数调用 11 (*fTriggeredEventHandlers[fLastUsedTriggerNum])(fTriggeredEventClientDatas[fLastUsedTriggerNum]); 12 } 13 } 14 else { 15 // 有多个等待触发的事件 16 // Look for an event trigger that needs handling (making sure that we make forward progress through all possible triggers): 17 unsigned i = fLastUsedTriggerNum; 18 EventTriggerId mask = fLastUsedTriggerMask; 19 20 do { 21 i = (i + 1) % MAX_NUM_EVENT_TRIGGERS; 22 mask >>= 1; 23 if (mask == 0) mask = 0x80000000; 24 25 if ((fTriggersAwaitingHandling&mask) != 0) { 26 fTriggersAwaitingHandling &= ~mask; 27 if (fTriggeredEventHandlers[i] != NULL) { 28 (*fTriggeredEventHandlers[i])(fTriggeredEventClientDatas[i]); 29 } 30 31 fLastUsedTriggerMask = mask; 32 fLastUsedTriggerNum = i; 33 break; 34 } 35 } while (i != fLastUsedTriggerNum); 36 } 37}//====================================================================================== // Also handle any delayed event that may have come due. // 处理延时队列中已经到时间的延时任务 fDelayQueue.handleAlarm(); }
##setBackgroundHandling方法(添加后台处理程序)
setBackgroundHandling方法用于添加或更新一个处理程序到fHandlers链表。如果conditionSet为0，就将socketNum标识的节点从fHandlers中移除。否则若socketNum标识的节点存在，就更新，否则就添加一个节点。
1void BasicTaskScheduler 2::setBackgroundHandling(int socketNum, int conditionSet, BackgroundHandlerProc* handlerProc, void* clientData) { 3 if (socketNum < 0) return; //标识不合法 4 FD_CLR((unsigned)socketNum, &fReadSet); //不监控此套接口的可读状态 5 FD_CLR((unsigned)socketNum, &fWriteSet); //写 6 FD_CLR((unsigned)socketNum, &fExceptionSet);//异常 7 if (conditionSet == 0) { //不监控任何可操作状态 8 fHandlers->clearHandler(socketNum); //从链表中移除 9 if (socketNum + 1 == fMaxNumSockets) { //最大socket数减1，效率提升 10 --fMaxNumSockets; 11 } 12 } 13 else { 14 //更新链表，分配处理程序 15 fHandlers->assignHandler(socketNum, conditionSet, handlerProc, clientData); 16 if (socketNum + 1 > fMaxNumSockets) { 17 fMaxNumSockets = socketNum + 1; //更新最大socket数 18 } 19 //设置要监控的状态 20 if (conditionSet&SOCKET_READABLE) FD_SET((unsigned)socketNum, &fReadSet); 21 if (conditionSet&SOCKET_WRITABLE) FD_SET((unsigned)socketNum, &fWriteSet); 22 if (conditionSet&SOCKET_EXCEPTION) FD_SET((unsigned)socketNum, &fExceptionSet); 23 } 24}
##moveSocketHandling方法(转移socket处理)
这个方法名不怎么好翻译，有点类似C++11 move操作。都是转移操作。这里是将原本对oldSocketNum套接口操作的处理程序转移到去操作newSocketNum套接口。如果原本oldSocketNum就不再链表fHandler中呢？那就相当于仅仅把对oldSocketNum的监控给移除了。注意，这里设置了对newSocketNum的监控，而无论其是否被加入到fHandler链表。
1void BasicTaskScheduler::moveSocketHandling(int oldSocketNum, int newSocketNum) { 2 if (oldSocketNum < 0 || newSocketNum < 0) return; // sanity check完整性检查 3 //清理三个集合中对oldSocketNum的监控 4 if (FD_ISSET(oldSocketNum, &fReadSet)) { FD_CLR((unsigned)oldSocketNum, &fReadSet); FD_SET((unsigned)newSocketNum, &fReadSet); } 5 if (FD_ISSET(oldSocketNum, &fWriteSet)) { FD_CLR((unsigned)oldSocketNum, &fWriteSet); FD_SET((unsigned)newSocketNum, &fWriteSet); } 6 if (FD_ISSET(oldSocketNum, &fExceptionSet)) { FD_CLR((unsigned)oldSocketNum, &fExceptionSet); FD_SET((unsigned)newSocketNum, &fExceptionSet); } 7 //替换socketNum 8 fHandlers->moveHandler(oldSocketNum, newSocketNum); 9 10 if (oldSocketNum + 1 == fMaxNumSockets) { 11 --fMaxNumSockets; 12 } 13 if (newSocketNum + 1 > fMaxNumSockets) { 14 fMaxNumSockets = newSocketNum + 1; 15 } 16}