winrt_timer_scheduler.hpp 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. //
  2. // detail/winrt_timer_scheduler.hpp
  3. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2025 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 BOOST_ASIO_DETAIL_WINRT_TIMER_SCHEDULER_HPP
  11. #define BOOST_ASIO_DETAIL_WINRT_TIMER_SCHEDULER_HPP
  12. #if defined(_MSC_VER) && (_MSC_VER >= 1200)
  13. # pragma once
  14. #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
  15. #include <boost/asio/detail/config.hpp>
  16. #if defined(BOOST_ASIO_WINDOWS_RUNTIME)
  17. #include <cstddef>
  18. #include <boost/asio/detail/event.hpp>
  19. #include <boost/asio/detail/limits.hpp>
  20. #include <boost/asio/detail/mutex.hpp>
  21. #include <boost/asio/detail/op_queue.hpp>
  22. #include <boost/asio/detail/thread.hpp>
  23. #include <boost/asio/detail/timer_queue_base.hpp>
  24. #include <boost/asio/detail/timer_queue_set.hpp>
  25. #include <boost/asio/detail/wait_op.hpp>
  26. #include <boost/asio/execution_context.hpp>
  27. #if defined(BOOST_ASIO_HAS_IOCP)
  28. # include <boost/asio/detail/win_iocp_io_context.hpp>
  29. #else // defined(BOOST_ASIO_HAS_IOCP)
  30. # include <boost/asio/detail/scheduler.hpp>
  31. #endif // defined(BOOST_ASIO_HAS_IOCP)
  32. #if defined(BOOST_ASIO_HAS_IOCP)
  33. # include <boost/asio/detail/thread.hpp>
  34. #endif // defined(BOOST_ASIO_HAS_IOCP)
  35. #include <boost/asio/detail/push_options.hpp>
  36. namespace boost {
  37. namespace asio {
  38. namespace detail {
  39. class winrt_timer_scheduler
  40. : public execution_context_service_base<winrt_timer_scheduler>
  41. {
  42. public:
  43. // Constructor.
  44. BOOST_ASIO_DECL winrt_timer_scheduler(execution_context& context);
  45. // Destructor.
  46. BOOST_ASIO_DECL ~winrt_timer_scheduler();
  47. // Destroy all user-defined handler objects owned by the service.
  48. BOOST_ASIO_DECL void shutdown();
  49. // Recreate internal descriptors following a fork.
  50. BOOST_ASIO_DECL void notify_fork(execution_context::fork_event fork_ev);
  51. // Initialise the task. No effect as this class uses its own thread.
  52. BOOST_ASIO_DECL void init_task();
  53. // Add a new timer queue to the reactor.
  54. template <typename TimeTraits, typename Allocator>
  55. void add_timer_queue(timer_queue<TimeTraits, Allocator>& queue);
  56. // Remove a timer queue from the reactor.
  57. template <typename TimeTraits, typename Allocator>
  58. void remove_timer_queue(timer_queue<TimeTraits, Allocator>& queue);
  59. // Schedule a new operation in the given timer queue to expire at the
  60. // specified absolute time.
  61. template <typename TimeTraits, typename Allocator>
  62. void schedule_timer(timer_queue<TimeTraits, Allocator>& queue,
  63. const typename TimeTraits::time_type& time,
  64. typename timer_queue<TimeTraits, Allocator>::per_timer_data& timer,
  65. wait_op* op);
  66. // Cancel the timer operations associated with the given token. Returns the
  67. // number of operations that have been posted or dispatched.
  68. template <typename TimeTraits, typename Allocator>
  69. std::size_t cancel_timer(timer_queue<TimeTraits, Allocator>& queue,
  70. typename timer_queue<TimeTraits, Allocator>::per_timer_data& timer,
  71. std::size_t max_cancelled = (std::numeric_limits<std::size_t>::max)());
  72. // Move the timer operations associated with the given timer.
  73. template <typename TimeTraits, typename Allocator>
  74. void move_timer(timer_queue<TimeTraits, Allocator>& queue,
  75. typename timer_queue<TimeTraits, Allocator>::per_timer_data& to,
  76. typename timer_queue<TimeTraits, Allocator>::per_timer_data& from);
  77. private:
  78. // Run the select loop in the thread.
  79. BOOST_ASIO_DECL void run_thread();
  80. // Entry point for the select loop thread.
  81. BOOST_ASIO_DECL static void call_run_thread(winrt_timer_scheduler* reactor);
  82. // Helper function to add a new timer queue.
  83. BOOST_ASIO_DECL void do_add_timer_queue(timer_queue_base& queue);
  84. // Helper function to remove a timer queue.
  85. BOOST_ASIO_DECL void do_remove_timer_queue(timer_queue_base& queue);
  86. // The scheduler implementation used to post completions.
  87. #if defined(BOOST_ASIO_HAS_IOCP)
  88. typedef class win_iocp_io_context scheduler_impl;
  89. #else
  90. typedef class scheduler scheduler_impl;
  91. #endif
  92. scheduler_impl& scheduler_;
  93. // Mutex used to protect internal variables.
  94. boost::asio::detail::mutex mutex_;
  95. // Event used to wake up background thread.
  96. boost::asio::detail::event event_;
  97. // The timer queues.
  98. timer_queue_set timer_queues_;
  99. // The background thread that is waiting for timers to expire.
  100. boost::asio::detail::thread thread_;
  101. // Does the background thread need to stop.
  102. bool stop_thread_;
  103. // Whether the service has been shut down.
  104. bool shutdown_;
  105. };
  106. } // namespace detail
  107. } // namespace asio
  108. } // namespace boost
  109. #include <boost/asio/detail/pop_options.hpp>
  110. #include <boost/asio/detail/impl/winrt_timer_scheduler.hpp>
  111. #if defined(BOOST_ASIO_HEADER_ONLY)
  112. # include <boost/asio/detail/impl/winrt_timer_scheduler.ipp>
  113. #endif // defined(BOOST_ASIO_HEADER_ONLY)
  114. #endif // defined(BOOST_ASIO_WINDOWS_RUNTIME)
  115. #endif // BOOST_ASIO_DETAIL_WINRT_TIMER_SCHEDULER_HPP