Realistic 3D camera system
3D camera system components
Public Types | Public Member Functions | List of all members
asio::waitable_timer_service< Clock, WaitTraits > Class Template Reference

Default service implementation for a timer. More...

#include <waitable_timer_service.hpp>

Inheritance diagram for asio::waitable_timer_service< Clock, WaitTraits >:
asio::detail::service_base< waitable_timer_service< Clock, WaitTraits > > asio::io_service::service asio::detail::noncopyable

Public Types

typedef Clock clock_type
 The clock type. More...
 
typedef clock_type::duration duration
 The duration type of the clock. More...
 
typedef clock_type::time_point time_point
 The time point type of the clock. More...
 
typedef WaitTraits traits_type
 The wait traits type. More...
 
typedef service_impl_type::implementation_type implementation_type
 The implementation type of the waitable timer. More...
 

Public Member Functions

 waitable_timer_service (asio::io_service &io_service)
 Construct a new timer service for the specified io_service. More...
 
void construct (implementation_type &impl)
 Construct a new timer implementation. More...
 
void destroy (implementation_type &impl)
 Destroy a timer implementation. More...
 
std::size_t cancel (implementation_type &impl, asio::error_code &ec)
 Cancel any asynchronous wait operations associated with the timer. More...
 
std::size_t cancel_one (implementation_type &impl, asio::error_code &ec)
 Cancels one asynchronous wait operation associated with the timer. More...
 
time_point expires_at (const implementation_type &impl) const
 Get the expiry time for the timer as an absolute time. More...
 
std::size_t expires_at (implementation_type &impl, const time_point &expiry_time, asio::error_code &ec)
 Set the expiry time for the timer as an absolute time. More...
 
duration expires_from_now (const implementation_type &impl) const
 Get the expiry time for the timer relative to now. More...
 
std::size_t expires_from_now (implementation_type &impl, const duration &expiry_time, asio::error_code &ec)
 Set the expiry time for the timer relative to now. More...
 
void wait (implementation_type &impl, asio::error_code &ec)
 
template<typename WaitHandler >
 ASIO_INITFN_RESULT_TYPE (WaitHandler, void(asio::error_code)) async_wait(implementation_type &impl
 
 ASIO_MOVE_ARG (WaitHandler) handler)
 
- Public Member Functions inherited from asio::detail::service_base< waitable_timer_service< Clock, WaitTraits > >
 service_base (asio::io_service &io_service)
 
- Public Member Functions inherited from asio::io_service::service
asio::io_serviceget_io_service ()
 Get the io_service object that owns the service. More...
 

Additional Inherited Members

- Static Public Attributes inherited from asio::detail::service_base< waitable_timer_service< Clock, WaitTraits > >
static asio::detail::service_id< waitable_timer_service< Clock, WaitTraits > > id
 
- Protected Member Functions inherited from asio::io_service::service
ASIO_DECL service (asio::io_service &owner)
 Constructor. More...
 
virtual ASIO_DECL ~service ()
 Destructor. More...
 

Detailed Description

template<typename Clock, typename WaitTraits = asio::wait_traits<Clock>>
class asio::waitable_timer_service< Clock, WaitTraits >

Default service implementation for a timer.

Definition at line 33 of file waitable_timer_service.hpp.

Member Typedef Documentation

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
typedef Clock asio::waitable_timer_service< Clock, WaitTraits >::clock_type

The clock type.

Definition at line 48 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
typedef clock_type::duration asio::waitable_timer_service< Clock, WaitTraits >::duration

The duration type of the clock.

Definition at line 51 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
typedef service_impl_type::implementation_type asio::waitable_timer_service< Clock, WaitTraits >::implementation_type

The implementation type of the waitable timer.

Definition at line 69 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
typedef clock_type::time_point asio::waitable_timer_service< Clock, WaitTraits >::time_point

The time point type of the clock.

Definition at line 54 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
typedef WaitTraits asio::waitable_timer_service< Clock, WaitTraits >::traits_type

The wait traits type.

Definition at line 57 of file waitable_timer_service.hpp.

Constructor & Destructor Documentation

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
asio::waitable_timer_service< Clock, WaitTraits >::waitable_timer_service ( asio::io_service io_service)
inlineexplicit

Construct a new timer service for the specified io_service.

Definition at line 73 of file waitable_timer_service.hpp.

Member Function Documentation

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
template<typename WaitHandler >
asio::waitable_timer_service< Clock, WaitTraits >::ASIO_INITFN_RESULT_TYPE ( WaitHandler  ,
void(asio::error_code  
)
template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
asio::waitable_timer_service< Clock, WaitTraits >::ASIO_MOVE_ARG ( WaitHandler  )
inline

Definition at line 142 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
std::size_t asio::waitable_timer_service< Clock, WaitTraits >::cancel ( implementation_type impl,
asio::error_code ec 
)
inline

Cancel any asynchronous wait operations associated with the timer.

Definition at line 93 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
std::size_t asio::waitable_timer_service< Clock, WaitTraits >::cancel_one ( implementation_type impl,
asio::error_code ec 
)
inline

Cancels one asynchronous wait operation associated with the timer.

Definition at line 99 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
void asio::waitable_timer_service< Clock, WaitTraits >::construct ( implementation_type impl)
inline

Construct a new timer implementation.

Definition at line 81 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
void asio::waitable_timer_service< Clock, WaitTraits >::destroy ( implementation_type impl)
inline

Destroy a timer implementation.

Definition at line 87 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
time_point asio::waitable_timer_service< Clock, WaitTraits >::expires_at ( const implementation_type impl) const
inline

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

Definition at line 106 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
std::size_t asio::waitable_timer_service< Clock, WaitTraits >::expires_at ( implementation_type impl,
const time_point expiry_time,
asio::error_code ec 
)
inline

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

Definition at line 112 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
duration asio::waitable_timer_service< Clock, WaitTraits >::expires_from_now ( const implementation_type impl) const
inline

Get the expiry time for the timer relative to now.

Definition at line 119 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
std::size_t asio::waitable_timer_service< Clock, WaitTraits >::expires_from_now ( implementation_type impl,
const duration expiry_time,
asio::error_code ec 
)
inline

Set the expiry time for the timer relative to now.

Definition at line 125 of file waitable_timer_service.hpp.

template<typename Clock , typename WaitTraits = asio::wait_traits<Clock>>
void asio::waitable_timer_service< Clock, WaitTraits >::wait ( implementation_type impl,
asio::error_code ec 
)
inline

Definition at line 132 of file waitable_timer_service.hpp.


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