nl::Weave::Profiles::DataManagement_Current::CommandSender

摘要

注意：这个类封装了发送命令的协议详情，从而简化了应用所涉及的机制。该应用提供了一个 PacketBuffer，其中包含命令的有效负载和一组可选的参数，这些参数用于更改命令标头的内容和命令的行为。 这个封装命令处理的效用确实有限，这主要是因为安全验证和数据序列化/反序列化所涉及的复杂性/灵活性。

命令验证的详细信息仍处于待定状态

该类还有助于应用推断关联的 TraitDataSink 中的数据是否达到了命令的副作用（基于命令响应中提供的版本）。应用负责管理该对象的存储。

Weave 绑定

此类的对象可以使用 Weave Binding 进行初始化，该绑定将用作发送命令的默认 Binding。用户还可以为每次 SendCommand() 调用提供 Binding，从而覆盖默认的 Binding。您无需提供默认的 Binding，但提供给 CommandSender 的任何绑定都必须已初始化。

EventCallback

如果用户希望获取有关在发送该命令后发生的事件的更新，则必须定义一个此类函数（请参阅下面的“API 事件”）。如果用户不关心发送命令后发生了什么，该值可以为 NULL。

API 事件

发送 Command 后可能会出现以下事件：

CommunicationError

构建或发送 Command 时，或等待响应时出错。等待响应期间可能发生的错误示例包括关键错误或意外关闭连接。错误原因将包含在 EventCallback 处理程序的 InEventParam 参数中。

InProgressReceived

接收者可以发送“处理中”消息消息，表示 Command 已接收，但尚未完成。完成后，收件人将发送响应或状态报告。发送“进行中”消息不是必需的。

StatusReportReceived

收到 StatusReport 表示处理 Command 时出现错误。您可以通过 InEventParam 访问 StatusReport。

ResponseReceived

收到响应意味着“命令”收件人成功处理了“命令”。响应可能包含载荷，也可能不包含载荷。如果应用需要保留数据包缓冲区，则可能会调用 ExchangeContext::AddRef() 来增加引用计数。

公共类型

void(* EventCallback)(void *const aAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutEventParam)

 EventType

void * mAppState = NULL

SynchronizedTraitState * mSyncronizedTraitState = NULL

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

void Close(
  bool aAbortNow
)

WEAVE_ERROR Init(
  nl::Weave::Binding *aBinding,
  const EventCallback aEventCallback,
  void *const aAppState
)

WEAVE_ERROR SendCommand(
  nl::Weave::PacketBuffer *aPayload,
  nl::Weave::Binding *aBinding,
  ResourceIdentifier & aResourceId,
  uint32_t aProfileId,
  uint32_t aCommandType
)

WEAVE_ERROR SendCommand(
  nl::Weave::PacketBuffer *aPayload,
  nl::Weave::Binding *aBinding,
  SendParams & aSendParams
)

void SetSynchronizedTraitState(
  SynchronizedTraitState *aTraitState
)