|
1
|
1 #pragma once
|
|
|
2 #include <functional>
|
|
|
3
|
|
|
4 // fb2k::inMainThread moved to threadsLite.h
|
|
|
5
|
|
|
6
|
|
|
7
|
|
|
8 // ======================================================================================================
|
|
|
9 // API declarations
|
|
|
10 // ======================================================================================================
|
|
|
11
|
|
|
12 //! Callback object class for main_thread_callback_manager service. \n
|
|
|
13 //! You do not need to implement this directly - simply use fb2k::inMainThread() with a lambda.
|
|
|
14 class NOVTABLE main_thread_callback : public service_base {
|
|
|
15 public:
|
|
|
16 //! Gets called from main app thread. See main_thread_callback_manager description for more info.
|
|
|
17 virtual void callback_run() = 0;
|
|
|
18
|
|
|
19 void callback_enqueue(); // helper
|
|
|
20
|
|
|
21 FB2K_MAKE_SERVICE_INTERFACE(main_thread_callback,service_base);
|
|
|
22 };
|
|
|
23
|
|
|
24 /*!
|
|
|
25 Allows you to queue a callback object to be called from main app thread. This is commonly used to trigger main-thread-only API calls from worker threads.\n
|
|
|
26 This can be also used from main app thread, to avoid race conditions when trying to use APIs that dispatch global callbacks from inside some other global callback, or using message loops / modal dialogs inside global callbacks. \n
|
|
|
27 There is no need to use this API directly - use fb2k::inMainThread() with a lambda.
|
|
|
28 */
|
|
|
29 class NOVTABLE main_thread_callback_manager : public service_base {
|
|
|
30 public:
|
|
|
31 //! Queues a callback object. This can be called from any thread, implementation ensures multithread safety. Implementation will call p_callback->callback_run() once later. To get it called repeatedly, you would need to add your callback again. \n
|
|
|
32 //! Queued callbacks will be called in the same order as they were queued (FIFO).
|
|
|
33 virtual void add_callback(service_ptr_t<main_thread_callback> p_callback) = 0;
|
|
|
34
|
|
|
35 FB2K_MAKE_SERVICE_COREAPI(main_thread_callback_manager);
|
|
|
36 };
|
|
|
37
|
|
|
38 //! \since 2.0
|
|
|
39 //! Additional method added to help recovering from method-called-in-wrong-thread scenarios.
|
|
|
40 class NOVTABLE main_thread_callback_manager_v2 : public main_thread_callback_manager {
|
|
|
41 FB2K_MAKE_SERVICE_COREAPI_EXTENSION(main_thread_callback_manager_v2, main_thread_callback_manager)
|
|
|
42 public:
|
|
|
43 //! Uses win32 SendMessage() to invoke your callback synchronously, blocks until done. \n
|
|
|
44 //! If multiple threads call this, order of callbacks is undefined. \n
|
|
|
45 //! Callbacks run_synchronously() callbacks take precedence over add_callback().
|
|
|
46 virtual void run_synchronously( main_thread_callback::ptr ) = 0;
|
|
|
47 };
|
|
|
48
|
|
|
49 // ======================================================================================================
|
|
|
50 // Obsolete helpers - they still work, but it's easier to just use fb2k::inMainThread().
|
|
|
51 // ======================================================================================================
|
|
|
52
|
|
|
53 //! Helper, equivalent to main_thread_callback_manager::get()->add_callback(ptr)
|
|
|
54 void main_thread_callback_add(main_thread_callback::ptr ptr);
|
|
|
55
|
|
|
56 template<typename t_class> static void main_thread_callback_spawn() {
|
|
|
57 main_thread_callback_add(new service_impl_t<t_class>);
|
|
|
58 }
|
|
|
59 template<typename t_class, typename t_param1> static void main_thread_callback_spawn(const t_param1 & p1) {
|
|
|
60 main_thread_callback_add(new service_impl_t<t_class>(p1));
|
|
|
61 }
|
|
|
62 template<typename t_class, typename t_param1, typename t_param2> static void main_thread_callback_spawn(const t_param1 & p1, const t_param2 & p2) {
|
|
|
63 main_thread_callback_add(new service_impl_t<t_class>(p1, p2));
|
|
|
64 }
|
|
|
65
|
|
|
66 // More legacy helper code moved to helpers/callInMainThreadHelper.h |
