tridentiot-sdk-docs/v2026.03.xx/tr__cli__buffer_8h_source.html

#ifndef TR_CLI_BUFFER_H

#define TR_CLI_BUFFER_H


#include <stdint.h>


void tr_cli_buffer_init(void);


void tr_cli_buffer_byte(uint8_t new_input_char);


void tr_cli_buffer_process_bytes(void);


void tr_cli_buffer_clear_stats(void);


typedef struct

{

    uint8_t buffer_high_watermark;


    uint16_t byte_drops;


    uint16_t buffer_size;


} tr_cli_buffer_stats_t;


tr_cli_buffer_stats_t tr_cli_buffer_get_stats(void);


#endif // TR_CLI_BUFFER_H

tr_cli_buffer_get_stats
tr_cli_buffer_stats_t tr_cli_buffer_get_stats(void)
Reads the current buffer driver statistics.

tr_cli_buffer_process_bytes
void tr_cli_buffer_process_bytes(void)
Processes buffered bytes and hands them to the CLI.

tr_cli_buffer_byte
void tr_cli_buffer_byte(uint8_t new_input_char)
Stores a byte from the UART in the buffer.

tr_cli_buffer_clear_stats
void tr_cli_buffer_clear_stats(void)
Clears the buffer driver statistics.

tr_cli_buffer_init
void tr_cli_buffer_init(void)
Initializes the CLI byte buffer.

tr_cli_buffer_stats_t
Structure containing CLI buffer driver statistics.
Definition tr_cli_buffer.h:64

tr_cli_buffer_stats_t::buffer_high_watermark
uint8_t buffer_high_watermark
Maximum number of buffered bytes at any time since stats were cleared.
Definition tr_cli_buffer.h:68

tr_cli_buffer_stats_t::buffer_size
uint16_t buffer_size
Size of the character buffer.
Definition tr_cli_buffer.h:78

tr_cli_buffer_stats_t::byte_drops
uint16_t byte_drops
Number of character drops due to buffer being full.
Definition tr_cli_buffer.h:73