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

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

โหมด SendReturning

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

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

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

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

เหตุการณ์ API

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

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

PreparePayload

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

RequestSent

ระบบส่งข้อความ EchoRequest ไปยังแอปเทียบเท่าแล้ว

ResponseReceived

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

CommunicationError

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

ResponseTimeout

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

RequestAborted

การแลกเปลี่ยน Echo ที่กำลังดำเนินการถูกล้มเลิกเนื่องจากมีการส่งคำขอให้ส่ง EchoRequest อีกครั้งก่อนจะได้รับการตอบกลับสำหรับข้อความก่อนหน้า ซึ่งสามารถเกิดขึ้นได้ในโหมด SendReturning เมื่อถึงเวลาส่ง 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
)