The nrf_log backend interface. More...
Data Structures |
|
| struct | nrf_log_backend_api_t |
|
Logger backend API.
More...
|
|
| struct | nrf_log_backend_s |
|
Logger backend structure.
More...
|
|
Typedefs |
|
| typedef nrf_memobj_t | nrf_log_entry_t |
|
nrf_log entry.
|
|
| typedef struct nrf_log_backend_s | nrf_log_backend_t |
Functions |
|
| __STATIC_INLINE void | nrf_log_backend_put ( nrf_log_backend_t const *p_backend, nrf_log_entry_t *p_msg) |
|
Function for putting message with log entry to the backend.
More...
|
|
| __STATIC_INLINE void | nrf_log_backend_panic_set ( nrf_log_backend_t const *p_backend) |
|
Function for reconfiguring backend to panic mode.
More...
|
|
| __STATIC_INLINE void | nrf_log_backend_flush ( nrf_log_backend_t const *p_backend) |
|
Function for flushing backend.
More...
|
|
| __STATIC_INLINE void | nrf_log_backend_id_set ( nrf_log_backend_t *p_backend, uint8_t id) |
|
Function for setting backend id.
More...
|
|
| __STATIC_INLINE uint8_t | nrf_log_backend_id_get ( nrf_log_backend_t const *p_backend) |
|
Function for getting backend id.
More...
|
|
| __STATIC_INLINE void | nrf_log_backend_enable ( nrf_log_backend_t *p_backend) |
|
Function for enabling backend.
More...
|
|
| __STATIC_INLINE void | nrf_log_backend_disable ( nrf_log_backend_t *p_backend) |
|
Function for disabling backend.
More...
|
|
| __STATIC_INLINE bool | nrf_log_backend_is_enabled ( nrf_log_backend_t const *p_backend) |
|
Function for checking state of the backend.
More...
|
|
Detailed Description
The nrf_log backend interface.
Function Documentation
| __STATIC_INLINE void nrf_log_backend_disable | ( | nrf_log_backend_t * | p_backend | ) |
Function for disabling backend.
- Parameters
-
[in] p_backend Pointer to the backend instance.
| __STATIC_INLINE void nrf_log_backend_enable | ( | nrf_log_backend_t * | p_backend | ) |
Function for enabling backend.
- Parameters
-
[in] p_backend Pointer to the backend instance.
| __STATIC_INLINE void nrf_log_backend_flush | ( | nrf_log_backend_t const * | p_backend | ) |
Function for flushing backend.
On flushing request backend should release log message(s).
- Parameters
-
[in] p_backend Pointer to the backend instance.
| __STATIC_INLINE uint8_t nrf_log_backend_id_get | ( | nrf_log_backend_t const * | p_backend | ) |
Function for getting backend id.
- Note
- It is used internally by the logger.
- Parameters
-
[in] p_backend Pointer to the backend instance.
- Returns
- Id.
| __STATIC_INLINE void nrf_log_backend_id_set | ( | nrf_log_backend_t * | p_backend , |
| uint8_t | id | ||
| ) |
Function for setting backend id.
- Note
- It is used internally by the logger.
- Parameters
-
[in] p_backend Pointer to the backend instance. [in] id Id.
| __STATIC_INLINE bool nrf_log_backend_is_enabled | ( | nrf_log_backend_t const * | p_backend | ) |
Function for checking state of the backend.
- Parameters
-
[in] p_backend Pointer to the backend instance.
- Returns
- True if backend is enabled, false otherwise.
| __STATIC_INLINE void nrf_log_backend_panic_set | ( | nrf_log_backend_t const * | p_backend | ) |
Function for reconfiguring backend to panic mode.
- Parameters
-
[in] p_backend Pointer to the backend instance.
| __STATIC_INLINE void nrf_log_backend_put | ( | nrf_log_backend_t const * | p_backend , |
| nrf_log_entry_t * | p_msg | ||
| ) |
Function for putting message with log entry to the backend.
- Parameters
-
[in] p_backend Pointer to the backend instance. [in] p_msg Pointer to message with log entry.