annotate DEPENDENCIES/generic/include/boost/asio/signal_set_service.hpp @ 125:34e428693f5d vext

Vext -> Repoint
author Chris Cannam
date Thu, 14 Jun 2018 11:15:39 +0100
parents c530137014c0
children
rev   line source
Chris@16 1 //
Chris@16 2 // signal_set_service.hpp
Chris@16 3 // ~~~~~~~~~~~~~~~~~~~~~~
Chris@16 4 //
Chris@101 5 // Copyright (c) 2003-2015 Christopher M. Kohlhoff (chris at kohlhoff dot com)
Chris@16 6 //
Chris@16 7 // Distributed under the Boost Software License, Version 1.0. (See accompanying
Chris@16 8 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16 9 //
Chris@16 10
Chris@16 11 #ifndef BOOST_ASIO_SIGNAL_SET_SERVICE_HPP
Chris@16 12 #define BOOST_ASIO_SIGNAL_SET_SERVICE_HPP
Chris@16 13
Chris@16 14 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16 15 # pragma once
Chris@16 16 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16 17
Chris@16 18 #include <boost/asio/detail/config.hpp>
Chris@16 19 #include <boost/asio/async_result.hpp>
Chris@16 20 #include <boost/asio/detail/signal_set_service.hpp>
Chris@16 21 #include <boost/asio/error.hpp>
Chris@16 22 #include <boost/asio/io_service.hpp>
Chris@16 23
Chris@16 24 #include <boost/asio/detail/push_options.hpp>
Chris@16 25
Chris@16 26 namespace boost {
Chris@16 27 namespace asio {
Chris@16 28
Chris@16 29 /// Default service implementation for a signal set.
Chris@16 30 class signal_set_service
Chris@16 31 #if defined(GENERATING_DOCUMENTATION)
Chris@16 32 : public boost::asio::io_service::service
Chris@16 33 #else
Chris@16 34 : public boost::asio::detail::service_base<signal_set_service>
Chris@16 35 #endif
Chris@16 36 {
Chris@16 37 public:
Chris@16 38 #if defined(GENERATING_DOCUMENTATION)
Chris@16 39 /// The unique service identifier.
Chris@16 40 static boost::asio::io_service::id id;
Chris@16 41 #endif
Chris@16 42
Chris@16 43 public:
Chris@16 44 /// The type of a signal set implementation.
Chris@16 45 #if defined(GENERATING_DOCUMENTATION)
Chris@16 46 typedef implementation_defined implementation_type;
Chris@16 47 #else
Chris@16 48 typedef detail::signal_set_service::implementation_type implementation_type;
Chris@16 49 #endif
Chris@16 50
Chris@16 51 /// Construct a new signal set service for the specified io_service.
Chris@16 52 explicit signal_set_service(boost::asio::io_service& io_service)
Chris@16 53 : boost::asio::detail::service_base<signal_set_service>(io_service),
Chris@16 54 service_impl_(io_service)
Chris@16 55 {
Chris@16 56 }
Chris@16 57
Chris@16 58 /// Construct a new signal set implementation.
Chris@16 59 void construct(implementation_type& impl)
Chris@16 60 {
Chris@16 61 service_impl_.construct(impl);
Chris@16 62 }
Chris@16 63
Chris@16 64 /// Destroy a signal set implementation.
Chris@16 65 void destroy(implementation_type& impl)
Chris@16 66 {
Chris@16 67 service_impl_.destroy(impl);
Chris@16 68 }
Chris@16 69
Chris@16 70 /// Add a signal to a signal_set.
Chris@16 71 boost::system::error_code add(implementation_type& impl,
Chris@16 72 int signal_number, boost::system::error_code& ec)
Chris@16 73 {
Chris@16 74 return service_impl_.add(impl, signal_number, ec);
Chris@16 75 }
Chris@16 76
Chris@16 77 /// Remove a signal to a signal_set.
Chris@16 78 boost::system::error_code remove(implementation_type& impl,
Chris@16 79 int signal_number, boost::system::error_code& ec)
Chris@16 80 {
Chris@16 81 return service_impl_.remove(impl, signal_number, ec);
Chris@16 82 }
Chris@16 83
Chris@16 84 /// Remove all signals from a signal_set.
Chris@16 85 boost::system::error_code clear(implementation_type& impl,
Chris@16 86 boost::system::error_code& ec)
Chris@16 87 {
Chris@16 88 return service_impl_.clear(impl, ec);
Chris@16 89 }
Chris@16 90
Chris@16 91 /// Cancel all operations associated with the signal set.
Chris@16 92 boost::system::error_code cancel(implementation_type& impl,
Chris@16 93 boost::system::error_code& ec)
Chris@16 94 {
Chris@16 95 return service_impl_.cancel(impl, ec);
Chris@16 96 }
Chris@16 97
Chris@16 98 // Start an asynchronous operation to wait for a signal to be delivered.
Chris@16 99 template <typename SignalHandler>
Chris@16 100 BOOST_ASIO_INITFN_RESULT_TYPE(SignalHandler,
Chris@16 101 void (boost::system::error_code, int))
Chris@16 102 async_wait(implementation_type& impl,
Chris@16 103 BOOST_ASIO_MOVE_ARG(SignalHandler) handler)
Chris@16 104 {
Chris@16 105 detail::async_result_init<
Chris@16 106 SignalHandler, void (boost::system::error_code, int)> init(
Chris@16 107 BOOST_ASIO_MOVE_CAST(SignalHandler)(handler));
Chris@16 108
Chris@16 109 service_impl_.async_wait(impl, init.handler);
Chris@16 110
Chris@16 111 return init.result.get();
Chris@16 112 }
Chris@16 113
Chris@16 114 private:
Chris@16 115 // Destroy all user-defined handler objects owned by the service.
Chris@16 116 void shutdown_service()
Chris@16 117 {
Chris@16 118 service_impl_.shutdown_service();
Chris@16 119 }
Chris@16 120
Chris@16 121 // Perform any fork-related housekeeping.
Chris@16 122 void fork_service(boost::asio::io_service::fork_event event)
Chris@16 123 {
Chris@16 124 service_impl_.fork_service(event);
Chris@16 125 }
Chris@16 126
Chris@16 127 // The platform-specific implementation.
Chris@16 128 detail::signal_set_service service_impl_;
Chris@16 129 };
Chris@16 130
Chris@16 131 } // namespace asio
Chris@16 132 } // namespace boost
Chris@16 133
Chris@16 134 #include <boost/asio/detail/pop_options.hpp>
Chris@16 135
Chris@16 136 #endif // BOOST_ASIO_SIGNAL_SET_SERVICE_HPP