Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

nl::Weave::プロフィール::Heartbeat::WeaveHeartbeatSender

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

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
}
列挙型

パブリック属性

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 ハートビート メッセージの送信スケジュールを設定します。
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 イベントにパラメータを出力する。

パブリック タイプ

イベント コールバック

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

イベントタイプ

 EventType
Properties
kEvent_DefaultCheck

アプリケーションのデフォルトのイベント処理が正しく行われていることを確認するために使用されます。

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

kEvent_HeartbeatFailed

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

kEvent_HeartbeatSent

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

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

kEvent_UpdateSubscriptionState

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

パブリック属性

アプリの状態

void * AppState

パブリック関数

バインディングの取得

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 Manager へのポインタ。
[in] binding
ピアノードのアドレス指定に使用される Weave バインディング オブジェクトへのポインタ。
[in] eventCallback
送信者で発生したイベントまたは状態の変化をアプリケーションに通知するために呼び出される関数へのポインタ。
[in] appState
アプリケーション固有のデータへのポインタ。このポインタは、アプリケーションへのコールバックで返されます。
戻り値
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender オブジェクトがすでに初期化されているかどうか。
WEAVE_ERROR_INVALID_ARGUMENT
指定された引数のいずれかが null の場合。
WEAVE_NO_ERROR
成功

ハートビート

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Weave ハートビート メッセージの送信スケジュールを設定します。

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

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

今すぐ Weave Heartbeat メッセージを送信してください。

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

設定

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
成功

ハートビート

WEAVE_ERROR StartHeartbeat(
  void
)

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

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

ストップハートビート

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 イベントについては、この関数を呼び出す必要があります。