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 物件識別的對等節點。存在用來回應 echo 要求的對應類別 (請參閱「WeaveEchoServer」)。

用戶端繫結

WeaveEchoClient 使用 Weave Binding 物件，以識別及建立與 echo 要求之收件者之間的通訊。應用程式可以在初始化 WeaveEchoClient 物件前設定 Binding 及準備該物件，也可以將其保持為不準備。在這種情況下，WeaveEchoClient 將要求隨選準備繫結 (詳情請參閱 Binding::RequestPrepare())。

以及要求在進入「就緒」狀態後失敗的繫結要求。

傳送重複模式

您可以使用 SendRepeating() 方法將 WeaveEchoClient 設為 SendRepeating 模式。在此模式下，用戶端物件會以設定的時間間隔，將一連串的 EchoRequest 訊息傳送給對等點。呼叫 Stop() 方法可以取消 SendRepeating 模式。

多點傳播和廣播

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

在此模式下，物件會繼續監聽並傳送在同一次交換庫收到的所有傳入 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

系統已取消進行中的 Echo 交換作業，因為對方要求在收到回覆前一則訊息前，已要求傳送另一個 EchoRequest。當抵達時傳送下一個 EchoRequest 時，這可能會發生在 SendRepeating 模式時發生。如果應用程式在傳送 EchoRequest 之後、尚未收到任何回應之前呼叫 Send()，也可能會發生這種情況。

物件處於 MultiResponse 模式時，如果收到至少一則 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
)