nl::Weave::Profiles::Echo_Next::WeaveEchoClient

Provides the ability to send Weave EchoRequest messages to a peer node and receive
the corresponding EchoResponse messages.

摘要

WeaveEchoClient 类用于实现 Weave Echo 协议的发起方。与 ICMP ping 协议类似，Weave Echo 协议可用于测试 Weave 节点的活跃性和可达性。

应用可以使用 WeaveEchoClient 类向 Binding 对象标识的对等节点发送一次性或重复的 EchoRequest 消息。相应的类可用于响应回声请求（请参阅 WeaveEchoServer）。

客户端绑定

WeaveEchoClient 会有一个 Weave Binding 对象，用于标识回声请求的预期收件人并与之建立通信。绑定可以在应用初始化 WeaveEchoClient 对象之前由应用进行配置和准备，在这种情况下，WeaveEchoClient 将请求按需绑定绑定（如需了解详情，请参阅 Binding::RequestPrepare()）。

如果绑定在进入就绪状态后失败，则系统也会请求按需绑定。

SendRepeating 模式

SendRepeating() 方法可用于将 WeaveEchoClient 置于 SendRepeating 模式。在此模式下，客户端对象会以配置的时间间隔向对等设备发送重复的 EchoRequest 消息序列。可以通过调用 Stop() 方法取消 SendRepeating 模式。

多播和广播

WeaveEchoClient 对象可通过使用适当的 IPv6 多播地址或 IPv4 本地网络广播地址 (255.255.255.255) 配置 Binding 对象，从而同时向多个收件人发送 EchoRequest。当 WeaveEchoClient 对象检测到多播或广播对等地址时，会在发送 EchoRequest 时自动进入多响应模式。

在此模式下，对象会继续监听并传递到达同一广告交易平台的所有 EchoResponse 消息。该对象会一直处于 MultiResponse 模式，直到：1) 应用调用 Stop() 或 Send()，2) 在 SendRepeating 模式下，该时间到了发送另一个请求，或者 3) 未收到响应并且接收超时到期。

API 事件

在操作过程中，WeaveEchoClient 对象会调用应用以请求执行特定操作或传送重要事件的通知。这些 API 事件调用是在客户端对象上当前配置的回调函数执行的。除非另有说明，否则应用可在事件回调期间随意更改客户端的状态。一种整体例外情况是该对象的 Shutdown() 方法，该方法在回调期间可能永远不会被调用。

定义了以下 API 事件：

准备载荷

WeaveEchoClient 将生成 EchoRequest 消息，并请求应用提供载荷。如果应用需要，可能会返回包含载荷数据的新 PacketBuffer。如果应用不处理此事件，系统会自动发送具有零长度载荷的 EchoRequest。在此回调期间，应用不得更改 WeaveEchoClient 的状态。

已发送的请求

已向对等设备发送 EchoRequest 消息。

收到响应

从对等端收到了 EchoResponse 消息。该事件的参数包含响应载荷以及有关响应消息的元信息。

通信错误

生成或发送 EchoRequest 或等待响应时发生错误。等待响应时可能发生的错误示例如下：关键错误或意外连接关闭。该事件的参数包含错误原因。

响应超时

在指定时间内未收到 EchoResponse。响应超时由 Binding 对象上的 DefaultResponseTimeout 属性控制。

请求已中止

正在进行的 Echo 交换被取消了，因为在收到对上一条消息的响应前又发送了另一个 EchoRequest 请求。当到达到达时间以发送下一个 EchoRequest 时，在 SendRepeating 模式下可能会出现此问题。如果应用在发送 EchoRequest 之后但收到任何响应之前调用了 Send()，也会出现这种情况。

当对象处于 MultiResponse 模式时，如果至少收到一条 EchoResponse 消息，则系统将抑制该事件。

公共类型

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

 EventType

 State

void * AppState

Binding * GetBinding(
  void
) const 

EventCallback GetEventCallback(
  void
) const 

State GetState(
  void
) const 

WEAVE_ERROR Init(
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

bool IsSendRrepeating() const 

bool RequestInProgress() const 

WEAVE_ERROR Send(
  void
)

WEAVE_ERROR Send(
  PacketBuffer *payloadBuf
)

WEAVE_ERROR SendRepeating(
  uint32_t sendIntervalMS
)

void SetEventCallback(
  EventCallback eventCallback
)

void Shutdown(
  void
)

void Stop(
  void
)

 WeaveEchoClient(
  void
)

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)