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 tính hoạt động và khả năng kết nối của nút Weave.

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

Theo mặc định, WeaveEchoServer sẽ phản hồi ngay lập tức một EchoRequest với phản hồi có chứa cùng tải trọng 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ừ những trường hợp có lưu ý, các ứng dụng có thể tự do thay đổi trạng thái của máy chủ trong khi lệnh gọi lại sự kiện. Một 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 tin nhắn EchoRequest từ một ứng dụng ngang hàng. Các đối số cho sự kiện này chứa tải trọng yêu cầu, ngữ cảnh trao đổi mà thông báo nhận được qua đó 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ễ khi phản hồi hoặc loại bỏ hoàn toàn phản hồi. Ngoài ra, việc này có thể thay đổi nội dung của vùng đệm tải trọng, vốn sẽ trở thành tải trọng cho thông báo phản hồi.

EchoResponseSent

Đã gửi hoặc không gửi được thông báo EchoResponse. Các đối số cho sự kiện này chứa lỗi phát sinh từ việc gửi tin nhắn (nếu có) và ngữ cảnh trao đổi mà tin nhắn được gửi đ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
)