nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender

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

Weave Heartbeat Sender クラス。

概要

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

WeaveHeartbeatSender(void)

パブリック タイプ

EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) typedef
void(*
EventType{
  kEvent_UpdateSubscriptionState = 1,
  kEvent_HeartbeatSent = 2,
  kEvent_HeartbeatFailed = 3,
  kEvent_DefaultCheck = 100
}
enum

パブリック属性

AppState
void *

パブリック関数

GetBinding() const
ハートビート送信元に関連付けられているバインディング オブジェクトを取得します。
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
ハートビート タイミングの構成を取得します。
GetEventCallback() const
EventCallback
WeaveHeartbeatSender に存在するイベントや変更をアプリケーションに通知するために呼び出される関数を返します。
GetRequestAck() const
bool
Weave Reliable Messaging を使用してハートビート メッセージが確実に送信されるかどうかを示すフラグを返します。
GetSubscriptionState() const
uint8_t
現在の定期購入のステータスの値を取得します。
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Weave Heartbeat 送信者を初期化します。
ScheduleHeartbeat(void)
Weave Heartbeat メッセージの送信をスケジュールします。
SendHeartbeatNow(void)
今すぐ Weave の Heartbeat メッセージを送信しましょう。
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
ハートビート タイミングの設定を行います。
SetEventCallback(EventCallback eventCallback)
void
WeaveHeartbeatSender で発生したイベントまたは変更をアプリケーションに通知するために呼び出される関数を設定します。
SetRequestAck(bool val)
void
Weave Reliable Messaging を使用してハートビート メッセージを確実に送信する必要があるかどうかを示すフラグを設定します。
SetSubscriptionState(uint8_t val)
void
現在の定期購入のステータスを設定します。
Shutdown(void)
Weave Heartbeat 送信者をシャットダウンします。
StartHeartbeat(void)
Weave Heartbeat メッセージの送信を開始します。
StopHeartbeat(void)
Weave Heartbeat メッセージの送信を停止します。

静的パブリック関数

DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
WeaveHeartbeatSender API イベントのデフォルト ハンドラ関数。

構造体

nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

WeaveHeartbeatSender API イベントにパラメータを入力します。

nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::OutEventParam

WeaveHeartbeatSender API イベントへの出力パラメータ。

パブリック タイプ

EventCallback

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

EventType

 EventType
プロパティ
kEvent_DefaultCheck

アプリケーションのデフォルトのイベント処理の正確性を検証するために使用されます。

アプリケーションはこのイベントを明示的に処理しないでください。

kEvent_HeartbeatFailed

ピアにハートビート メッセージを送信できませんでした。

kEvent_HeartbeatSent

ハートビート メッセージがピアに正常に送信されました。

信頼性の高い送信が有効な場合、このイベントはメッセージが確認応答されたことを示します。

kEvent_UpdateSubscriptionState

アプリケーションは定期購入のステータスを更新するようリクエストされます。

パブリック属性

AppState

void * AppState

パブリック関数

GetBinding

Binding * GetBinding() const 

ハートビート送信元に関連付けられているバインディング オブジェクトを取得します。

GetConfiguration

void GetConfiguration(
  uint32_t & interval,
  uint32_t & phase,
  uint32_t & window
) const 

ハートビート タイミングの構成を取得します。

詳細
パラメータ
[out] interval
ハートビート間隔を受け取る整数への参照。
[out] phase
ハートビート フェーズを受け取る整数への参照。
[out] window
ハートビート ランダム化ウィンドウを受け取る整数への参照。

GetEventCallback

EventCallback GetEventCallback() const 

WeaveHeartbeatSender に存在するイベントや変更をアプリケーションに通知するために呼び出される関数を返します。

GetRequestAck

bool GetRequestAck() const 

Weave Reliable Messaging を使用してハートビート メッセージが確実に送信されるかどうかを示すフラグを返します。

GetSubscriptionState

uint8_t GetSubscriptionState() const 

現在の定期購入のステータスの値を取得します。

init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

Weave Heartbeat 送信者を初期化します。

詳細
パラメータ
[in] exchangeMgr
システムの Weave Exchange マネージャーへのポインタ。
[in] binding
ピアノードのアドレス指定に使用される Weave バインディング オブジェクトへのポインタ。
[in] eventCallback
センダーで発生したイベントまたは状態変化をアプリケーションに通知するために呼び出される関数へのポインタ。
[in] appState
アプリケーション固有のデータへのポインタ。このポインタは、アプリケーションへのコールバックで返されます。
戻り値
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender オブジェクトがすでに初期化されている場合。
WEAVE_ERROR_INVALID_ARGUMENT
指定された引数のいずれかが null の場合。
WEAVE_NO_ERROR
成功時。

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Weave Heartbeat メッセージの送信をスケジュールします。

詳細
戻り値
WEAVE_SYSTEM_ERROR_NO_MEMORY
Start タイマー() が失敗した場合
WEAVE_NO_ERROR
成功に

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

今すぐ Weave の Heartbeat メッセージを送信しましょう。

詳細
戻り値
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender が初期化されていない場合
WEAVE_NO_ERROR
成功に

SetConfiguration

void SetConfiguration(
  uint32_t interval,
  uint32_t phase,
  uint32_t window
)

ハートビート タイミングの設定を行います。

詳細
パラメータ
[in] interval
Weave Heartbeat メッセージを送信するときに使用する間隔。
[in] phase
Weave Heartbeat メッセージを送信するときに使用するフェーズ。
[in] window
ランダムな間隔の選択に使用するウィンドウ範囲

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

WeaveHeartbeatSender で発生したイベントまたは変更をアプリケーションに通知するために呼び出される関数を設定します。

SetRequestAck

void SetRequestAck(
  bool val
)

Weave Reliable Messaging を使用してハートビート メッセージを確実に送信する必要があるかどうかを示すフラグを設定します。

このフラグは、UDP をトランスポートとして使用する場合にのみ意味を持ちます。

詳細
パラメータ
[in] val
ハートビート メッセージを確実に送信する必要がある場合は true。

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

現在の定期購入のステータスを設定します。

詳細
パラメータ
[in] val
ハートビート メッセージとともに伝送される 8 ビットのサブスクリプション状態値。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

Weave Heartbeat 送信者をシャットダウンします。

詳細
戻り値
WEAVE_NO_ERROR
成功時。

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Weave Heartbeat メッセージの送信を開始します。

詳細
戻り値
INET_ERROR_NO_MEMORY
Start タイマー() が失敗した場合
WEAVE_NO_ERROR
成功に

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Weave Heartbeat メッセージの送信を停止します。

詳細
戻り値
WEAVE_NO_ERROR
無条件に

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

静的パブリック関数

DefaultEventHandler

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)

WeaveHeartbeatSender API イベントのデフォルト ハンドラ関数。

アプリケーションで処理しない API イベントがある場合は、この関数を呼び出す必要があります。