002 - event_watcher.h 和 event_watcher.cc

在看了001 - inner_pre 之后发现就实现了三个函数,其中两个是非常关键的函数EventAdd和EventDel,接下来的EventWatcher这个类中将会用到这两个函数,看一下 EventWatcher这个类声明。

class EventLoop;
class EVPP_EXPORT EventWatcher {
public:
    typedef std::function<void()> Handler;

    virtual ~EventWatcher();

    bool Init();

    // @note It MUST be called in the event thread.
    void Cancel();

    // @brief :
    // @param[IN] const Handler& cb - The callback which will be called when this event is canceled.
    // @return void -
    void SetCancelCallback(const Handler& cb);

    void ClearHandler() { handler_ = Handler(); }
protected:
    // @note It MUST be called in the event thread.
    // @param timeout the maximum amount of time to wait for the event, or 0 to wait forever
    bool Watch(Duration timeout);

protected:
    EventWatcher(struct event_base* evbase, const Handler& handler);
    EventWatcher(struct event_base* evbase, Handler&& handler);

    void Close();
    void FreeEvent();

    virtual bool DoInit() = 0;
    virtual void DoClose() {}

protected:
    struct event* event_;
    struct event_base* evbase_;
    bool attached_;
    Handler handler_;
    Handler cancel_callback_;
};

总体的看了一下, 发现EventWatcher这个类,提供了一个自定义类型 Hanlder,一些公共的方法,保护方法和一些保护的成员变量。看到了保护方法里有两个virtual 开头的虚函数声明,应该知道这个应该作为抽象父类使用。

下面仔细分析一下这个类:

  • 前置声明了一个类EventLoop, 后面会看到EventLoop他在这个类中的作用。

  • 类的两个构造函数

protected:
    EventWatcher(struct event_base* evbase, const Handler& handler);
    EventWatcher(struct event_base* evbase, Handler&& handler);

具体的实现:

EventWatcher::EventWatcher(struct event_base *evbase, const Handler &handler)
    : evbase_(evbase), attached_(false), handler_(handler) {
  event_ = new event;
  memset(event_, 0, sizeof(struct event));
}

EventWatcher::EventWatcher(struct event_base *evbase, Handler &&handler)
    : evbase_(evbase), attached_(false), handler_(std::move(handler)) {
  event_ = new event;
  memset(event_, 0, sizeof(struct event));
}

就是将自己的成员变量进行初始化, 特别要注意的是,不管是调用了那一个构造函数,在构造函数里都把event_成员变量new了出来,而且进行了memset

  • 虚析构函数
EventWatcher::~EventWatcher() {
  FreeEvent();
  Close();
}

在析构函数中主要是完成成员变量event_的释放FreeEvent()和后续的关闭动作Close()

  • FreeEvent()方法
void EventWatcher::FreeEvent() {
  if (event_) {
    if (attached_) {
      EventDel(event_);
      attached_ = false;
    }

    delete (event_);
    event_ = nullptr;
  }
}

从上面的实现方法可以看到,如果event_是非空指针,并且已经被安装到了evbase_上,就调用EventDel函数将其从evbase_进行删除。并将attached_成员变量设置成false
后续释放了event_的资源,并且赋值nullptr

  • Close()方法
void EventWatcher::Close() { DoClose(); }

调用了DoClose()方法, 这个DoClose()是个需函数有自己默认实现,后续的子类也可以重写此方法。

  • Init()方法
bool EventWatcher::Init() {
  if (!DoInit()) {
    goto failed;
  }

  ::event_base_set(evbase_, event_);
  return true;

failed:
  Close();
  return false;
}

Init()中在调用了自己的方法 DoInit(), 如果 DoInit()成功,会将自己之前new出来的成员变量event_设置一个event base。 调用了一个libevent的方法::event_base_set(evbase_, event_), 将event_绑定到evbase上。

DoInit()是一个纯虚函数,有后续的子类实现不同类型的event。这个是重点。

  • Cancel()方法
void EventWatcher::Cancel() {
  assert(event_);
  FreeEvent();

  if (cancel_callback_) {
    cancel_callback_();
    cancel_callback_ = Handler();
  }
}

Cancel()中 调用了FreeEvent()方法释放event_, 如果有cancel_callback_,就执行cancel_callback_(),后续将cancel_callback_赋值成空。

  • 辅助的方法
    void SetCancelCallback(const Handler& cb);
    void ClearHandler() { handler_ = Handler(); }

SetCancelCallback 用于成员变量 cancel_callback_的赋值, 在Cancel()被调用。
ClearHandler 清除成员变量 handler_

  • Watch()方法
bool EventWatcher::Watch(Duration timeout) {
  struct timeval tv;
  struct timeval *timeoutval = nullptr;
  if (timeout.Nanoseconds() > 0) {
    timeout.To(&tv);
    timeoutval = &tv;
  }

  if (attached_) {
    // When InvokerTimer::periodic_ == true, EventWatcher::Watch will be called
    // many times so we need to remove it from event_base before we add it into
    // event_base
    if (EventDel(event_) != 0) {
      LOG_ERROR << "event_del failed. fd=" << this->event_->ev_fd
                << " event_=" << event_;
      // TODO how to deal with it when failed?
    }
    attached_ = false;
  }

  assert(!attached_);
  if (EventAdd(event_, timeoutval) != 0) {
    LOG_ERROR << "event_add failed. fd=" << this->event_->ev_fd
              << " event_=" << event_;
    return false;
  }
  attached_ = true;
  return true;
}

Watch()方法是这个类的精髓所在,前面所做的Init()都是为了这个方法服务,经过了Init(), 成员变量event_应该有了自己的事件类型,通过if (EventAdd(event_, timeoutval) != 0) { 这一句,将event_安装到了evbase_上,如果安装成功,将成员变量attached_赋值true。 注意的是前面Init() 中用了一个词语叫绑定 只是说event和base之间有关系,base运行还不能带有这个事件触发器, 这里用了安装,base运行就可以带有这个触发的触发器。

可以想一下这个类的用例流程:

  • 先调用Init(),将成员变量event_进行相应事件的初始化。
  • 在调用Watch(),将成员变量安装到evbase_上。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容