nl::Weave::Profiles::Echo_Next::WeaveEchoServer

Accepts EchoRequest messages from a peer node and responds with an EchoResponse message.

摘要

WeaveEchoServer 类可实现 Weave Echo 协议的响应方端。Weave Echo 协议与 ICMP ping 协议类似，可用于测试 Weave 节点的活跃性和可达性。

应用可以使用 WeaveEchoServer 类启用对传入的 EchoRequest 消息的自动响应。存在用于发起 echo 请求的类（请参阅 WeaveEchoClient）。

默认情况下，WeaveEchoServer 会立即对 EchoRequest 进行响应，其响应中包含的载荷与该请求相同。但是，在处理 EchoRequestReceived API 事件期间，应用程序可以更改此行为。

API 事件

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

定义了以下 API 事件：

EchoRequestReceived

从对等方收到了 EchoRequest 消息。该事件的参数包含请求有效负载、接收消息的交换上下文以及有关请求消息的元信息。

如果应用程序选择，它可以更改事件的输出参数，以强制延迟响应或完全禁止响应。此外，该方法可能会更改负载缓冲区的内容，这些内容将成为响应消息的负载。

EchoResponseSent

EchoResponse 消息已发送或发送失败。该事件的参数包含因发送消息而导致的错误（如果有），以及发送消息时所用的交换上下文。

继承

公共类型

void(* EchoFunct)(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload)

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

 EventType

void * AppState

EchoFunct OnEchoRequestReceived

EventCallback GetEventCallback(
  void
) const 

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  EventCallback eventCallback,
  void *appState
)

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

void SetEventCallback(
  EventCallback eventCallback
)

WEAVE_ERROR Shutdown(
  void
)

 WeaveEchoServer(
  void
)

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