nl::Weave::Profiles::Echo_Next::WeaveEchoServer

Accepts EchoRequest messages from a peer node and responds with an EchoResponse message.

Tóm tắt

Lớp WeaveEchoServer triển khai phía trình phản hồi của giao thức Weave Echo. Tương tự như giao thức ping ICMP, giao thức Weave Echo có thể được dùng để kiểm tra khả năng kết nối và khả năng tiếp cận của nút Weave.

Các ứng dụng có thể sử dụng lớp WeaveEchoServer để bật tính năng phản hồi tự động cho các thông báo EchoRequest gửi đến. Có một lớp tương ứng để khởi tạo các yêu cầu tiếng vọng (xem WeaveEchoClient).

Theo mặc định, WeaveEchoServer phản hồi ngay lập tức một EchoRequest bằng phản hồi chứa cùng trọng tải với yêu cầu. Tuy nhiên, ứng dụng có thể thay đổi hành vi này trong quá trình xử lý sự kiện API EchoRequestReceived.

Sự kiện API

Trong quá trình hoạt động, đối tượng WeaveEchoServer sẽ gọi đến ứng dụng để yêu cầu các thao tác cụ thể hoặc gửi thông báo về các sự kiện quan trọng. Các lệnh gọi sự kiện API này được thực hiện đến hàm callback hiện được định cấu hình trên đối tượng máy chủ. Ngoại trừ trường hợp được lưu ý, các ứng dụng có thể tự do thay đổi trạng thái máy chủ trong quá trình gọi lại sự kiện. Một trường hợp ngoại lệ chung là phương thức Shutdown() của đối tượng. Phương thức này có thể không bao giờ được gọi trong lệnh gọi lại.

Các sự kiện API sau đây được xác định:

EchoRequestReceived

Đã nhận được một thông báo EchoRequest từ một ứng dụng ngang hàng. Đối số cho sự kiện có chứa tải trọng yêu cầu, ngữ cảnh trao đổi mà thông báo đã được nhận và thông tin siêu dữ liệu về thông báo yêu cầu.

Nếu chọn, ứng dụng có thể thay đổi các đối số đầu ra cho sự kiện để buộc trì hoãn phản hồi hoặc ngăn hoàn toàn phản hồi. Ngoài ra, thao tác này có thể thay đổi nội dung của vùng đệm tải trọng, nơi sẽ trở thành tải trọng cho thông báo phản hồi.

EchoResponseSent

Một tin nhắn EchoResponse đã được gửi hoặc không gửi được. Các đối số cho sự kiện chứa lỗi do gửi thông báo (nếu có) và ngữ cảnh trao đổi mà thông báo đã được gửi.

Tính kế thừa

Loại công khai

void(* EchoFunct)(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload)

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

 EventType

void * AppState

EchoFunct OnEchoRequestReceived

EventCallback GetEventCallback(
  void
) const 

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  EventCallback eventCallback,
  void *appState
)

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

void SetEventCallback(
  EventCallback eventCallback
)

WEAVE_ERROR Shutdown(
  void
)

 WeaveEchoServer(
  void
)

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)