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 オブジェクトによって識別されるピアノードに 1 回限りのメッセージまたは繰り返しの EchoRequest メッセージを送信できます。エコー リクエストに応答するクラスが存在します（WeaveEchoServer を参照）。

クライアント バインディング

WeaveEchoClient は Weave Binding オブジェクトを受け取ります。このオブジェクトは、エコー リクエストの対象とする受信者を識別し、それとの通信を確立するために使用されます。Binding は、WeaveEchoClient オブジェクトの初期化前に、アプリケーションで構成と準備を行うか、準備せずにそのままの状態にすることができます。その場合は、WeaveEchoClient がバインディングのオンデマンド準備をリクエストします（詳細については Binding::RequestPrepare() をご覧ください）。

Ready 状態になった後に失敗した場合は、Binding のオンデマンドの準備もリクエストされます。

SendRepeating モード

SendRepeating() メソッドを使用して WeaveEchoClient を SendRepeating モードに設定できます。このモードでは、クライアント オブジェクトは設定された間隔で、EchoRequest メッセージの繰り返しシーケンスをピアに送信します。SendRepeating モードをキャンセルするには、Stop() メソッドを呼び出します。

マルチキャストとブロードキャスト

WeaveEchoClient オブジェクトを使用すると、適切な IPv6 マルチキャスト アドレスまたは IPv4 ローカル ネットワーク ブロードキャスト アドレス（255.255.255.255）を使用して Binding オブジェクトを構成することで、複数の受信者に EchoRequest を同時に送信できます。WeaveEchoClient オブジェクトは、マルチキャストまたはブロードキャスト ピアのアドレスを検出すると、EchoRequest の送信時に自動的にマルチレスポンス モードに入ります。

このモードでは、オブジェクトは引き続き同じエクスチェンジに到着するすべての受信 EchoResponse メッセージをリッスンして配信します。オブジェクトは、1）アプリが Stop() または Send() を呼び出す、2）SendRepeating モードになる、別のリクエストを送信するタイミングになる、3）レスポンスを受信せずに受信タイムアウトが期限切れになるまで、MultiResponse モードのままになります。

API イベント

オペレーションの過程で、WeaveEchoClient オブジェクトはアプリケーションを呼び出し、特定のアクションをリクエストしたり、重要なイベントの通知を配信したりします。これらの API イベント呼び出しは、クライアント オブジェクトで現在構成されているコールバック関数に対して行われます。特に明記されていない限り、アプリケーションはイベント コールバック中にクライアントの状態を自由に変更できます。全体的な例外の 1 つはオブジェクトの Shutdown() メソッドです。このメソッドはコールバック中に呼び出されることはありません。

以下の API イベントが定義されています。

PreparePayload

WeaveEchoClient が EchoRequest メッセージを形成し、アプリケーションにペイロードの提供をリクエストしています。必要に応じて、ペイロード データを含む新しい PacketBuffer を返せます。アプリケーションがこのイベントを処理しない場合、長さがゼロのペイロードを持つ EchoRequest が自動的に送信されます。アプリは、このコールバック中に WeaveEchoClient の状態を変更してはなりません。

RequestSent

EchoRequest メッセージがピアに送信されました。

ResponseReceived

ピアから EchoResponse メッセージを受信しました。イベントの引数には、レスポンス ペイロードと、レスポンス メッセージに関するメタ情報が含まれます。

CommunicationError

EchoRequest の作成中または送信中、または応答の待機中にエラーが発生しました。レスポンスの待機中に発生する可能性のあるエラーには、重要なエラーや接続の予期せぬ終了などがあります。イベントの引数にエラーの理由が含まれます。

ResponseTimeout

割り当てられた時間内に EchoResponse を受信できませんでした。レスポンスのタイムアウトは、Binding オブジェクトの DefaultResponseTimeout プロパティで制御されます。

RequestAborted

前のメッセージに対する応答を受信する前に、別の EchoRequest を送信するリクエストが送信されたため、進行中の Echo 交換が中止されました。これは、次の EchoRequest を送信する時間に達すると、SendRepeating モードで発生します。また、EchoRequest の送信後、レスポンスを受信する前にアプリで Send() が呼び出された場合にも発生することがあります。

オブジェクトがマルチレスポンス モードの場合、少なくとも 1 つの 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
)