nl::Weave::Profiles::Heartbeat::WeaveHeartbeatReceiver

#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>

Weave Heartbeat Receiver class.

Summary

Inheritance

Inherits from: nl::Weave::WeaveServerBase

Constructors and Destructors
WeaveHeartbeatReceiver(void)

Public types
OnHeartbeatReceivedHandler)(const WeaveMessageInfo *aMsgInfo, uint8_t nodeState, WEAVE_ERROR err) typedef
void(*

Public attributes
OnHeartbeatReceived
OnHeartbeatReceivedHandler

Public functions
Init(WeaveExchangeManager *exchangeMgr)
Initialize the Weave Heartbeat Receiver and register to receive Weave Heartbeat messages.
Shutdown(void)
Shutdown the Weave Heartbeat Receiver and unregister the reception of Weave Heartbeat messages.

Public types

OnHeartbeatReceivedHandler

void(* OnHeartbeatReceivedHandler)(const WeaveMessageInfo *aMsgInfo, uint8_t nodeState, WEAVE_ERROR err)

Public attributes

OnHeartbeatReceived

OnHeartbeatReceivedHandler OnHeartbeatReceived

Public functions

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialize the Weave Heartbeat Receiver and register to receive Weave Heartbeat messages.

Details
Parameters
[in] exchangeMgr
A pointer to the system Weave Exchange Manager.
Return Values
WEAVE_ERROR_INCORRECT_STATE
If exchange manager is not null
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
If too many message handlers have already been registered.
WEAVE_NO_ERROR
On success.

Shutdown

WEAVE_ERROR Shutdown(
  void
)

Shutdown the Weave Heartbeat Receiver and unregister the reception of Weave Heartbeat messages.

Details
Return Values
WEAVE_NO_ERROR
On success.

WeaveHeartbeatReceiver

 WeaveHeartbeatReceiver(
  void
)