// | |
// deadline_timer_service.hpp | |
// ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
// | |
// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com) | |
// | |
// Distributed under the Boost Software License, Version 1.0. (See accompanying | |
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | |
// | |
#ifndef BOOST_ASIO_DEADLINE_TIMER_SERVICE_HPP | |
#define BOOST_ASIO_DEADLINE_TIMER_SERVICE_HPP | |
#if defined(_MSC_VER) && (_MSC_VER >= 1200) | |
# pragma once | |
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) | |
#include <boost/asio/detail/config.hpp> | |
#include <cstddef> | |
#include <boost/asio/detail/deadline_timer_service.hpp> | |
#include <boost/asio/io_service.hpp> | |
#include <boost/asio/time_traits.hpp> | |
#include <boost/asio/detail/push_options.hpp> | |
namespace boost { | |
namespace asio { | |
/// Default service implementation for a timer. | |
template <typename TimeType, | |
typename TimeTraits = boost::asio::time_traits<TimeType> > | |
class deadline_timer_service | |
#if defined(GENERATING_DOCUMENTATION) | |
: public boost::asio::io_service::service | |
#else | |
: public boost::asio::detail::service_base< | |
deadline_timer_service<TimeType, TimeTraits> > | |
#endif | |
{ | |
public: | |
#if defined(GENERATING_DOCUMENTATION) | |
/// The unique service identifier. | |
static boost::asio::io_service::id id; | |
#endif | |
/// The time traits type. | |
typedef TimeTraits traits_type; | |
/// The time type. | |
typedef typename traits_type::time_type time_type; | |
/// The duration type. | |
typedef typename traits_type::duration_type duration_type; | |
private: | |
// The type of the platform-specific implementation. | |
typedef detail::deadline_timer_service<traits_type> service_impl_type; | |
public: | |
/// The implementation type of the deadline timer. | |
#if defined(GENERATING_DOCUMENTATION) | |
typedef implementation_defined implementation_type; | |
#else | |
typedef typename service_impl_type::implementation_type implementation_type; | |
#endif | |
/// Construct a new timer service for the specified io_service. | |
explicit deadline_timer_service(boost::asio::io_service& io_service) | |
: boost::asio::detail::service_base< | |
deadline_timer_service<TimeType, TimeTraits> >(io_service), | |
service_impl_(io_service) | |
{ | |
} | |
/// Destroy all user-defined handler objects owned by the service. | |
void shutdown_service() | |
{ | |
service_impl_.shutdown_service(); | |
} | |
/// Construct a new timer implementation. | |
void construct(implementation_type& impl) | |
{ | |
service_impl_.construct(impl); | |
} | |
/// Destroy a timer implementation. | |
void destroy(implementation_type& impl) | |
{ | |
service_impl_.destroy(impl); | |
} | |
/// Cancel any asynchronous wait operations associated with the timer. | |
std::size_t cancel(implementation_type& impl, boost::system::error_code& ec) | |
{ | |
return service_impl_.cancel(impl, ec); | |
} | |
/// Get the expiry time for the timer as an absolute time. | |
time_type expires_at(const implementation_type& impl) const | |
{ | |
return service_impl_.expires_at(impl); | |
} | |
/// Set the expiry time for the timer as an absolute time. | |
std::size_t expires_at(implementation_type& impl, | |
const time_type& expiry_time, boost::system::error_code& ec) | |
{ | |
return service_impl_.expires_at(impl, expiry_time, ec); | |
} | |
/// Get the expiry time for the timer relative to now. | |
duration_type expires_from_now(const implementation_type& impl) const | |
{ | |
return service_impl_.expires_from_now(impl); | |
} | |
/// Set the expiry time for the timer relative to now. | |
std::size_t expires_from_now(implementation_type& impl, | |
const duration_type& expiry_time, boost::system::error_code& ec) | |
{ | |
return service_impl_.expires_from_now(impl, expiry_time, ec); | |
} | |
// Perform a blocking wait on the timer. | |
void wait(implementation_type& impl, boost::system::error_code& ec) | |
{ | |
service_impl_.wait(impl, ec); | |
} | |
// Start an asynchronous wait on the timer. | |
template <typename WaitHandler> | |
void async_wait(implementation_type& impl, WaitHandler handler) | |
{ | |
service_impl_.async_wait(impl, handler); | |
} | |
private: | |
// The platform-specific implementation. | |
service_impl_type service_impl_; | |
}; | |
} // namespace asio | |
} // namespace boost | |
#include <boost/asio/detail/pop_options.hpp> | |
#endif // BOOST_ASIO_DEADLINE_TIMER_SERVICE_HPP |