NL::编织::简介::数据管理_当前::更新客户端

概括

构造函数和析构函数

UpdateClient (void)

公共类型

EventCallback )(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)类型定义
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来绑定存储指向结合和委托。
SendUpdate (bool aIsPartialUpdate, PacketBuffer *aPBuf, bool aIsFirstPayload)
从绑定中获取EC,开始发送消息
Shutdown (void)
发布更新绑定。

结构

NL ::编织::概况:: DataManagement_Current :: UpdateClient :: InEventParam
NL ::编织::概况:: DataManagement_Current :: UpdateClient :: OutEventParam

公共类型

事件回调

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

事件类型

 EventType

更新客户端状态

 UpdateClientState
特性
kState_AwaitingResponse

更新客户端已发送更新请求,等待响应。

kState_Initialized

更新客户端已初始化并准备就绪。

kState_Uninitialized

更新客户端尚未初始化。

公共属性

应用程序状态

void * mpAppState

绑定

Binding * mpBinding

公共静态函数

默认事件处理程序

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

公共职能

取消更新

void CancelUpdate(
  void
)

将更新客户端重置为初始化状态。

清除缓冲区

细节
返回值
WEAVE_NO_ERROR
在成功。

关闭更新

void CloseUpdate(
  bool aAbort
)

在里面

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

的AddRef来绑定存储指向结合和委托。

细节
返回值
WEAVE_NO_ERROR
在成功。

发送更新

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

从绑定中获取EC,开始发送消息

细节
返回值
WEAVE_NO_ERROR
在成功。
other
无法发送更新

关掉

WEAVE_ERROR Shutdown(
  void
)

发布更新绑定。

应该只调用一次。

细节
返回值
WEAVE_NO_ERROR
在成功。

更新客户端

 UpdateClient(
  void
)