Audio plugin host https://kx.studio/carla
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

239 lines
8.2KB

  1. //
  2. // detail/select_reactor.hpp
  3. // ~~~~~~~~~~~~~~~~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2019 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. //
  10. #ifndef ASIO_DETAIL_SELECT_REACTOR_HPP
  11. #define ASIO_DETAIL_SELECT_REACTOR_HPP
  12. #if defined(_MSC_VER) && (_MSC_VER >= 1200)
  13. # pragma once
  14. #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
  15. #include "asio/detail/config.hpp"
  16. #if defined(ASIO_HAS_IOCP) \
  17. || (!defined(ASIO_HAS_DEV_POLL) \
  18. && !defined(ASIO_HAS_EPOLL) \
  19. && !defined(ASIO_HAS_KQUEUE) \
  20. && !defined(ASIO_WINDOWS_RUNTIME))
  21. #include <cstddef>
  22. #include "asio/detail/fd_set_adapter.hpp"
  23. #include "asio/detail/limits.hpp"
  24. #include "asio/detail/mutex.hpp"
  25. #include "asio/detail/op_queue.hpp"
  26. #include "asio/detail/reactor_op.hpp"
  27. #include "asio/detail/reactor_op_queue.hpp"
  28. #include "asio/detail/select_interrupter.hpp"
  29. #include "asio/detail/socket_types.hpp"
  30. #include "asio/detail/timer_queue_base.hpp"
  31. #include "asio/detail/timer_queue_set.hpp"
  32. #include "asio/detail/wait_op.hpp"
  33. #include "asio/execution_context.hpp"
  34. #if defined(ASIO_HAS_IOCP)
  35. # include "asio/detail/thread.hpp"
  36. #endif // defined(ASIO_HAS_IOCP)
  37. #include "asio/detail/push_options.hpp"
  38. namespace asio {
  39. namespace detail {
  40. class select_reactor
  41. : public execution_context_service_base<select_reactor>
  42. {
  43. public:
  44. #if defined(ASIO_WINDOWS) || defined(__CYGWIN__)
  45. enum op_types { read_op = 0, write_op = 1, except_op = 2,
  46. max_select_ops = 3, connect_op = 3, max_ops = 4 };
  47. #else // defined(ASIO_WINDOWS) || defined(__CYGWIN__)
  48. enum op_types { read_op = 0, write_op = 1, except_op = 2,
  49. max_select_ops = 3, connect_op = 1, max_ops = 3 };
  50. #endif // defined(ASIO_WINDOWS) || defined(__CYGWIN__)
  51. // Per-descriptor data.
  52. struct per_descriptor_data
  53. {
  54. };
  55. // Constructor.
  56. ASIO_DECL select_reactor(asio::execution_context& ctx);
  57. // Destructor.
  58. ASIO_DECL ~select_reactor();
  59. // Destroy all user-defined handler objects owned by the service.
  60. ASIO_DECL void shutdown();
  61. // Recreate internal descriptors following a fork.
  62. ASIO_DECL void notify_fork(
  63. asio::execution_context::fork_event fork_ev);
  64. // Initialise the task, but only if the reactor is not in its own thread.
  65. ASIO_DECL void init_task();
  66. // Register a socket with the reactor. Returns 0 on success, system error
  67. // code on failure.
  68. ASIO_DECL int register_descriptor(socket_type, per_descriptor_data&);
  69. // Register a descriptor with an associated single operation. Returns 0 on
  70. // success, system error code on failure.
  71. ASIO_DECL int register_internal_descriptor(
  72. int op_type, socket_type descriptor,
  73. per_descriptor_data& descriptor_data, reactor_op* op);
  74. // Post a reactor operation for immediate completion.
  75. void post_immediate_completion(reactor_op* op, bool is_continuation)
  76. {
  77. scheduler_.post_immediate_completion(op, is_continuation);
  78. }
  79. // Start a new operation. The reactor operation will be performed when the
  80. // given descriptor is flagged as ready, or an error has occurred.
  81. ASIO_DECL void start_op(int op_type, socket_type descriptor,
  82. per_descriptor_data&, reactor_op* op, bool is_continuation, bool);
  83. // Cancel all operations associated with the given descriptor. The
  84. // handlers associated with the descriptor will be invoked with the
  85. // operation_aborted error.
  86. ASIO_DECL void cancel_ops(socket_type descriptor, per_descriptor_data&);
  87. // Cancel any operations that are running against the descriptor and remove
  88. // its registration from the reactor. The reactor resources associated with
  89. // the descriptor must be released by calling cleanup_descriptor_data.
  90. ASIO_DECL void deregister_descriptor(socket_type descriptor,
  91. per_descriptor_data&, bool closing);
  92. // Remove the descriptor's registration from the reactor. The reactor
  93. // resources associated with the descriptor must be released by calling
  94. // cleanup_descriptor_data.
  95. ASIO_DECL void deregister_internal_descriptor(
  96. socket_type descriptor, per_descriptor_data&);
  97. // Perform any post-deregistration cleanup tasks associated with the
  98. // descriptor data.
  99. ASIO_DECL void cleanup_descriptor_data(per_descriptor_data&);
  100. // Move descriptor registration from one descriptor_data object to another.
  101. ASIO_DECL void move_descriptor(socket_type descriptor,
  102. per_descriptor_data& target_descriptor_data,
  103. per_descriptor_data& source_descriptor_data);
  104. // Add a new timer queue to the reactor.
  105. template <typename Time_Traits>
  106. void add_timer_queue(timer_queue<Time_Traits>& queue);
  107. // Remove a timer queue from the reactor.
  108. template <typename Time_Traits>
  109. void remove_timer_queue(timer_queue<Time_Traits>& queue);
  110. // Schedule a new operation in the given timer queue to expire at the
  111. // specified absolute time.
  112. template <typename Time_Traits>
  113. void schedule_timer(timer_queue<Time_Traits>& queue,
  114. const typename Time_Traits::time_type& time,
  115. typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op);
  116. // Cancel the timer operations associated with the given token. Returns the
  117. // number of operations that have been posted or dispatched.
  118. template <typename Time_Traits>
  119. std::size_t cancel_timer(timer_queue<Time_Traits>& queue,
  120. typename timer_queue<Time_Traits>::per_timer_data& timer,
  121. std::size_t max_cancelled = (std::numeric_limits<std::size_t>::max)());
  122. // Move the timer operations associated with the given timer.
  123. template <typename Time_Traits>
  124. void move_timer(timer_queue<Time_Traits>& queue,
  125. typename timer_queue<Time_Traits>::per_timer_data& target,
  126. typename timer_queue<Time_Traits>::per_timer_data& source);
  127. // Run select once until interrupted or events are ready to be dispatched.
  128. ASIO_DECL void run(long usec, op_queue<operation>& ops);
  129. // Interrupt the select loop.
  130. ASIO_DECL void interrupt();
  131. private:
  132. #if defined(ASIO_HAS_IOCP)
  133. // Run the select loop in the thread.
  134. ASIO_DECL void run_thread();
  135. #endif // defined(ASIO_HAS_IOCP)
  136. // Helper function to add a new timer queue.
  137. ASIO_DECL void do_add_timer_queue(timer_queue_base& queue);
  138. // Helper function to remove a timer queue.
  139. ASIO_DECL void do_remove_timer_queue(timer_queue_base& queue);
  140. // Get the timeout value for the select call.
  141. ASIO_DECL timeval* get_timeout(long usec, timeval& tv);
  142. // Cancel all operations associated with the given descriptor. This function
  143. // does not acquire the select_reactor's mutex.
  144. ASIO_DECL void cancel_ops_unlocked(socket_type descriptor,
  145. const asio::error_code& ec);
  146. // The scheduler implementation used to post completions.
  147. # if defined(ASIO_HAS_IOCP)
  148. typedef class win_iocp_io_context scheduler_type;
  149. # else // defined(ASIO_HAS_IOCP)
  150. typedef class scheduler scheduler_type;
  151. # endif // defined(ASIO_HAS_IOCP)
  152. scheduler_type& scheduler_;
  153. // Mutex to protect access to internal data.
  154. asio::detail::mutex mutex_;
  155. // The interrupter is used to break a blocking select call.
  156. select_interrupter interrupter_;
  157. // The queues of read, write and except operations.
  158. reactor_op_queue<socket_type> op_queue_[max_ops];
  159. // The file descriptor sets to be passed to the select system call.
  160. fd_set_adapter fd_sets_[max_select_ops];
  161. // The timer queues.
  162. timer_queue_set timer_queues_;
  163. #if defined(ASIO_HAS_IOCP)
  164. // Helper class to run the reactor loop in a thread.
  165. class thread_function;
  166. friend class thread_function;
  167. // Does the reactor loop thread need to stop.
  168. bool stop_thread_;
  169. // The thread that is running the reactor loop.
  170. asio::detail::thread* thread_;
  171. #endif // defined(ASIO_HAS_IOCP)
  172. // Whether the service has been shut down.
  173. bool shutdown_;
  174. };
  175. } // namespace detail
  176. } // namespace asio
  177. #include "asio/detail/pop_options.hpp"
  178. #include "asio/detail/impl/select_reactor.hpp"
  179. #if defined(ASIO_HEADER_ONLY)
  180. # include "asio/detail/impl/select_reactor.ipp"
  181. #endif // defined(ASIO_HEADER_ONLY)
  182. #endif // defined(ASIO_HAS_IOCP)
  183. // || (!defined(ASIO_HAS_DEV_POLL)
  184. // && !defined(ASIO_HAS_EPOLL)
  185. // && !defined(ASIO_HAS_KQUEUE)
  186. // && !defined(ASIO_WINDOWS_RUNTIME))
  187. #endif // ASIO_DETAIL_SELECT_REACTOR_HPP