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)
Binding 的 AddRef 会存储指向绑定和委托的指针。
SendUpdate(bool aIsPartialUpdate, PacketBuffer *aPBuf, bool aIsFirstPayload)
通过绑定获取增强型转化，开始发送消息
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
)

Binding 的 AddRef 会存储指向绑定和委托的指针。

具体说明
返回值
WEAVE_NO_ERROR
成功时。

SendUpdate

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

通过绑定获取增强型转化，开始发送消息

具体说明
返回值
WEAVE_NO_ERROR
成功时。
other
无法发送更新

关停

WEAVE_ERROR Shutdown(
  void
)

更新的释放绑定。

只应调用一次。

具体说明
返回值
WEAVE_NO_ERROR
成功时。

UpdateClient

 UpdateClient(
  void
)