fix doc example typo
[boost.git] / boost / asio / impl / io_service.ipp
blobe936f3649af7e0804b7ff17649a20cde3334a6d1
1 //
2 // io_service.ipp
3 // ~~~~~~~~~~~~~~
4 //
5 // Copyright (c) 2003-2008 Christopher M. Kohlhoff (chris at kohlhoff dot com)
6 //
7 // Distributed under the Boost Software License, Version 1.0. (See accompanying
8 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
9 //
11 #ifndef BOOST_ASIO_IO_SERVICE_IPP
12 #define BOOST_ASIO_IO_SERVICE_IPP
14 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
15 # pragma once
16 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
18 #include <boost/asio/detail/push_options.hpp>
20 #include <boost/asio/detail/push_options.hpp>
21 #include <limits>
22 #include <boost/asio/detail/pop_options.hpp>
24 #include <boost/asio/detail/dev_poll_reactor.hpp>
25 #include <boost/asio/detail/epoll_reactor.hpp>
26 #include <boost/asio/detail/kqueue_reactor.hpp>
27 #include <boost/asio/detail/select_reactor.hpp>
28 #include <boost/asio/detail/service_registry.hpp>
29 #include <boost/asio/detail/task_io_service.hpp>
30 #include <boost/asio/detail/throw_error.hpp>
31 #include <boost/asio/detail/win_iocp_io_service.hpp>
33 namespace boost {
34 namespace asio {
36 inline io_service::io_service()
37   : service_registry_(new boost::asio::detail::service_registry(*this)),
38     impl_(service_registry_->use_service<impl_type>())
40   impl_.init((std::numeric_limits<std::size_t>::max)());
43 inline io_service::io_service(std::size_t concurrency_hint)
44   : service_registry_(new boost::asio::detail::service_registry(*this)),
45     impl_(service_registry_->use_service<impl_type>())
47   impl_.init(concurrency_hint);
50 inline io_service::~io_service()
52   delete service_registry_;
55 inline std::size_t io_service::run()
57   boost::system::error_code ec;
58   std::size_t s = impl_.run(ec);
59   boost::asio::detail::throw_error(ec);
60   return s;
63 inline std::size_t io_service::run(boost::system::error_code& ec)
65   return impl_.run(ec);
68 inline std::size_t io_service::run_one()
70   boost::system::error_code ec;
71   std::size_t s = impl_.run_one(ec);
72   boost::asio::detail::throw_error(ec);
73   return s;
76 inline std::size_t io_service::run_one(boost::system::error_code& ec)
78   return impl_.run_one(ec);
81 inline std::size_t io_service::poll()
83   boost::system::error_code ec;
84   std::size_t s = impl_.poll(ec);
85   boost::asio::detail::throw_error(ec);
86   return s;
89 inline std::size_t io_service::poll(boost::system::error_code& ec)
91   return impl_.poll(ec);
94 inline std::size_t io_service::poll_one()
96   boost::system::error_code ec;
97   std::size_t s = impl_.poll_one(ec);
98   boost::asio::detail::throw_error(ec);
99   return s;
102 inline std::size_t io_service::poll_one(boost::system::error_code& ec)
104   return impl_.poll_one(ec);
107 inline void io_service::stop()
109   impl_.stop();
112 inline void io_service::reset()
114   impl_.reset();
117 template <typename Handler>
118 inline void io_service::dispatch(Handler handler)
120   impl_.dispatch(handler);
123 template <typename Handler>
124 inline void io_service::post(Handler handler)
126   impl_.post(handler);
129 template <typename Handler>
130 #if defined(GENERATING_DOCUMENTATION)
131 unspecified
132 #else
133 inline detail::wrapped_handler<io_service&, Handler>
134 #endif
135 io_service::wrap(Handler handler)
137   return detail::wrapped_handler<io_service&, Handler>(*this, handler);
140 inline io_service::work::work(boost::asio::io_service& io_service)
141   : io_service_(io_service)
143   io_service_.impl_.work_started();
146 inline io_service::work::work(const work& other)
147   : io_service_(other.io_service_)
149   io_service_.impl_.work_started();
152 inline io_service::work::~work()
154   io_service_.impl_.work_finished();
157 inline boost::asio::io_service& io_service::work::io_service()
159   return io_service_;
162 inline boost::asio::io_service& io_service::work::get_io_service()
164   return io_service_;
167 inline io_service::service::service(boost::asio::io_service& owner)
168   : owner_(owner),
169     type_info_(0),
170     next_(0)
174 inline io_service::service::~service()
178 inline boost::asio::io_service& io_service::service::io_service()
180   return owner_;
183 inline boost::asio::io_service& io_service::service::get_io_service()
185   return owner_;
188 template <typename Service>
189 inline Service& use_service(io_service& ios)
191   // Check that Service meets the necessary type requirements.
192   (void)static_cast<io_service::service*>(static_cast<Service*>(0));
193   (void)static_cast<const io_service::id*>(&Service::id);
195   return ios.service_registry_->template use_service<Service>();
198 template <typename Service>
199 void add_service(io_service& ios, Service* svc)
201   // Check that Service meets the necessary type requirements.
202   (void)static_cast<io_service::service*>(static_cast<Service*>(0));
203   (void)static_cast<const io_service::id*>(&Service::id);
205   if (&ios != &svc->io_service())
206     boost::throw_exception(invalid_service_owner());
207   if (!ios.service_registry_->template add_service<Service>(svc))
208     boost::throw_exception(service_already_exists());
211 template <typename Service>
212 bool has_service(io_service& ios)
214   // Check that Service meets the necessary type requirements.
215   (void)static_cast<io_service::service*>(static_cast<Service*>(0));
216   (void)static_cast<const io_service::id*>(&Service::id);
218   return ios.service_registry_->template has_service<Service>();
221 } // namespace asio
222 } // namespace boost
224 #include <boost/asio/detail/pop_options.hpp>
226 #endif // BOOST_ASIO_IO_SERVICE_IPP