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() をご覧ください）。

「準備完了」状態になった後でバインディングが失敗した場合は、バインディングのオンデマンド準備もリクエストされます。

繰り返しモードを送信する

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

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

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

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

API イベント

WeaveEchoClient オブジェクトは、その操作中にアプリケーションに呼び出して、特定の操作をリクエストしたり、重要なイベントの通知を送信したりします。これらの API イベント呼び出しは、クライアント オブジェクトに現在構成されているコールバック関数に対して行われます。特に記載のない限り、アプリケーションはイベント コールバック中にクライアントの状態を自由に変更できます。全体的な例外として、オブジェクトの 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() を呼び出した場合にも、この問題が発生します。

オブジェクトが MultiResponse モードのとき、少なくとも 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
)