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

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

概要

WeaveEchoServer クラスは、Weave EchoServer のレスポンダー側を実装します。ICMP ping プロトコルと同様に、Weave Echo プロトコルを使用して、Weave ノードのライブネスとネットワーク到達性をテストできます。

アプリケーションで WeaveEchoServer クラスを使用すると、EchoRequest メッセージの受信に対する自動応答を有効にできます。エコー リクエストを開始するための対応するクラスが存在します（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
)