linux c++ 利用timerfd和epoll封装计时器(Timer)类

程序简介:

1.把timerfd和epoll的功能封装成一个类,timerfd负责创建计时器,而epoll负责等待timer超时,然后调用用户设定得回调函数。

2.至于timerfd的基本功能不明白,就参考这位大神的技术文章:blog.csdn.net/chgaowei/article/details/21295811

3.至于epoll的基本功能不明白,就参考这位大神得技术文章:blog.csdn.net/xiajun07061225/article/details/9250579


Timer.h

#ifndef __TIMER_H_
#define __TIMER_H_

/*
 *  Name: Timer
 *  Date: 10-12-2015 
 *  Author: Sumkee
 *  Brief: It's general timer that provides a friendly interfaces
 *         to create the timer
 *
 */

#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <cmath>
#include <unistd.h>
#include <sys/timerfd.h>
#include <sys/epoll.h>
#include <sys/types.h>
#include <stdint.h>
#include <pthread.h>
#include <iostream>
#include <map>
#include <algorithm>
#include <list>

using namespace std;


class Timer {
public:
    Timer();
    ~Timer();
    
    // The structure of timer event
    typedef void (*CALLBACK_FN)(void *);
    typedef struct _TimerEvent {
        int fd;
        CALLBACK_FN cbf;
        void *args;
    } TimerEvent;

    /*
     *  Name: start
     *  Brief: start the timer
     *  @interval: The interval, the unit is ms
     *  @cbf: The callback function
     *  @args: The arguments of callback function
     *  @triggered_on_start: Determine tirggered on start or not
     *
     */ 
    bool start(const uint interval, CALLBACK_FN cbf,
            void *args,const bool triggered_on_start=false);

    /*
     *  Name: stop
     *  Brief: stop the timer
     *
     */
    void stop();

private:
    bool m_is_start;
    TimerEvent m_te;
};

#endif

Timer.cpp

#include "timer.h"

/*
 * Save the global data such as file descriptors of timerfd and 
 * create a new thread for epoll
 *
 */
class TimerPrivate {
    public:
        TimerPrivate();
        ~TimerPrivate() {
            pthread_mutex_destroy(&m_mutex);
        }

        // Some constant
        enum {
            MaxEPOLLSize = 20000,    
        };

        /*
         *  Name: epoll_proc
         *  Brief: this function run on new thread for epoll
         *
         */
        static void* epoll_proc(void *);

        /*
         *  Get the timer event by fd
         *
         */
        static Timer::TimerEvent get_timer_event(int fd);

        /*
         *  Add the timer event to map and epoll
         *
         */ 
        static bool add_timer_event(const Timer::TimerEvent &te); 

        /*
         *  Remove the timer event from map adn epoll by fd
         *
         */
        static void remove_timer_event(const int fd);

        // Map of file descriptor
        int m_epoll_fd;
        typedef map<int, Timer::TimerEvent> MapTimerEvent;
        MapTimerEvent m_map_te;
        pthread_t m_tid;
        pthread_mutex_t m_mutex; 
};

// The declare of TimerPrivate
static TimerPrivate g_tp;

TimerPrivate::TimerPrivate() {
    try {
        // Initialization
        // Init mutex
        int res = pthread_mutex_init(&m_mutex, 0);
        if(res == -1) {
            perror("pthread_mutex_init");
            throw;
        }

        // Create epoll
        m_epoll_fd = epoll_create(MaxEPOLLSize);
        if(m_epoll_fd == -1) {
            perror("epoll_create");
            throw;
        }

        // Create thread for epoll
        res = pthread_create(&m_tid, 0, TimerPrivate::epoll_proc, 0);
        if(res == -1) {
            perror("pthread_create");
            throw;
        }
    } catch (...) {} 
}

void* TimerPrivate::epoll_proc(void *) {
    struct epoll_event events[MaxEPOLLSize];
    while(1) {
        // Wait for notice
        int n =epoll_wait(g_tp.m_epoll_fd, events, MaxEPOLLSize, -1); 
        pthread_mutex_lock(&g_tp.m_mutex);
        for(int i=0; i<n; ++i) {
            int fd = events[i].data.fd;
            // Clear buffer
            uint64_t buf;
            read(fd, &buf, sizeof(uint64_t));

            // Call the callback function when timer expiration
            Timer::TimerEvent te = TimerPrivate::get_timer_event(events[i].data.fd);
            if(te.cbf) {
                te.cbf(te.args);
            }
        }
        pthread_mutex_unlock(&g_tp.m_mutex);
    }
    return 0;
}

Timer::TimerEvent TimerPrivate::get_timer_event(int fd) {
    return g_tp.m_map_te[fd];
}

bool TimerPrivate::add_timer_event(const Timer::TimerEvent &te) {
    // Add timer event for epoll
    struct epoll_event epe;
    epe.data.fd = te.fd;
    epe.events = EPOLLIN | EPOLLET;
    int res = epoll_ctl(g_tp.m_epoll_fd, EPOLL_CTL_ADD, te.fd, &epe); 
    if(res == -1) {
        perror("epoll_ctl");
        return false;
    }

    // Insert timer event to map
    g_tp.m_map_te[te.fd] = te;

    return true;
}

void TimerPrivate::remove_timer_event(const int fd) {
    // Remove from epoll
    int res = epoll_ctl(g_tp.m_epoll_fd, EPOLL_CTL_DEL, fd,0);
    if(res == -1) {
        perror("epoll_ctl");
        return; 
    }

    // Remove from map
    MapTimerEvent::iterator iter = g_tp.m_map_te.find(fd);
    g_tp.m_map_te.erase(iter);
}

Timer::Timer() : m_is_start(false) {
    ::memset(&m_te, 0, sizeof(TimerEvent));
}

Timer::~Timer() {
    if(m_is_start) {
        stop();
        m_is_start = false;
    }
}

bool Timer::start(const uint interval, CALLBACK_FN cbf, void *args, const bool triggered_on_start) {
    pthread_mutex_lock(&g_tp.m_mutex);

    if(!m_is_start) {
        if(!cbf) {
            cout << "start:" << "callback function can't set to be null" << endl;
            return false;
        }

        // Create timer
        struct itimerspec timer;
        double dfsec = (double)interval/1000;
        uint32_t sec=dfsec;
        uint64_t number_ns = 1000000000;
        uint64_t nsec = dfsec>=1 ? fmod(dfsec,(int)dfsec)*number_ns : dfsec*number_ns;
        timer.it_value.tv_nsec = triggered_on_start ? 0 : nsec;
        timer.it_value.tv_sec = triggered_on_start ? 0 : sec;
        timer.it_interval.tv_nsec = nsec;
        timer.it_interval.tv_sec = sec;

        int fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK);
        if(fd == -1) {
            perror("timerfd_create");
            return false;
        }

        int res = timerfd_settime(fd, 0, &timer, 0);
        if(res == -1) {
            perror("timerfd_settime");
            return false;
        }

        // Add timer for epoll
        TimerEvent te;
        te.fd = fd;
        te.cbf = cbf;
        te.args = args;
        res = TimerPrivate::add_timer_event(te);
        if(res == false) {
            return false;
        }

        // Change the attributes of class
        m_te = te;
        m_is_start = true;
    } else {
        cout << "start:Timer already start" << endl;
        return false;
    }

    pthread_mutex_unlock(&g_tp.m_mutex);
    return true;
}

void Timer::stop() {
    pthread_mutex_lock(&g_tp.m_mutex);

    // Remove from map and epoll
    TimerPrivate::remove_timer_event(m_te.fd);

    // Close the timer
    int res = close(m_te.fd);
    if(res == -1) {
        perror("close");
    }

    // Clear the attributes of class
    m_is_start = false;

    pthread_mutex_unlock(&g_tp.m_mutex);
}

/**************************************************************************/
// Test
void timer_proc(void *args) {
    cout << args << endl;
}

int main() {
    list<Timer*> l;
    for(int i=0; i<10;++i) {
        Timer *t = new Timer();
        t->start(500, timer_proc, reinterpret_cast<void*>(i));
        l.push_back(t);
    }
    sleep(3);
    return 0;
}



  • 6
    点赞
  • 16
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
好的,我可以为您提供一种可能的实现方式。 首先,我们需要定义一个名为 `EpollWrapper` 的,并且包含以下成员函数: ```cpp class EpollWrapper { public: EpollWrapper(); ~EpollWrapper(); int add(int fd, uint32_t events); int modify(int fd, uint32_t events); int remove(int fd); int wait(int timeout_ms, epoll_event* events, int max_events); int close(); private: int epoll_fd_; }; ``` 其中,`add()` 函数用于向 epoll 实例中添加一个文件描述符及其对应的事件型,`modify()` 函数用于修改已添加的文件描述符对应的事件型,`remove()` 函数用于从 epoll 实例中移除一个文件描述符,`wait()` 函数用于等待事件就绪并返回就绪的文件描述符,`close()` 函数用于关闭 epoll 实例。 接下来,我们可以实现这些成员函数。首先是构造函数和析构函数: ```cpp EpollWrapper::EpollWrapper() { epoll_fd_ = epoll_create1(0); if (epoll_fd_ == -1) { throw std::runtime_error("Failed to create epoll instance"); } } EpollWrapper::~EpollWrapper() { close(); } ``` 构造函数中使用 `epoll_create1()` 函数创建一个 epoll 实例,并且检查返回值以确保实例创建成功。析构函数中调用 `close()` 函数以关闭 epoll 实例。 接下来,我们可以实现 `add()`、`modify()`、`remove()`、`wait()` 和 `close()` 函数: ```cpp int EpollWrapper::add(int fd, uint32_t events) { epoll_event event; event.data.fd = fd; event.events = events; return epoll_ctl(epoll_fd_, EPOLL_CTL_ADD, fd, &event); } int EpollWrapper::modify(int fd, uint32_t events) { epoll_event event; event.data.fd = fd; event.events = events; return epoll_ctl(epoll_fd_, EPOLL_CTL_MOD, fd, &event); } int EpollWrapper::remove(int fd) { return epoll_ctl(epoll_fd_, EPOLL_CTL_DEL, fd, nullptr); } int EpollWrapper::wait(int timeout_ms, epoll_event* events, int max_events) { return epoll_wait(epoll_fd_, events, max_events, timeout_ms); } int EpollWrapper::close() { int ret = 0; if (epoll_fd_ != -1) { ret = ::close(epoll_fd_); epoll_fd_ = -1; } return ret; } ``` 这些函数中,`add()`、`modify()` 和 `remove()` 函数都是通过调用 `epoll_ctl()` 函数来实现的,`wait()` 函数则是通过调用 `epoll_wait()` 函数来等待就绪的事件,`close()` 函数则是通过调用 `::close()` 函数来关闭 epoll 实例。 最后,我们需要编写单元测试来验证我们的实现是否正确。我们可以使用 Google Test 框架来编写单元测试。以下是一个简单的单元测试示例: ```cpp #include <gtest/gtest.h> #include <sys/socket.h> #include <sys/epoll.h> #include <unistd.h> #include "epoll_wrapper.h" TEST(EpollWrapperTest, Basic) { EpollWrapper epoll; ASSERT_TRUE(epoll.add(STDIN_FILENO, EPOLLIN) == 0); int pipe_fds[2]; ASSERT_TRUE(pipe(pipe_fds) == 0); ASSERT_TRUE(epoll.add(pipe_fds[0], EPOLLIN) == 0); epoll_event events[2]; int ret = epoll.wait(1000, events, 2); ASSERT_TRUE(ret >= 0); for (int i = 0; i < ret; ++i) { if (events[i].data.fd == STDIN_FILENO) { char buf[1024]; int n = read(STDIN_FILENO, buf, sizeof(buf)); ASSERT_TRUE(n >= 0); } else if (events[i].data.fd == pipe_fds[0]) { char buf[1024]; int n = read(pipe_fds[0], buf, sizeof(buf)); ASSERT_TRUE(n >= 0); } } ASSERT_TRUE(epoll.remove(STDIN_FILENO) == 0); ASSERT_TRUE(epoll.remove(pipe_fds[0]) == 0); close(pipe_fds[0]); close(pipe_fds[1]); } ``` 在这个单元测试中,我们首先创建了一个 `EpollWrapper` 实例,然后向其中添加标准输入(`STDIN_FILENO`)和一个管道读端的文件描述符,并且等待这些文件描述符上的事件就绪。如果在等待过程中发生错误,单元测试会失败。如果等待成功,则断言返回的就绪事件个数大于等于 0。然后,我们可以遍历就绪事件,读取就绪的文件描述符中的数据并且进行断言。最后,我们移除已添加的文件描述符,并且关闭管道。 这就是一个可能的 C++ epoll/poll 封装及单元测试的实现方式。当然,这只是一种参考,具体的实现方式可能因应用场景不同而不同。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值