event_flag.h File Reference

Furi Event Flag. More...

#include "base.h"

Go to the source code of this file.

Typedefs
typedef struct FuriEventFlag	FuriEventFlag
	Opaque event flag type.

Functions
FuriEventFlag *	furi_event_flag_alloc (void)
	Allocate FuriEventFlag.
void	furi_event_flag_free (FuriEventFlag *instance)
	Deallocate FuriEventFlag.
uint32_t	furi_event_flag_set (FuriEventFlag *instance, uint32_t flags)
	Set flags.
uint32_t	furi_event_flag_clear (FuriEventFlag *instance, uint32_t flags)
	Clear flags.
uint32_t	furi_event_flag_get (FuriEventFlag *instance)
	Get flags.
uint32_t	furi_event_flag_wait (FuriEventFlag *instance, uint32_t flags, uint32_t options, uint32_t timeout)
	Wait flags.

Detailed Description

Furi Event Flag.

Function Documentation

furi_event_flag_alloc()

FuriEventFlag * furi_event_flag_alloc

(

void

)

Allocate FuriEventFlag.

Returns

pointer to FuriEventFlag

furi_event_flag_clear()

uint32_t furi_event_flag_clear	(	FuriEventFlag *	instance,
		uint32_t	flags )

Clear flags.

Parameters

	instance	pointer to FuriEventFlag
[in]	flags	The flags

Returns

Resulting flags or error (FuriStatus)

furi_event_flag_free()

void furi_event_flag_free

(

FuriEventFlag *

instance

)

Deallocate FuriEventFlag.

Parameters

instance

pointer to FuriEventFlag

furi_event_flag_get()

uint32_t furi_event_flag_get

(

FuriEventFlag *

instance

)

Get flags.

Parameters

instance

pointer to FuriEventFlag

Returns

Resulting flags

furi_event_flag_set()

uint32_t furi_event_flag_set	(	FuriEventFlag *	instance,
		uint32_t	flags )

Set flags.

Warning

result of this function can be flags that you've just asked to set or not if someone was waiting for them and asked to clear it. It is highly recommended to read this function and xEventGroupSetBits source code.

Parameters

	instance	pointer to FuriEventFlag
[in]	flags	The flags to set

Returns

Resulting flags(see warning) or error (FuriStatus)

furi_event_flag_wait()

uint32_t furi_event_flag_wait	(	FuriEventFlag *	instance,
		uint32_t	flags,
		uint32_t	options,
		uint32_t	timeout )

Wait flags.

Parameters

	instance	pointer to FuriEventFlag
[in]	flags	The flags
[in]	options	The option flags
[in]	timeout	The timeout

Returns

Resulting flags or error (FuriStatus)