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

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

Weave の Heartbeat Receiver クラス。

概要

継承

継承元: nl::Weave::WeaveServerBase

コンストラクタとデストラクタ

WeaveHeartbeatReceiver(void)

パブリック タイプ

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

パブリック属性

OnHeartbeatReceived
OnHeartbeatReceivedHandler

パブリック関数

Init(WeaveExchangeManager *exchangeMgr)
Weave Heartbeat レシーバーを初期化し、Weave Heartbeat メッセージを受信するよう登録する。
Shutdown(void)
Weave Heartbeat レシーバーをシャットダウンし、Weave Heartbeat メッセージの受信登録を解除します。

パブリック タイプ

OnHeartbeatReceivedHandler

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

パブリック属性

OnHeartbeatReceived

OnHeartbeatReceivedHandler OnHeartbeatReceived

パブリック関数

init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Weave Heartbeat レシーバーを初期化し、Weave Heartbeat メッセージを受信するよう登録する。

詳細
パラメータ
[in] exchangeMgr
システムの Weave Exchange マネージャーへのポインタ。
戻り値
WEAVE_ERROR_INCORRECT_STATE
Exchange Manager が null でない場合
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
すでに登録されているメッセージ ハンドラが多すぎる場合。
WEAVE_NO_ERROR
成功時。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

Weave Heartbeat レシーバーをシャットダウンし、Weave Heartbeat メッセージの受信登録を解除します。

詳細
戻り値
WEAVE_NO_ERROR
成功時。

WeaveHeartbeatReceiver

 WeaveHeartbeatReceiver(
  void
)