asio::deadline_timer_service< TimeType, TimeTraits > Class Template Reference

Default service implementation for a timer. More...

#include <deadline_timer_service.hpp>

Inheritance diagram for asio::deadline_timer_service< TimeType, TimeTraits >:

List of all members.

Public Types
typedef traits_type::duration_type	duration_type
	The duration type.
typedef service_impl_type::implementation_type	implementation_type
	The implementation type of the deadline timer.
typedef traits_type::time_type	time_type
	The time type.
typedef TimeTraits	traits_type
	The time traits type.
Public Member Functions
template<typename WaitHandler >
void	async_wait (implementation_type &impl, WaitHandler handler)
std::size_t	cancel (implementation_type &impl, asio::error_code &ec)
	Cancel any asynchronous wait operations associated with the timer.
void	construct (implementation_type &impl)
	Construct a new timer implementation.
	deadline_timer_service (asio::io_service &io_service)
	Construct a new timer service for the specified io_service.
void	destroy (implementation_type &impl)
	Destroy a timer implementation.
time_type	expires_at (const implementation_type &impl) const
	Get the expiry time for the timer as an absolute time.
std::size_t	expires_at (implementation_type &impl, const time_type &expiry_time, asio::error_code &ec)
	Set the expiry time for the timer as an absolute time.
duration_type	expires_from_now (const implementation_type &impl) const
	Get the expiry time for the timer relative to now.
std::size_t	expires_from_now (implementation_type &impl, const duration_type &expiry_time, asio::error_code &ec)
	Set the expiry time for the timer relative to now.
void	shutdown_service ()
	Destroy all user-defined handler objects owned by the service.
void	wait (implementation_type &impl, asio::error_code &ec)
Private Types
typedef detail::deadline_timer_service < traits_type, detail::select_reactor< false > >	service_impl_type
Private Attributes
service_impl_type &	service_impl_

---

Detailed Description

template<typename TimeType, typename TimeTraits = asio::time_traits<TimeType>>
class asio::deadline_timer_service< TimeType, TimeTraits >

Default service implementation for a timer.

Definition at line 39 of file deadline_timer_service.hpp.

---

Member Typedef Documentation

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

typedef traits_type::duration_type asio::deadline_timer_service< TimeType, TimeTraits >::duration_type

The duration type.

Definition at line 60 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

typedef service_impl_type::implementation_type asio::deadline_timer_service< TimeType, TimeTraits >::implementation_type

The implementation type of the deadline timer.

Definition at line 86 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

typedef detail::deadline_timer_service< traits_type, detail::select_reactor<false> > asio::deadline_timer_service< TimeType, TimeTraits >::service_impl_type [private]

Definition at line 78 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

typedef traits_type::time_type asio::deadline_timer_service< TimeType, TimeTraits >::time_type

The time type.

Definition at line 57 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

typedef TimeTraits asio::deadline_timer_service< TimeType, TimeTraits >::traits_type

The time traits type.

Definition at line 54 of file deadline_timer_service.hpp.

---

Constructor & Destructor Documentation

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

asio::deadline_timer_service< TimeType, TimeTraits >::deadline_timer_service

(

asio::io_service &

io_service

)

[inline, explicit]

Construct a new timer service for the specified io_service.

Definition at line 90 of file deadline_timer_service.hpp.

---

Member Function Documentation

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

template<typename WaitHandler >

void asio::deadline_timer_service< TimeType, TimeTraits >::async_wait	(	implementation_type &	impl,
		WaitHandler	handler
	)		[inline]

Definition at line 154 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

std::size_t asio::deadline_timer_service< TimeType, TimeTraits >::cancel	(	implementation_type &	impl,
		asio::error_code &	ec
	)		[inline]

Cancel any asynchronous wait operations associated with the timer.

Definition at line 115 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

void asio::deadline_timer_service< TimeType, TimeTraits >::construct

(

implementation_type &

impl

)

[inline]

Construct a new timer implementation.

Definition at line 103 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

void asio::deadline_timer_service< TimeType, TimeTraits >::destroy

(

implementation_type &

impl

)

[inline]

Destroy a timer implementation.

Definition at line 109 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

time_type asio::deadline_timer_service< TimeType, TimeTraits >::expires_at

(

const implementation_type &

impl

)

const [inline]

Get the expiry time for the timer as an absolute time.

Definition at line 121 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

std::size_t asio::deadline_timer_service< TimeType, TimeTraits >::expires_at	(	implementation_type &	impl,
		const time_type &	expiry_time,
		asio::error_code &	ec
	)		[inline]

Set the expiry time for the timer as an absolute time.

Definition at line 127 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

duration_type asio::deadline_timer_service< TimeType, TimeTraits >::expires_from_now

(

const implementation_type &

impl

)

const [inline]

Get the expiry time for the timer relative to now.

Definition at line 134 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

std::size_t asio::deadline_timer_service< TimeType, TimeTraits >::expires_from_now	(	implementation_type &	impl,
		const duration_type &	expiry_time,
		asio::error_code &	ec
	)		[inline]

Set the expiry time for the timer relative to now.

Definition at line 140 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

void asio::deadline_timer_service< TimeType, TimeTraits >::shutdown_service

(

)

[inline, virtual]

Destroy all user-defined handler objects owned by the service.

Implements asio::io_service::service.

Definition at line 98 of file deadline_timer_service.hpp.

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

void asio::deadline_timer_service< TimeType, TimeTraits >::wait	(	implementation_type &	impl,
		asio::error_code &	ec
	)		[inline]

Definition at line 147 of file deadline_timer_service.hpp.

---

Member Data Documentation

template<typename TimeType , typename TimeTraits = asio::time_traits<TimeType>>

service_impl_type& asio::deadline_timer_service< TimeType, TimeTraits >::service_impl_ [private]

Definition at line 161 of file deadline_timer_service.hpp.

---

The documentation for this class was generated from the following file:

• deadline_timer_service.hpp