1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
//
// system_executor.hpp
// ~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2019 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_SYSTEM_EXECUTOR_HPP
#define BOOST_ASIO_SYSTEM_EXECUTOR_HPP
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
#include <boost/asio/detail/config.hpp>
#include <boost/asio/detail/push_options.hpp>
namespace boost {
namespace asio {
class system_context;
/// An executor that uses arbitrary threads.
/**
* The system executor represents an execution context where functions are
* permitted to run on arbitrary threads. The post() and defer() functions
* schedule the function to run on an unspecified system thread pool, and
* dispatch() invokes the function immediately.
*/
class system_executor
{
public:
/// Obtain the underlying execution context.
system_context& context() const BOOST_ASIO_NOEXCEPT;
/// Inform the executor that it has some outstanding work to do.
/**
* For the system executor, this is a no-op.
*/
void on_work_started() const BOOST_ASIO_NOEXCEPT
{
}
/// Inform the executor that some work is no longer outstanding.
/**
* For the system executor, this is a no-op.
*/
void on_work_finished() const BOOST_ASIO_NOEXCEPT
{
}
/// Request the system executor to invoke the given function object.
/**
* This function is used to ask the executor to execute the given function
* object. The function object will always be executed inside this function.
*
* @param f The function object to be called. The executor will make
* a copy of the handler object as required. The function signature of the
* function object must be: @code void function(); @endcode
*
* @param a An allocator that may be used by the executor to allocate the
* internal storage needed for function invocation.
*/
template <typename Function, typename Allocator>
void dispatch(BOOST_ASIO_MOVE_ARG(Function) f, const Allocator& a) const;
/// Request the system executor to invoke the given function object.
/**
* This function is used to ask the executor to execute the given function
* object. The function object will never be executed inside this function.
* Instead, it will be scheduled to run on an unspecified system thread pool.
*
* @param f The function object to be called. The executor will make
* a copy of the handler object as required. The function signature of the
* function object must be: @code void function(); @endcode
*
* @param a An allocator that may be used by the executor to allocate the
* internal storage needed for function invocation.
*/
template <typename Function, typename Allocator>
void post(BOOST_ASIO_MOVE_ARG(Function) f, const Allocator& a) const;
/// Request the system executor to invoke the given function object.
/**
* This function is used to ask the executor to execute the given function
* object. The function object will never be executed inside this function.
* Instead, it will be scheduled to run on an unspecified system thread pool.
*
* @param f The function object to be called. The executor will make
* a copy of the handler object as required. The function signature of the
* function object must be: @code void function(); @endcode
*
* @param a An allocator that may be used by the executor to allocate the
* internal storage needed for function invocation.
*/
template <typename Function, typename Allocator>
void defer(BOOST_ASIO_MOVE_ARG(Function) f, const Allocator& a) const;
/// Compare two executors for equality.
/**
* System executors always compare equal.
*/
friend bool operator==(const system_executor&,
const system_executor&) BOOST_ASIO_NOEXCEPT
{
return true;
}
/// Compare two executors for inequality.
/**
* System executors always compare equal.
*/
friend bool operator!=(const system_executor&,
const system_executor&) BOOST_ASIO_NOEXCEPT
{
return false;
}
};
} // namespace asio
} // namespace boost
#include <boost/asio/detail/pop_options.hpp>
#include <boost/asio/impl/system_executor.hpp>
#endif // BOOST_ASIO_SYSTEM_EXECUTOR_HPP
|
