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 สามารถใช้ทดสอบความพร้อมใช้งานและความสามารถในการเข้าถึงของโหนด Weave ได้เช่นเดียวกับโปรโตคอล Ping ของ ICMP

แอปพลิเคชันสามารถใช้คลาส WeaveEchoClient เพื่อส่งข้อความ EchoRequest แบบครั้งเดียวหรือซ้ำไปยังโหนดเพียร์ที่ระบุโดยออบเจ็กต์ Binding มีคลาสที่เกี่ยวข้องสำหรับตอบกลับคำขอเสียงสะท้อน (โปรดดู WeaveEchoServer)

การเชื่อมโยงไคลเอ็นต์

WeaveEchoClient จะใช้ออบเจ็กต์ Binding ของ Weave ซึ่งใช้เพื่อระบุและสื่อสารกับผู้รับที่ต้องการสำหรับคำขอเสียงสะท้อน แอปพลิเคชันสามารถกำหนดค่าและเตรียม Binding ก่อนที่จะเริ่มต้นออบเจ็กต์ WeaveEchoClient หรือปล่อยออบเจ็กต์ไว้โดยไม่เตรียมการก็ได้ ซึ่งในกรณีนี้ WeaveEchoClient จะขอให้เตรียมการเชื่อมโยงตามคำขอ (โปรดดูรายละเอียดใน Binding::RequestPrepare())

นอกจากนี้ เราจะขอให้คุณเตรียม การเชื่อมโยงแบบออนดีมานด์ หากดำเนินการไม่สำเร็จหลังจากเข้าสู่สถานะ "พร้อม"

โหมดส่งซ้ำ

สามารถใช้เมธอด SendRepeating() เพื่อทำให้ WeaveEchoClient อยู่ในโหมด SendRepeating ในโหมดนี้ ออบเจ็กต์ของไคลเอ็นต์จะส่งลำดับข้อความ EchoRequest ที่ซ้ำกันไปยังเพียร์ตามช่วงเวลาที่กำหนดค่าไว้ คุณยกเลิกโหมด SendRepeating ได้โดยเรียกใช้เมธอด Stop()

มัลติแคสต์และออกอากาศ

คุณสามารถใช้ออบเจ็กต์ WeaveEchoClient เพื่อส่งคำขอ EchoRequests ไปยังผู้รับหลายรายพร้อมกันโดยกำหนดค่าออบเจ็กต์ การเชื่อมโยง ด้วยที่อยู่ IPv6 แบบมัลติแคสต์ หรือที่อยู่การออกอากาศเครือข่ายภายในของ IPv4 (255.255.255.255) เมื่อออบเจ็กต์ WeaveEchoClient ตรวจพบที่อยู่เพียร์แคสต์หรือการกระจายข้อมูล จะเข้าสู่โหมด MultiResponse โดยอัตโนมัติเมื่อส่ง EchoRequest

ในโหมดนี้ ออบเจ็กต์จะยังคงตรวจจับและส่งข้อความ EchoResponse ขาเข้าทั้งหมดที่มาถึงในการแลกเปลี่ยนเดียวกัน ออบเจ็กต์จะยังคงอยู่ในโหมด MultiResponse จนกว่า 1) แอปพลิเคชันจะเรียกใช้ Stop() หรือ Send(), 2) ในโหมด SendRepeating เวลาที่จะส่งคำขออีก หรือ 3) ไม่ได้รับการตอบสนองและหมดเวลารับ

เหตุการณ์ API

ในระหว่างการดำเนินการ ออบเจ็กต์ WeaveEchoClient จะเรียกใช้แอปพลิเคชันเพื่อขอการดำเนินการเฉพาะหรือส่งการแจ้งเตือนเหตุการณ์สำคัญ การเรียกเหตุการณ์ API เหล่านี้จะเรียกใช้ฟังก์ชันเรียกกลับที่กำหนดค่าไว้ในปัจจุบันบนออบเจ็กต์ของไคลเอ็นต์ แอปพลิเคชันสามารถเปลี่ยนสถานะของไคลเอ็นต์ในระหว่างการเรียกกลับของเหตุการณ์ได้ ยกเว้นที่ระบุไว้ ข้อยกเว้นโดยรวมประการหนึ่งคือเมธอด Shutdown() ของออบเจ็กต์ ซึ่งอาจไม่มีการเรียกใช้ในระหว่างการเรียกกลับ

กําหนดเหตุการณ์ API ต่อไปนี้

PreparePayload

WeaveEchoClient กำลังจะสร้างข้อความ EchoRequest และร้องขอให้แอปพลิเคชันส่งเพย์โหลด หากแอปพลิเคชันต้องการ แอปพลิเคชันอาจแสดงผล PacketBuffer ใหม่ที่มีข้อมูลเพย์โหลด หากแอปพลิเคชันไม่จัดการเหตุการณ์นี้ ระบบจะส่ง EchoRequest ที่มีเพย์โหลดความยาวเป็น 0 โดยอัตโนมัติ แอปพลิเคชันต้องไม่เปลี่ยนแปลงสถานะของ WeaveEchoClient ในระหว่างการเรียกกลับนี้

RequestSent

มีการส่งข้อความ EchoRequest ไปยังเพียร์

ResponseReceived

ได้รับข้อความ EchoResponse จากเพื่อน อาร์กิวเมนต์ไปยังเหตุการณ์จะมีเปย์โหลดการตอบกลับและข้อมูลเมตาเกี่ยวกับข้อความตอบกลับ

CommunicationError

เกิดข้อผิดพลาดขณะสร้างหรือส่ง EchoRequest หรือขณะรอการตอบกลับ ตัวอย่างข้อผิดพลาดที่อาจเกิดขึ้นขณะรอการตอบกลับ ได้แก่ ข้อผิดพลาดที่สำคัญหรือการปิดการเชื่อมต่อที่ไม่คาดคิด อาร์กิวเมนต์ของเหตุการณ์มีเหตุผลของข้อผิดพลาด

ResponseTimeout

ไม่ได้รับ EchoResponse ในเวลาที่กำหนด การหมดเวลาการตอบกลับจะควบคุมโดยพร็อพเพอร์ตี้ defaultResponseTimeout ในออบเจ็กต์ การเชื่อมโยง

RequestAborted

ระบบล้มเลิกการแลกเปลี่ยน Echo ที่กำลังดำเนินการอยู่เนื่องจากมีการส่งคำขอให้ส่งคำขอ EchoRequest อีกครั้งก่อนที่จะได้รับการตอบกลับข้อความก่อนหน้า กรณีนี้อาจเกิดขึ้นในโหมด SendRepeating เมื่อถึงเวลาส่ง EchoRequest ครั้งถัดไป กรณีนี้อาจเกิดขึ้นได้หากแอปพลิเคชันเรียก Send() หลังจากส่ง EchoRequest ไปแล้ว แต่ก่อนที่จะได้รับการตอบกลับ

เมื่อออบเจ็กต์อยู่ในโหมด MultiResponse เหตุการณ์จะถูกระงับหากได้รับข้อความ EchoResponse อย่างน้อย 1 รายการ

ประเภทสาธารณะ

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
)