Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
bt_mesh_hb_cb Struct Reference

#include <heartbeat.h>

Data Fields

void(* recv )(const struct bt_mesh_hb_sub *sub, uint8_t hops, uint16_t feat)
 Receive callback for heartbeats. More...
 
void(* sub_end )(const struct bt_mesh_hb_sub *sub)
 Subscription end callback for heartbeats. More...
 

Detailed Description

Heartbeat callback structure

Field Documentation

◆ recv

void(* bt_mesh_hb_cb::recv) (const struct bt_mesh_hb_sub *sub, uint8_t hops, uint16_t feat)

Receive callback for heartbeats.

Gets called on every received Heartbeat that matches the current Heartbeat subscription parameters.

Parameters
subCurrent Heartbeat subscription parameters.
hopsThe number of hops the Heartbeat was received with.
featThe feature set of the publishing node. The value is a bitmap of BT_MESH_FEAT_RELAY, BT_MESH_FEAT_PROXY, BT_MESH_FEAT_FRIEND and BT_MESH_FEAT_LOW_POWER.

◆ sub_end

void(* bt_mesh_hb_cb::sub_end) (const struct bt_mesh_hb_sub *sub)

Subscription end callback for heartbeats.

Gets called when the subscription period ends, providing a summary of the received heartbeat messages.

Parameters
subCurrent Heartbeat subscription parameters.

The documentation for this struct was generated from the following file: