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

摘要

建構函式和解構函式
UpdateClient(void)

公開類型
EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventType 列舉
UpdateClientState{
  kState_Uninitialized = 0,
  kState_Initialized,
  kState_AwaitingResponse
} 		列舉

公開屬性
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 新增至 Binding 儲存區指標，以繫結和委派。
SendUpdate(bool aIsPartialUpdate, PacketBuffer *aPBuf, bool aIsFirstPayload)
從繫結取得強化轉換，開始傳送訊息
Shutdown(void)
發布更新的繫結。

Structs
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 新增至 Binding，將繫結和委派的指標儲存起來。

詳細資料
傳回值
WEAVE_NO_ERROR
成功時。

SendUpdate

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

從繫結取得 EC，啟動傳送訊息

詳細資料
傳回值
WEAVE_NO_ERROR
成功時。
other
無法傳送更新

關閉

WEAVE_ERROR Shutdown(
  void
)

釋出更新的繫結。

應只呼叫一次。

詳細資料
傳回值
WEAVE_NO_ERROR
成功時。

UpdateClient

 UpdateClient(
  void
)