mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-11-23 13:03:13 +00:00
6d8b050eda
* Furi: epoll prototype * Gui: simplify view_dispatcher custom event processing * Furi: add missing critical sections to epoll * Furi: add epoll unit tests, fully implement level processing for in and out events * Furi: properly trigger epoll item event on adding mq, update tests. * Unit tests: cleanup defines * Furi: protect epoll from modification in callback * Furi: rename epoll into event_loop, cleanup api naming * Sync API Symbols * Furi: add event loop contract and link api, port mq to new api, cleanup code * Format Sources * Furi: cleanup mq and event loop code * Furi: remove unused staff from message queue * ApiSymbols: remove event loop from public APIs. * Fix furi unit tests --------- Co-authored-by: Georgii Surkov <georgii.surkov@outlook.com> Co-authored-by: Georgii Surkov <37121527+gsurkov@users.noreply.github.com>
134 lines
3.8 KiB
C
134 lines
3.8 KiB
C
/**
|
|
* @file event_loop.h
|
|
* @brief Furi Event Loop
|
|
*
|
|
* This module is designed to handle application event loop in fully
|
|
* asynchronous, reactive nature. On the low level this modules is
|
|
* inspired by epoll/kqueue concept, on the high level by asyncio
|
|
* event loop.
|
|
*
|
|
* This module is trying to best fit into Furi OS, so we don't
|
|
* provide any compatibility with other event driven APIs. But
|
|
* programming concepts are the same, except some runtime
|
|
* limitations from our side.
|
|
*/
|
|
#pragma once
|
|
|
|
#include "base.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Event Loop events */
|
|
typedef enum {
|
|
FuriEventLoopEventOut, /**< On departure: item was retrieved from container, flag reset, etc... */
|
|
FuriEventLoopEventIn, /**< On arrival: item was inserted into container, flag set, etc... */
|
|
} FuriEventLoopEvent;
|
|
|
|
/** Anonymous message queue type */
|
|
typedef struct FuriEventLoop FuriEventLoop;
|
|
|
|
/** Allocate Event Loop instance
|
|
*
|
|
* Couple things to keep in mind:
|
|
* - You can have 1 event_loop per 1 thread
|
|
* - You can not use event_loop instance in the other thread
|
|
* - Do not use blocking api to query object delegated to Event Loop
|
|
*
|
|
* @return The Event Loop instance
|
|
*/
|
|
FuriEventLoop* furi_event_loop_alloc(void);
|
|
|
|
/** Free Event Loop instance
|
|
*
|
|
* @param instance The Event Loop instance
|
|
*/
|
|
void furi_event_loop_free(FuriEventLoop* instance);
|
|
|
|
/** Continuously poll for events
|
|
*
|
|
* Can be stopped with `furi_event_loop_stop`
|
|
*
|
|
* @param instance The Event Loop instance
|
|
*/
|
|
void furi_event_loop_run(FuriEventLoop* instance);
|
|
|
|
/** Stop Event Loop instance
|
|
*
|
|
* @param instance The Event Loop instance
|
|
*/
|
|
void furi_event_loop_stop(FuriEventLoop* instance);
|
|
|
|
/*
|
|
* Tick related API
|
|
*/
|
|
|
|
/** Tick callback type
|
|
*
|
|
* @param context The context for callback
|
|
*/
|
|
typedef void (*FuriEventLoopTickCallback)(void* context);
|
|
|
|
/** Set Event Loop tick callback
|
|
*
|
|
* Tick callback called after specified inactivity time. It's not periodic. If
|
|
* Event Loop is busy then ticks will be skipped.
|
|
*
|
|
* @param instance The Event Loop instance
|
|
* @param[in] interval The tick interval
|
|
* @param[in] callback The callback to call
|
|
* @param context The context for callback
|
|
*/
|
|
void furi_event_loop_tick_set(
|
|
FuriEventLoop* instance,
|
|
uint32_t interval,
|
|
FuriEventLoopTickCallback callback,
|
|
void* context);
|
|
|
|
/*
|
|
* Message queue related APIs
|
|
*/
|
|
|
|
/** Anonymous message queue type */
|
|
typedef struct FuriMessageQueue FuriMessageQueue;
|
|
|
|
/** Callback type for message queue
|
|
*
|
|
* @param queue The queue that triggered event
|
|
* @param context The context that was provided on
|
|
* furi_event_loop_message_queue_subscribe call
|
|
*
|
|
* @return true if event was processed, false if we need to delay processing
|
|
*/
|
|
typedef bool (*FuriEventLoopMessageQueueCallback)(FuriMessageQueue* queue, void* context);
|
|
|
|
/** Subscribe to message queue events
|
|
*
|
|
* @warning you can only have one subscription for one event type.
|
|
*
|
|
* @param instance The Event Loop instance
|
|
* @param message_queue The message queue to add
|
|
* @param[in] event The Event Loop event to trigger on
|
|
* @param[in] callback The callback to call on event
|
|
* @param context The context for callback
|
|
*/
|
|
void furi_event_loop_message_queue_subscribe(
|
|
FuriEventLoop* instance,
|
|
FuriMessageQueue* message_queue,
|
|
FuriEventLoopEvent event,
|
|
FuriEventLoopMessageQueueCallback callback,
|
|
void* context);
|
|
|
|
/** Unsubscribe from message queue
|
|
*
|
|
* @param instance The Event Loop instance
|
|
* @param message_queue The message queue
|
|
*/
|
|
void furi_event_loop_message_queue_unsubscribe(
|
|
FuriEventLoop* instance,
|
|
FuriMessageQueue* message_queue);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|