[FL-1906] Documentation: add Doxyfile, prepare sources for doxygen. (#741)
* Documentation: add Doxyfile, prepare sources for doxygen. * Update ReadMe and remove obsolete CLA * Add contribution guide * Contributing: update text * Correct spelling
This commit is contained in:
@@ -1,3 +1,8 @@
|
||||
/**
|
||||
* @file thread.h
|
||||
* Furi: Furi Thread API
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
@@ -18,109 +23,130 @@ typedef enum {
|
||||
/** FuriThread anonymous structure */
|
||||
typedef struct FuriThread FuriThread;
|
||||
|
||||
/** FuriThreadCallback
|
||||
* Your callback to run in new thread
|
||||
* @warning don't use osThreadExit
|
||||
/** FuriThreadCallback Your callback to run in new thread
|
||||
* @warning never use osThreadExit in FuriThread
|
||||
*/
|
||||
typedef int32_t (*FuriThreadCallback)(void* context);
|
||||
|
||||
/** FuriThread state change calback
|
||||
* called upon thread state change
|
||||
* @param state - new thread state
|
||||
* @param context - callback context
|
||||
/** FuriThread state change calback called upon thread state change
|
||||
* @param state new thread state
|
||||
* @param context callback context
|
||||
*/
|
||||
typedef void (*FuriThreadStateCallback)(FuriThreadState state, void* context);
|
||||
|
||||
/** Allocate FuriThread
|
||||
* @return FuriThread instance
|
||||
*
|
||||
* @return FuriThread instance
|
||||
*/
|
||||
FuriThread* furi_thread_alloc();
|
||||
|
||||
/** Release FuriThread
|
||||
* @param thread - FuriThread instance
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*/
|
||||
void furi_thread_free(FuriThread* thread);
|
||||
|
||||
/** Set FuriThread name
|
||||
* @param thread - FuriThread instance
|
||||
* @param name - string
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
* @param name string
|
||||
*/
|
||||
void furi_thread_set_name(FuriThread* thread, const char* name);
|
||||
|
||||
/** Set FuriThread stack size
|
||||
* @param thread - FuriThread instance
|
||||
* @param stack_size - stack size in bytes
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
* @param stack_size stack size in bytes
|
||||
*/
|
||||
void furi_thread_set_stack_size(FuriThread* thread, size_t stack_size);
|
||||
|
||||
/** Set FuriThread callback
|
||||
* @param thread - FuriThread instance
|
||||
* @param callback - FuriThreadCallback, called upon thread run
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
* @param callback FuriThreadCallback, called upon thread run
|
||||
*/
|
||||
void furi_thread_set_callback(FuriThread* thread, FuriThreadCallback callback);
|
||||
|
||||
/** Set FuriThread context
|
||||
* @param thread - FuriThread instance
|
||||
* @param context - pointer to context for thread callback
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
* @param context pointer to context for thread callback
|
||||
*/
|
||||
void furi_thread_set_context(FuriThread* thread, void* context);
|
||||
|
||||
/** Set FuriThread state change callback
|
||||
* @param thread - FuriThread instance
|
||||
* @param callack - state change callback
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
* @param callback state change callback
|
||||
*/
|
||||
void furi_thread_set_state_callback(FuriThread* thread, FuriThreadStateCallback callback);
|
||||
|
||||
/** Set FuriThread state change context
|
||||
* @param thread - FuriThread instance
|
||||
* @param context - pointer to context
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
* @param context pointer to context
|
||||
*/
|
||||
void furi_thread_set_state_context(FuriThread* thread, void* context);
|
||||
|
||||
/** Get FuriThread state
|
||||
* @param thread - FuriThread instance
|
||||
* @return thread state from FuriThreadState
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*
|
||||
* @return thread state from FuriThreadState
|
||||
*/
|
||||
FuriThreadState furi_thread_get_state(FuriThread* thread);
|
||||
|
||||
/** Start FuriThread
|
||||
* @param thread - FuriThread instance
|
||||
* @return true on success
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*
|
||||
* @return true on success
|
||||
*/
|
||||
bool furi_thread_start(FuriThread* thread);
|
||||
|
||||
/** Treminate FuriThread
|
||||
* @param thread - FuriThread instance
|
||||
* @return osStatus_t
|
||||
* @warning terminating statefull thread is dangerous
|
||||
* use only if you know what you doing
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*
|
||||
* @return osStatus_t
|
||||
* @warning terminating statefull thread is dangerous use only if you know
|
||||
* what you doing
|
||||
*/
|
||||
osStatus_t furi_thread_terminate(FuriThread* thread);
|
||||
|
||||
/** Join FuriThread
|
||||
* @param thread - FuriThread instance
|
||||
* @return osStatus_t
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*
|
||||
* @return osStatus_t
|
||||
*/
|
||||
osStatus_t furi_thread_join(FuriThread* thread);
|
||||
|
||||
/** Get CMSIS Thread ID
|
||||
* @param thread - FuriThread instance
|
||||
* @return osThreadId_t or NULL
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*
|
||||
* @return osThreadId_t or NULL
|
||||
*/
|
||||
osThreadId_t furi_thread_get_thread_id(FuriThread* thread);
|
||||
|
||||
/** Enable heap tracing
|
||||
* @param thread - FuriThread instance
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*/
|
||||
void furi_thread_enable_heap_trace(FuriThread* thread);
|
||||
|
||||
/** Disable heap tracing
|
||||
* @param thread - FuriThread instance
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*/
|
||||
void furi_thread_disable_heap_trace(FuriThread* thread);
|
||||
|
||||
/** Get thread heap size
|
||||
* @param thread - FuriThread instance
|
||||
*
|
||||
* @param thread FuriThread instance
|
||||
*
|
||||
* @return size in bytes
|
||||
*/
|
||||
size_t furi_thread_get_heap_size(FuriThread* thread);
|
||||
|
||||
|
Reference in New Issue
Block a user