Simple wrapper around Boost.Asio's deadline_timer, allowing for error-prone, cross-platform allocation and use. More...
#include <Asio.hpp>
Inheritance diagram for Sirikata::Network::DeadlineTimer:
Collaboration diagram for Sirikata::Network::DeadlineTimer:
Public Member Functions | |
| DeadlineTimer (IOService &io) | |
| DeadlineTimer (IOService *io) | |
| virtual | ~DeadlineTimer () |
| std::size_t | cancel (boost::system::error_code &ec) |
| Sometimes cancels the callback. | |
| std::size_t | cancel () |
| Sometimes cancels the callback. | |
Detailed Description
Simple wrapper around Boost.Asio's deadline_timer, allowing for error-prone, cross-platform allocation and use.
If you just want a timer that works with IOService, see IOTimer. Do not use this class unless you are IOTimer...if you really think you want to use this class then please email hellcatv@hotmail.com so I can talk you out of it, thank you.
Constructor & Destructor Documentation
| Sirikata::Network::DeadlineTimer::DeadlineTimer | ( | IOService & | io | ) |
| Sirikata::Network::DeadlineTimer::DeadlineTimer | ( | IOService * | io | ) |
| Sirikata::Network::DeadlineTimer::~DeadlineTimer | ( | ) | [virtual] |
Member Function Documentation
| std::size_t Sirikata::Network::DeadlineTimer::cancel | ( | boost::system::error_code & | ec | ) | [inline] |
Sometimes cancels the callback.
Often does nothing. Expect your function to get called
Referenced by Sirikata::Network::IOTimer::cancel().
| std::size_t Sirikata::Network::DeadlineTimer::cancel | ( | ) | [inline] |
Sometimes cancels the callback.
Often does nothing. Expect your function to get called
The documentation for this class was generated from the following files:
