Object Transfer Service, HVX buffering

nRF5 SDK v14.1.0

Object Transfer Service module. More...

Data Structures

struct ble_hvx_t
ble_hvx_t represents one notification/indication. More...
struct ble_hvx_buf_t
ble_hvx_buf_t is the structure holding the state of the hvx buffering module. More...

Macros

#define BLE_HVX_BUF_LEN (1 << 3)
#define BLE_HVX_BUF_MASK (BLE_HVX_BUF_LEN-1)

Functions

uint32_t ble_hvx_init ( ble_hvx_buf_t *p_ble_hvx_buf)
Function for initializing the HVX buffer module. More...
ble_hvx_t * ble_hvx_get_p_to_next_hvx ( ble_hvx_buf_t *p_ble_hvx_buf)
Function for obtaining the pointer to the next hvx. The user can then fill out the hvx structure. More...
uint32_t ble_hvx_buffer_process ( ble_hvx_buf_t *p_ble_hvx_buf)
Function for sending something from the HVX buffer. More...

Detailed Description

Object Transfer Service module.

This module is responsible for buffering indications and notifications.

Function Documentation

uint32_t ble_hvx_buffer_process ( ble_hvx_buf_t * p_ble_hvx_buf )

Function for sending something from the HVX buffer.

Parameters
[in] p_ble_hvx_buf HVX buffering structure.
Returns
NRF_SUCCESS If a indication/notification was successfully sent.
ble_hvx_t * ble_hvx_get_p_to_next_hvx ( ble_hvx_buf_t * p_ble_hvx_buf )

Function for obtaining the pointer to the next hvx. The user can then fill out the hvx structure.

Parameters
[in] p_ble_hvx_buf HVX buffering structure.
Returns
ble_hvx_t * If there is a free ble_hvx_t .
NULL If there is no free ble_hvx_t , or an invalid parameter is supplied.
uint32_t ble_hvx_init ( ble_hvx_buf_t * p_ble_hvx_buf )

Function for initializing the HVX buffer module.

Parameters
[out] p_ble_hvx_buf HVX buffering structure.
Returns
NRF_SUCCESS If the given paramer is valid.