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 類別傳送一次性或重複 EchoRequest 訊息至 Binding 物件指定的對等節點。存在對應類別來回應回應要求 (請參閱 WeaveEchoServer)。

用戶端繫結

WeaveEchoClient 會使用 Weave Binding 物件，用於識別 echo 要求的特定收件者並建立通訊。在 WeaveEchoClient 物件初始化之前，應用程式便可設定及準備 Binding，也可以取消準備，在這種情況下，WeaveEchoClient 會要求預先準備繫結 (詳情請參閱 Binding::RequestPrepare())。

在進入「就緒」狀態後，系統也會要求繫結的隨選準備作業失敗。

傳送重複模式

SendRepeating() 方法可將 WeaveEchoClient 進入 SendRepeating 模式。在這個模式中，用戶端物件會按照設定的時間間隔，將重複的 EchoRequest 訊息序列傳送給對等互連。您可以呼叫 Stop() 方法，取消 SendRepeating 模式。

多點傳播與廣播

您可以使用 WeaveEchoClient 物件，為 Binding 物件設定適當的 IPv6 多點傳播位址或 IPv4 區域網路廣播位址 (255.255.255.255)，藉此將 EchoRequests 物件同時傳送給多位收件者。當 WeaveEchoClient 物件偵測到多點傳送或廣播對等位址時，就會在傳送 EchoRequest 時自動進入多回應模式。

在這個模式下，物件會繼續監聽及傳送同一個交換下所收到的所有 EchoResponse 訊息。除非：1) 應用程式在 SendRepeating 模式下呼叫 Stop() 或 Send()，以及 2) 傳送其他要求的時間，或 3) 未收到回應且接收逾時。

API 事件

在作業期間，WeaveEchoClient 物件會呼叫應用程式以要求特定動作或傳送重要事件通知。這些 API 事件呼叫會呼叫用戶端物件目前設定的回呼函式。除非另有註明，否則應用程式可以在事件回呼期間變更用戶端的狀態。整體例外是物件的 Shutdown() 方法，該方法可能無法在回呼期間呼叫。

下列 API 事件的定義如下：

PreparePayload

WeaveEchoClient 即將形成 EchoRequest 訊息，並要求應用程式提供酬載。應用程式如有需要，可能會傳回包含酬載資料的新 PacketBuffer。如果應用程式未處理這個事件，系統會自動傳送酬載為零長度的 EchoRequest 。在這個回呼期間，應用程式「不得」變更 WeaveEchoClient 的狀態。

RequestSent

EchoRequest 訊息已傳送給對等互連。

ResponseReceived

收到來自對等點的 EchoResponse 訊息。事件的引數包含關於回應訊息的回應酬載和中繼資訊。

CommunicationError

形成或傳送 EchoRequest 時發生錯誤，或是等待回應時發生錯誤。等待回應時可能發生的錯誤，例如關鍵錯誤或非預期的連線關閉。事件引數包含錯誤原因。

ResponseTimeout

未在指定時間內收到 EchoResponse。回應逾時取決於 Binding 物件的 DefaultResponseTimeout 屬性。

RequestAborted

由於系統要求在收到先前訊息的回應前傳送其他 EchoRequest，因此已取消執行中的 Echo 交換作業。在 SendRepeating 模式下，可能會發生這種情形，進而傳送下一個 EchoRequest。如果應用程式在傳送 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
)