mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-03-28 19:20:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

btstack_run_loop: provide details on btstack_run_loop_execute_on_main_thread semantics

Browse Source
This commit is contained in:
Matthias Ringwald 2022-04-12 16:41:43 +02:00
parent 30199e24c8
commit cfa92d39ae
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/btstack_run_loop.h
View File

@ -199,7 +199,7 @@ void btstack_run_loop_base_poll_data_sources(void);
void btstack_run_loop_base_add_callback(btstack_context_callback_registration_t * callback_registration);
/**
* @bried Procss Callbacks: remove all callback-registrations and call the registered function with its context
* @bried Process Callbacks: remove all callback-registrations and call the registered function with its context
*/
void btstack_run_loop_base_execute_callbacks(void);
@ -330,7 +330,11 @@ void btstack_run_loop_execute(void);
/**
* @brief Registers callback with run loop and mark main thread as ready
* @note Callback can only be registered once
* @note If callback is already registered, the call will be ignored.
* This function allows to implement, e.g., a quque-based message passing mechanism:
* The external thread puts an item into a queue and call this function to trigger
* processing by the BTstack main thread. If this happens multiple times, it is
* guranteed that the callback will run at least once after the last item was added.
* @param callback_registration
*/
void btstack_run_loop_execute_on_main_thread(btstack_context_callback_registration_t * callback_registration);