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)
|
typedefvoid(*
|
EventType{
|
enum |
パブリック属性 |
|
---|---|
AppState
|
void *
|
パブリック関数 |
|
---|---|
GetBinding() const
|
Binding *
ハートビートの送信者に関連付けられているバインディング オブジェクトを取得します。
|
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 Sender を初期化します。
|
ScheduleHeartbeat(void)
|
Weave のハートビート メッセージの送信をスケジュールします。
|
SendHeartbeatNow(void)
|
今すぐ Weave のハートビート メッセージを送信しましょう。
|
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 Sender をシャットダウンします。
|
StartHeartbeat(void)
|
Weave のハートビート メッセージの送信を開始します。
|
StopHeartbeat(void)
|
Weave のハートビート メッセージの送信を停止します。
|
静的パブリック関数 |
|
---|---|
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
|
void
WeaveHeartbeatSender API イベントのデフォルト ハンドラ関数。
|
構造体 |
|
---|---|
nl:: |
WeaveHeartbeatSender API イベントにパラメータを入力します。 |
nl:: |
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
パブリック関数
GetConfiguration
void GetConfiguration(
uint32_t & interval,
uint32_t & phase,
uint32_t & window
) const
ハートビートのタイミングの構成を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
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 Sender を初期化します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
ScheduleHeartbeat
WEAVE_ERROR ScheduleHeartbeat(
void
)
Weave のハートビート メッセージの送信をスケジュールします。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow(
void
)
今すぐ Weave のハートビート メッセージを送信しましょう。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|
SetConfiguration
void SetConfiguration(
uint32_t interval,
uint32_t phase,
uint32_t window
)
SetEventCallback
void SetEventCallback(
EventCallback eventCallback
)
WeaveHeartbeatSender で発生したイベントや変更をアプリケーションに通知するために呼び出される関数を設定します。
SetRequestAck
void SetRequestAck(
bool val
)
Weave の Reliable Messaging を使用してハートビート メッセージを確実に送信するかどうかを示すフラグを設定します。
このフラグは、トランスポートとして UDP を使用する場合のみ意味を持ちます。
詳細 | |||
---|---|---|---|
パラメータ |
|
SetSubscriptionState
void SetSubscriptionState(
uint8_t val
)
現在の定期購入のステータスを設定します。
詳細 | |||
---|---|---|---|
パラメータ |
|
StartHeartbeat
WEAVE_ERROR StartHeartbeat(
void
)
StopHeartbeat
WEAVE_ERROR StopHeartbeat(
void
)
WeaveHeartbeatSender
WeaveHeartbeatSender(
void
)
静的パブリック関数
DefaultEventHandler
void DefaultEventHandler(
void *appState,
EventType eventType,
const InEventParam & inParam,
OutEventParam & outParam
)
WeaveHeartbeatSender API イベントのデフォルト ハンドラ関数。
アプリケーションは、処理しない API イベントに対してこの関数を呼び出す必要があります。