nl::Weave::Profiles::DataManagement_Current::UpdateClient

概要

コンストラクタとデストラクタ
UpdateClient(void)

公開タイプ
EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventType enum
UpdateClientState{
  kState_Uninitialized = 0,
  kState_Initialized,
  kState_AwaitingResponse
} 		enum

パブリック属性
mpAppState
void *
mpBinding

静的パブリック関数
DefaultEventHandler(void *apAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

パブリック関数
CancelUpdate(void)
void
更新クライアントを初期化状態にリセットします。
CloseUpdate(bool aAbort)
void
Init(Binding *const apBinding, void *const apAppState, EventCallback const aEventCallback)
バインディングへの AddRef は、バインディングとデリゲートへのポインタを格納します。
SendUpdate(bool aIsPartialUpdate, PacketBuffer *aPBuf, bool aIsFirstPayload)
バインディングから EC を取得し、送信メッセージを開始する
Shutdown(void)
アップデートのリリース バインディング。

構造体
nl::Weave::Profiles::DataManagement_Current::UpdateClient::InEventParam
nl::Weave::Profiles::DataManagement_Current::UpdateClient::OutEventParam

公開タイプ

EventCallback

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

EventType

 EventType

UpdateClientState

 UpdateClientState
プロパティ
kState_AwaitingResponse

更新クライアントが更新リクエストを送信し、レスポンスの保留中です。
kState_Initialized

アップデート クライアントが初期化され、準備が整いました。
kState_Uninitialized

更新クライアントが初期化されていません。

パブリック属性

mpAppState

void * mpAppState

mpBinding

Binding * mpBinding

静的パブリック関数

DefaultEventHandler

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

パブリック関数

CancelUpdate

void CancelUpdate(
  void
)

更新クライアントを初期化状態にリセットします。

バッファをクリアする

詳細
戻り値
WEAVE_NO_ERROR
成功した場合。

CloseUpdate

void CloseUpdate(
  bool aAbort
)

init

WEAVE_ERROR Init(
  Binding *const apBinding,
  void *const apAppState,
  EventCallback const aEventCallback
)

バインディングへの AddRef は、バインディングとデリゲートへのポインタを格納します。

詳細
戻り値
WEAVE_NO_ERROR
成功した場合。

SendUpdate

WEAVE_ERROR SendUpdate(
  bool aIsPartialUpdate,
  PacketBuffer *aPBuf,
  bool aIsFirstPayload
)

バインディングから EC を取得し、送信メッセージを開始する

詳細
戻り値
WEAVE_NO_ERROR
成功した場合。
other
アップデートを送信できません

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

更新のバインディングを解除します。

1 回だけ呼び出す必要があります。

詳細
戻り値
WEAVE_NO_ERROR
成功時。

UpdateClient

 UpdateClient(
  void
)