boost库asio详解4——deadline_timer使用说明

deadline_timer和socket一样，都用io_service作为构造函数的参数。也即，在其上进行异步操作，都将导致和io_service所包含的iocp相关联。这同样意味着在析构 io_service之前，必须析构关联在这个io_service上的deadline_timer。

1. 构造函数

在构造deadline_timer时指定时间。

basic_deadline_timer(
    boost::asio::io_service & io_service);

basic_deadline_timer(
    boost::asio::io_service & io_service,
    const time_type & expiry_time);

basic_deadline_timer(
    boost::asio::io_service & io_service,
    const duration_type & expiry_time);

注意后两种的区别。以下2种用法是等价的：

boost::asio::deadline_timer t(io, boost::posix_time::microsec_clock::universal_time()+boost::posix_time::seconds(5));
boost::asio::deadline_timer t(io, boost::posix_time::seconds(5));

前者是绝对时间，后者是相对时间。

2. 同步

一个deadline_timer只维护一个超时时间，一个deadline_timer不同时维持多个定时器。

void wait();
void wait(boost::system::error_code& ec);

这是个同步等待函数，例如：

boost::asio::io_service io;
boost::asio::deadline_timer t(io, boost::posix_time::seconds(5));
t.wait();

由于不涉及到异步，该函数和io_service没什么关系。这个函数在windows下的实现就只是简单的sleep。因此也就不存在cancel之说。

3. 异步

template<typename WaitHandler>
void async_wait(WaitHandler handler);

注意这个error很重要，表明这个handler是因为超时被执行还是因为被cancel。
符合2种情况之一，handler被执行：超时或者被cancel。
这同时隐含的说明了除非io.stop被调用，否则handler一定会被执行。即便是被cancel。
被cancel有多种方法，直接调用cancel或者调用expires_at，expires_from_now重新设置超时时间。

4. 例子

namespace
{
    void print(const boost::system::error_code&)
    {
        PRINT_DEBUG("Hello, world!");
    }

    void handle_wait(const boost::system::error_code& error,
                     boost::asio::deadline_timer& t,
                     int& count)
    {
        if(!error)
        {
            PRINT_DEBUG(count);
            if(count++ < 5)
            {
                t.expires_from_now(boost::posix_time::seconds(3));
                t.async_wait(boost::bind(handle_wait,
                                         boost::asio::placeholders::error,
                                         boost::ref(t),
                                         boost::ref(count)));
                if (count == 3)
                {
                    t.cancel();
                }

            }
        }
    }
}

// 同步方法
void test_timer_syn()
{
    boost::asio::io_service ios;
    boost::asio::deadline_timer t(ios, boost::posix_time::seconds(3));
    PRINT_DEBUG(t.expires_at());
    t.wait();
    PRINT_DEBUG("Hello syn deadline_timer!");
}

// 异步方法: 3秒后执行print方法.
void test_timer_asyn()
{
    boost::asio::io_service io;

    boost::asio::deadline_timer t(io, boost::posix_time::seconds(3));
    t.async_wait(print);
    PRINT_DEBUG("After async_wait...");
    io.run();
}

// 异步循环执行方法:
void test_timer_asyn_loop()
{
    boost::asio::io_service io;
    boost::asio::deadline_timer t(io);
    size_t a = t.expires_from_now(boost::posix_time::seconds(1));

    int count = 0;
    t.async_wait(boost::bind(handle_wait,
                             boost::asio::placeholders::error,
                             boost::ref(t),
                             boost::ref(count)));
    io.run();
}