Reference | Class Hierarchy | Class Index | Member Index |
Inheritance diagram for asio::basic_deadline_timer< Time_Type, Time_Traits, Service >:
The basic_deadline_timer class template provides the ability to perform a blocking or asynchronous wait for a timer to expire.
Most applications will use the asio::deadline_timer typedef.
// Construct a timer without setting an expiry time. asio::deadline_timer timer(io_service); // Set an expiry time relative to now. timer.expires_from_now(boost::posix_time::seconds(5)); // Wait for the timer to expire. timer.wait();
void handler(const asio::error& error) { if (!error) { // Timer expired. } } ... // Construct a timer with an absolute expiry time. asio::deadline_timer timer(io_service, boost::posix_time::time_from_string("2005-12-07 23:59:59.000")); // Start an asynchronous wait. timer.async_wait(handler);
Public Types | |
typedef asio::error | error_type |
The type used for reporting errors. | |
typedef Time_Traits | traits_type |
The time traits type. | |
typedef traits_type::time_type | time_type |
The time type. | |
typedef traits_type::duration_type | duration_type |
The duration type. | |
typedef Service | service_type |
The type of the service that will be used to provide I/O operations. | |
typedef service_type::implementation_type | implementation_type |
The underlying implementation type of I/O object. | |
Public Member Functions | |
basic_deadline_timer (asio::io_service &io_service) | |
Constructor. | |
basic_deadline_timer (asio::io_service &io_service, const time_type &expiry_time) | |
Constructor to set a particular expiry time as an absolute time. | |
basic_deadline_timer (asio::io_service &io_service, const duration_type &expiry_time) | |
Constructor to set a particular expiry time relative to now. | |
std::size_t | cancel () |
Cancel any asynchronous operations that are waiting on the timer. | |
time_type | expires_at () const |
Get the timer's expiry time as an absolute time. | |
std::size_t | expires_at (const time_type &expiry_time) |
Set the timer's expiry time as an absolute time. | |
duration_type | expires_from_now () const |
Get the timer's expiry time relative to now. | |
std::size_t | expires_from_now (const duration_type &expiry_time) |
Set the timer's expiry time relative to now. | |
void | wait () |
Perform a blocking wait on the timer. | |
template<typename Handler> | |
void | async_wait (Handler handler) |
Start an asynchronous wait on the timer. | |
asio::io_service & | io_service () |
Get the io_service associated with the object. |
typedef asio::error asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::error_type |
The type used for reporting errors.
typedef Time_Traits asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::traits_type |
The time traits type.
typedef traits_type::time_type asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::time_type |
The time type.
typedef traits_type::duration_type asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::duration_type |
The duration type.
typedef Service asio::basic_io_object< Service >::service_type [inherited] |
The type of the service that will be used to provide I/O operations.
typedef service_type::implementation_type asio::basic_io_object< Service >::implementation_type [inherited] |
The underlying implementation type of I/O object.
asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::basic_deadline_timer | ( | asio::io_service & | io_service | ) | [explicit] |
Constructor.
This constructor creates a timer without setting an expiry time. The expires_at() or expires_from_now() functions must be called to set an expiry time before the timer can be waited on.
io_service | The io_service object that the timer will use to dispatch handlers for any asynchronous operations performed on the timer. |
asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::basic_deadline_timer | ( | asio::io_service & | io_service, | |
const time_type & | expiry_time | |||
) |
Constructor to set a particular expiry time as an absolute time.
This constructor creates a timer and sets the expiry time.
io_service | The io_service object that the timer will use to dispatch handlers for any asynchronous operations performed on the timer. | |
expiry_time | The expiry time to be used for the timer, expressed as an absolute time. |
asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::basic_deadline_timer | ( | asio::io_service & | io_service, | |
const duration_type & | expiry_time | |||
) |
Constructor to set a particular expiry time relative to now.
This constructor creates a timer and sets the expiry time.
io_service | The io_service object that the timer will use to dispatch handlers for any asynchronous operations performed on the timer. | |
expiry_time | The expiry time to be used for the timer, relative to now. |
std::size_t asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::cancel | ( | ) |
Cancel any asynchronous operations that are waiting on the timer.
This function forces the completion of any pending asynchronous wait operations against the timer. The handler for each cancelled operation will be invoked with the asio::error::operation_aborted error code.
Cancelling the timer does not change the expiry time.
time_type asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::expires_at | ( | ) | const |
Get the timer's expiry time as an absolute time.
This function may be used to obtain the timer's current expiry time. Whether the timer has expired or not does not affect this value.
std::size_t asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::expires_at | ( | const time_type & | expiry_time | ) |
Set the timer's expiry time as an absolute time.
This function sets the expiry time. Any pending asynchronous wait operations will be cancelled. The handler for each cancelled operation will be invoked with the asio::error::operation_aborted error code.
See Changing an active deadline_timer's expiry time for more information on altering the expiry time of an active timer.
expiry_time | The expiry time to be used for the timer. |
duration_type asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::expires_from_now | ( | ) | const |
Get the timer's expiry time relative to now.
This function may be used to obtain the timer's current expiry time. Whether the timer has expired or not does not affect this value.
std::size_t asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::expires_from_now | ( | const duration_type & | expiry_time | ) |
Set the timer's expiry time relative to now.
This function sets the expiry time. Any pending asynchronous wait operations will be cancelled. The handler for each cancelled operation will be invoked with the asio::error::operation_aborted error code.
See Changing an active deadline_timer's expiry time for more information on altering the expiry time of an active timer.
expiry_time | The expiry time to be used for the timer. |
void asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::wait | ( | ) |
Perform a blocking wait on the timer.
This function is used to wait for the timer to expire. This function blocks and does not return until the timer has expired.
asio::error | Thrown on failure. |
void asio::basic_deadline_timer< Time_Type, Time_Traits, Service >::async_wait | ( | Handler | handler | ) |
Start an asynchronous wait on the timer.
This function may be used to initiate an asynchronous wait against the timer. It always returns immediately.
For each call to async_wait(), the supplied handler will be called exactly once. The handler will be called when:
handler | The handler to be called when the timer expires. Copies will be made of the handler as required. The function signature of the handler must be: void handler( const asio::error& error // Result of operation ); |
asio::io_service& asio::basic_io_object< Service >::io_service | ( | ) | [inherited] |
Get the io_service associated with the object.
This function may be used to obtain the io_service object that the I/O object uses to dispatch handlers for asynchronous operations.