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 协议的发起方端。Weave Echo 协议与 ICMP ping 协议类似，可用于测试 Weave 节点的活跃性和可达性。

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

客户端绑定

WeaveEchoClient 接受 Weave Binding 对象，该对象用于标识 echo 请求的目标接收者并与之建立通信。在初始化 WeaveEchoClient 对象之前，应用可以配置和准备 Binding，也可以不准备。在这种情况下，WeaveEchoClient 将请求按需准备绑定（如需了解详情，请参阅 Binding::RequestPrepare()）。

如果 Binding 在进入就绪状态后失败，系统还将请求其按需准备。

发送重复模式

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

多播和广播

WeaveEchoClient 对象可用于将 EchoRequest 同时发送给多个接收者，方法是为 Binding 对象配置适当的 IPv6 多播地址或 IPv4 本地网络广播地址 (255.255.255.255)。当 WeaveEchoClient 对象检测到多播或广播对等地址时，会在发送 EchoRequest 时自动进入多响应模式。

在此模式下，对象会继续监听并传递到达同一交换机的所有传入 EchoResponse 消息。该对象会一直处于多响应模式，直到出现以下情况：1) 应用调用 Stop() 或 Send()；2) 在 Send 重复模式下，需要发送另一个请求；或 3) 未收到响应且接收超时已到期。

API 事件

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

定义了以下 API 事件：

PreparePayload

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

RequestSent

向对等端发送了 EchoRequest 消息。

ResponseReceived

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

CommunicationError

形成或发送 EchoRequest 时，或在等待响应时发生错误。等待响应期间可能发生的错误示例包括关键错误或意外关闭连接。该事件的参数包含错误原因。

ResponseTimeout

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

RequestAborted

正在进行的 Echo 交换被中止，因为在收到上一条消息的响应之前，系统发出了发送另一个 EchoRequest 的请求。当发送下一个 EchoRequest 的时间到来时，可能会在 Send 重复模式下出现。如果应用在发送 EchoRequest 之后、收到任何响应之前调用 Send()，也会出现上述情况。

当对象处于多响应模式时，如果至少收到了一条 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
)