版本说明

本文分析基于2019-12-30的版本。（Live555没有版本管理？）

1 Hash容器

1.1 HashTable

HashTable 定义了Hash表的接口。

• 成员函数 Add()、Remove() 和 Lookup() 分别用于添加、删除和查找元素。

1.2 HashTable

BasicHashTable实现了HashTable接口。这是hash表的一个标准实现。

• 成员fBuckets[]指向一个TableEntry*的数组。其中每个元素指向一个TableEntry链表。TableEntry包括一个(key，value)对。
• 成员函数 hashIndexFromKey()计算key的HASH值。它将Key值进行若干变换，然后限缩在数组fBuckets的索引范围内。
• 成员函数keyMatches()用于比较两个key值是否相同。
• insertNewEntry()向Hash表添加新元素。
  • 它调用hashIndexFromKey()计算在数组fBucket中的索引，然后创建新的TableEntry实例，并挂接到该索引位置上的TableEntry链表。
• TableEntry的key值一般有两种类型：string和unsigned。两种类型计算HASH值的方法不同。
• 如果Hash表中的TableEntry实例数超过指定的阈值，则调用rebuild()重建Hash表，将成员fBuckets[]加长。这样做的目的是保证Hash表的效率。

2 任务调度

2.1 TaskScheduler

TaskScheduler定义任务调度器接口。

TaskScheduler接口涵盖三种任务：Socket监听、延时任务、和事件通知任务。后面依次说明这三种任务。

• 成员函数setBackgroundHandling()创建Socket监听任务。
• 成员函数createEventTrigger()创建事件通知任务，triggerEvent()触发任务。
• 成员函数scheduleDelayedTask()创建延时任务。
• 成员函数doEventLoop()处理任务。

2.2 HandlerDescritor、HandlerSet - Socket监听任务

HandlerDescriptor保存socket、以及与socket关联的处理函数。

• 成员socketNum是socket的值
• 成员conditionSet是fd_set值的组合
• handlerProc是指定的处理函数，clientData是handlerProc的参数。

这些成员分别指定应该监控Socket上的什么事件（可读、可写、异常），事件发生时应该调用什么函数处理它。

HandlerSet是HandlerDescriptor的集合。

如下图，HandlerSet的成员fHandlers保存一个HandlerDescriptor双向列表。

对于HandlerDescriptor，

• 成员fPrevHandler和fNextHandler用于链接双向链表。

对于HandlerSet，

• 成员函数assignHandler()设置Socket的处理函数。创建新的HandlerDescriptor实例，或者更新已有的实例。创建HandlerDescriptor实例时，将它链接在双向链表的尾部。
• 成员函数clearHandler()清除Socket的处理函数。在HandlerDescriptor的析构函数中，把它自身从双向链表中移除。
• 成员函数lookupHandler()查找Socket的处理函数。

HanderIterator基于HandlerDescriptor双向链表。

• 调用它的成员函数next()，可以遍历HandlerDescriptor链表。

2.3 AlarmHandler - 延时任务

DelayQueueEntry保存延时任务，而DelayQueue保存一个DelayQueueEntry双向链表。

对于DelayQueueEntry，

• 成员fDeltaTimeRemaining保存延时的时长，这是一个相对值。
• 成员fPrev和fNext 让DelayQueueEntry的多个实例能链成一个双向列表。
• 虚拟成员函数handleTimeout()是延时到达时执行的函数。DelayQueueEntry的派生类可以定制自己的实现。

DelayQueue是一个DelayQueueEntry容器。

• 它从DelayQueueEntry派生。这样的设计看起来只是为了不需要为起始节点加一个DelayQueryEntry成员。（让人迷惑的设计！）
• 成员函数addEntry()、updateEntry()、和removeEntry()分别用于增加、更新和移除元素。

AlarmHandler是DelayQueueEntry的派生类，实现了虚拟成员函数handleTimeout()。

• 成员fProc是处理函数，由handleTimeout()调用。成员fClientData是fProc的参数。两者在AlarmHandler的构造函数中作为参数指定。

在DelayQueueEntry双向链表中，元素的延时fDeltaTimeRemaining是相对的，是前一个元素的相对值。

如下图中，有4个元素，它们的fDeltaTimeRemaining值分别是4、4、3和2，那么第一个元素的实际延时是最近的，是4，其他元素的实际延时依次累加，分别是8、11和13。

DelayQueueEntry和DelayQueue用Timeval度量时间。Timeval的派生类DelayInterval和_EventTime，是对Timeval的简单包装。

2.4 事件通知任务

没有定义专门的类处理事件通知任务。BasicTaskScheduler0类直接处理这类任务。

2.5 BasicTaskScheduler0、BasicTaskScheduler

BasicTaskSchduler0实现了TaskScheduler接口，实现延时任务和事件监听任务。

BasicTaskScheduler派生自BasicTaskScheduler0，进一步实现socket监听任务。

对于BasicTaskSchduler0，

• 实现shceduleDelayedTask()创建延时任务。成员fDelayQueue保存一组延时任务。
• 实现createEventTrigger()和triggerEvent()，创建、触发事件通知任务。成员fTriggerEventHandlers[]保存一组事件通知任务。
• BasicTaskScheduler0定义了新接口，也就是新的虚拟函数SingleStep()。它实现了虚拟函数doEventLoop()。在里面，它在循环中调用singleStep()。

对于BasicTaskScheduler，

• 实现setBackgroundHandling()创建Socket监听任务。BasicTaskScheduler0的成员fHandlers保存socket处理函数。（为什么不是BasicTaskSchduler的成员？）
• 实现BasicTaskScheduler0定义的接口SingleStep()。

在BasicTaskScheduler::SingleStep()中，

• 调用select()，监听HandlerSet中保存的socket的可读、可写和异常信号。如果有信号，则调用指定HandlerSet实例中指定的处理函数TaskScheduler::BackgroundHandleProc()处理。
• 检查fTriggerEventHandlers[]中的任务是否为触发状态，如果是，则调用指定处理函数TaskFunc()进行处理。
• 调用DelayQueue::handleAlarm()，检查成员fDelayQueue中延时任务是否到达，如果是，调用处理函数TaskFunc()进行处理。

3 程序上下文

3.1 UsageEnvironment

UsageEnvironment定义了一个输出打印消息的接口。

• 成员函数setResultMsg()将打印消息保存起来，getResultMsg()获得保存的打印信息， reportBackgroundError()输出保存的打印信息。
• operator <<() 一系列成员函数，输出指定格式的数据。

BasicUsageEnvironment0实现了这个接口的setResultMsg()、getResultMsg()和reportBackgroundError()。

• 成员fResultMsgBuffer[]保存打印消息。
• reportBackgroundError()向stderr输出打印消息。

BasicUsageEnvironment进一步实现了这个接口的operator<<()系列函数。

• 这些函数向stderr输出打印消息。

UsageEnvironment还是整个程序运行的上下文。

• 成员fScheduler引用全局唯一的TaskScheduler实例
• 成员liveMediaPriv引用全局唯一的_Tables实例，保存了两个全局表。
• 成员groupsockPriv实际上是_groupsockPriv实例，保存几个组播全局变量，其中reuseFlag是绑定Socket时是否重用地址。

应用程序只创建一个UsageEnvironment实例。

3.2 _Tables - 全局容器

_Tables保存几个hash表。

• _Tables是singleton模式，调用getOurTables()可以得到唯一的实例。
• 成员mediaTable是其中一个Hash表，它是MediumLookupTable的实例。

3.3 Medium、MediaLookupTable

Medium给它的派生类的实例保存一个名字。

• 成员fMediumName[]保存这个名字。这个名字调用MediaLookupTable::generateNewName()得到。
• Medium还引用唯一的UsageEnvironment实例。

MediumLookupTable保存一个Medium集合。这个集合保存在成员fTable中，这是一个HashTable实例。

• addNew()、lookup()和remove()分别向hashtable加入、查找和删除Medium实例。