19_BasicTaskScheduler0 基本任务调度类基类（一）——Live555源码阅读(一

#19_BasicTaskScheduler0 基本任务调度类基类（一）——Live555源码阅读(一)任务调度相关类

这是Live555源码阅读的第二部分，包括了任务调度相关的三个类。任务调度是Live555源码中很重要的部分。

本文由乌合之众 lym瞎编，欢迎转载 my.oschina.net/oloroso

##BasicTaskScheduler0 基本任务调度类基类

BasicTaskScheduler0是一个用作传递的类，它继承自TaskScheduler，又派生出BasicTaskScheduler。其定义在live555sourcecontrol\UsageEnvironment\include\BasicUsageEnvironment0.hh文件中。 这个类实现了TaskScheduler中的纯虚接口，并增加了一些数据成员。其中比较重要的两个是fDelayQueue(延时队列)和fHandlers(处理程序集合/链表)。

##下面是其定义代码，里面有一些是对注释的翻译。

1class HandlerSet; // forward
2
3#define MAX_NUM_EVENT_TRIGGERS 32
4
5// An abstract base class, useful for subclassing 抽象基类，用于子类化
6// (e.g., to redefine the implementation of socket event handling)
7// 例如，重新定义socket事件处理的实现
8class BasicTaskScheduler0 : public TaskScheduler {
9public:
10	//析构的时候 delete fHandlers
11	virtual ~BasicTaskScheduler0();
12
13	//设置select轮询的超时时间的最大值，如果maxDelatTime不大于0，那么就设置为一百万秒
14	virtual void SingleStep(unsigned maxDelayTime = 0) = 0;
15	// "maxDelayTime" is in microseconds.  It allows a subclass to impose a limit
16	// maxDelayTime 单位是微秒，它允许一个子类施加限制
17	// on how long "select()" can delay, in case it wants to also do polling.
18	// 多长时间”select()”可以延迟，如果它想做轮询。
19	// 0 (the default value) means: There's no maximum; just look at the delay queue
20	// 0作为默认值，意思是：没有最大；只是看看延迟队列
21
22public:
23	// Redefined virtual functions:重新定义虚函数
24
25	/* 调度延时任务
26	* 1、创建一个AlarmHandler对象（定时处理）;(new AlarmHandler(proc, clientData, timeToDelay);)
27	* 2、将创建的alarmHandler对象添加到fDelayQueue中;(fDelayQueue.addEntry(alarmHandler))
28	* 3、返回这个alarmHandler的token标志
29	*/
30	virtual TaskToken scheduleDelayedTask(int64_t microseconds, TaskFunc* proc,
31		void* clientData);
32
33	/* 取消调度延时任务
34	* 1、从fDelayeQueue中removeEntry这个prevTask
35	* 2、设置prevTask=NULL
36	* 3、delete这个prevTask标识的alarmHandler对象
37	*/
38	virtual void unscheduleDelayedTask(TaskToken& prevTask);
39
40	/* 做事件循环
41	* 1、判断watchVariable !=0 && *watchVariable != 0是否成立，若成立，函数返回
42	* 2、调用函数SingleStep();函数返回后继续做步骤1
43	*/
44	virtual void doEventLoop(char* watchVariable);
45
46	/* 创建事件触发器ID
47	*     从fTriggeredEventHandlers数组中寻找一个没有使用的位置 pos。如果没有空位，函数返回0
48	*     将eventHandlerProc放置到上述数组 pos 位置
49	*     将fTriggeredEventClientDatas数组 pos 位置置为NULL
50	*     设置fLastUsedTriggerMask的第 pos 位为1
51	*     设置fLastUsedTriggerNum为 pos
52	*     返回fLastUsedTriggerMask的值
53	*/
54	virtual EventTriggerId createEventTrigger(TaskFunc* eventHandlerProc);
55
56	/* 删除事件触发器 eventTriggerId可能代表多个事件触发器
57	*   设置 fTriggersAwaitingHandling &=~ eventTriggerId 
58	*   即将fTriggersAwaitingHandling中对应于eventTriggerId的非零位 置零
59	*   从fTriggeredEventHandlers和fTriggeredEventClientDatas中将对应的位置置为NULL
60	*/
61	virtual void deleteEventTrigger(EventTriggerId eventTriggerId);
62
63	/* 触发事件
64	*    从fTriggeredEventClientDatas找到eventTriggerId对应的位置，设置为clientData
65	*    将fTriggersAwaitingHandling中对应eventTriggerId中的非0位置为1
66	*/
67	virtual void triggerEvent(EventTriggerId eventTriggerId, void* clientData = NULL);
68
69protected:
70	BasicTaskScheduler0();
71
72protected:
73	// implement vt.实施，执行; 使生效，实现; 落实（政策）; 把…填满;n.工具，器械; 家具; 手段;[法]履行（契约等）;
74	
75	// To implement delayed operations: 实施延迟操作：
76	DelayQueue fDelayQueue;
77
78	// To implement background reads: 实施后台读
79	HandlerSet* fHandlers;		//处理程序描述对象链表指针
80	int fLastHandledSocketNum;	//当前最近一个调度的HandlerDescriptor对象的socketNum标识
81
82	// To implement event triggers:	实施时间触发器
83	// fTriggersAwaitingHandling触发等待处理的 fLastUsedTriggerMask 最后使用触发器的位置置1
84	// implemented as 32-bit bitmaps 实现是32位的比特位图
85	EventTriggerId fTriggersAwaitingHandling, fLastUsedTriggerMask;
86
87	TaskFunc* fTriggeredEventHandlers[MAX_NUM_EVENT_TRIGGERS];	//保存事件触发器
88	void* fTriggeredEventClientDatas[MAX_NUM_EVENT_TRIGGERS];	//保存触发事件客户端数据
89	unsigned fLastUsedTriggerNum; // in the range(范围) [0,MAX_NUM_EVENT_TRIGGERS) 最后使用触发器的
90};

##BasicTaskScheduler0的构造与析构 BasicTaskScheduler0的构造内容不多，但是从这里开始要介绍的东西很多。还有注意，这个构造函数是protected权限的。 先来分析一下它的各个数据成员。

int fLastHandledSocketNum; 从字面意思来看，这个成员的意思是保存最后一个处理socket的。但是这只是猜测。这里我们回到前面去看HandlerDescriptor类的定义。其类定义中有一个成员socketNum，用来表示HandlerDescriptor在链表中的唯一存在。是不是这两者就有关联了呢？没错，确实是这样的。这个变量代表的是最后一个被加入的HandlerDescriptor对象。

fTriggersAwaitingHandling和fLastUsedTriggerMask这两个一起来说。

这两者的类型是EventTriggerId，实质上是无符号32未整型(u_int32_t)。这两个变量和后面的两个数组对应起来看，这两个数组都是MAX_NUM_EVENT_TRIGGERS个元素的，也就是32。而这里两个变量是32bit，它们的每一个位与数组的一个元素对应是否就刚刚好呢？这里先不说，后面会解释的。(fTriggersAwaitingHandling等待触发集，fLastUsedTriggerMask最近使用的触发器)

fLastUsedTriggerNum这个参数表示的是最后一个使用触发器的位置(在fTriggeredEventHandlers数组中的下标)。它的范围是[0,31]。将其初始化为31，是因为每一次创建触发器的时候会使用这个值。见createEventTriggerd方法。

数组fTriggeredEventHandlers用于保存事件处理程序函数地址，它的每一个元素是一个函数指针。 数组fTriggeredEventClientDatas用于保存事件处理程序函数调用时候的参数，它的元素是void*类型。 DelayQueue fDelayQueue;是一个延时队列，前面介绍过。用于延时处理事件。注意这里这个链表的节点将是AlarmHandler对象。 HandlerSet* fHandlers;这一个用于保存事件处理程序和其客户数据。要注意的是这里是一个指针，而不是对象。在构造的时候创建了一个对象。

1BasicTaskScheduler0::BasicTaskScheduler0()
2  : fLastHandledSocketNum(-1), fTriggersAwaitingHandling(0), fLastUsedTriggerMask(1), fLastUsedTriggerNum(MAX_NUM_EVENT_TRIGGERS-1) {
3  fHandlers = new HandlerSet;	//创建对象
4  for (unsigned i = 0; i < MAX_NUM_EVENT_TRIGGERS; ++i) {
5    fTriggeredEventHandlers[i] = NULL;
6    fTriggeredEventClientDatas[i] = NULL;
7  }
8}
9

BasicTaskScheduler0的析构就简单很多了。前面说了，只要一个成员fHandlers是指针的，并且在构造的时候动态创建了一个对象给它。所以析构的时候就只是将其delete了。

1BasicTaskScheduler0::~BasicTaskScheduler0() {
2  delete fHandlers;
3}