nrf_cli_transport_t

nRF5 SDK v13.0.0

Unified CLI transport interface. More...

#include <nrf_cli.h>

Data Fields

ret_code_t (* init )(void)
Initializes CLI transport interface. More...
ret_code_t (* uninit )(void)
Uninitialize CLI transport interface. More...
ret_code_t (* write )(const void *p_data, size_t length, size_t *p_cnt)
Writes data to transport interface. More...
ret_code_t (* read )(void *p_data, size_t length, size_t *p_cnt)
Reads data from transport interface. More...

Detailed Description

Unified CLI transport interface.

Field Documentation

ret_code_t (* nrf_cli_transport_t::init)(void)

Initializes CLI transport interface.

Returns
Standard error code.
ret_code_t (* nrf_cli_transport_t::read)(void *p_data, size_t length, size_t *p_cnt)

Reads data from transport interface.

Parameters
p_data Destination buffer.
length Destination buffer length.
p_cnt Number of bytes received (NULL might be passed).
Returns
Standard error code.
ret_code_t (* nrf_cli_transport_t::uninit)(void)

Uninitialize CLI transport interface.

Returns
Standard error code.
ret_code_t (* nrf_cli_transport_t::write)(const void *p_data, size_t length, size_t *p_cnt)

Writes data to transport interface.

Parameters
p_data Source buffer.
length Source buffer length.
p_cnt Number of bytes written (NULL might be passed).
Returns
Standard error code.
  • components/libraries/cli/nrf_cli.h