nl :: Dệt :: Hồ sơ :: Echo_Next :: WeaveEchoServer

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

Tóm lược

Các WeaveEchoServer cụ lớp phía responder của giao thức Weave Echo. Tương tự như giao thức ping ICMP, giao thức Weave Echo có thể được sử dụng để kiểm tra tính khả dụng và khả năng tiếp cận của nút Weave.

Ứng dụng có thể sử dụng WeaveEchoServer lớp để cho phép phản ứng tự động để thông điệp EchoRequest đến. Một lớp học tương ứng tồn tại để bắt đầu echo requests (xem WeaveEchoClient ).

Theo mặc định, WeaveEchoServer đáp ứng ngay lập tức với một EchoRequest với phản ứng có chứa các tải trọng tương tự như 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 EchoRequestReceive.

Sự kiện API

Trong quá trình hoạt động, WeaveEchoServer đối tượng sẽ gọi đến các ứng dụng để hành động cụ thể yêu cầu hoặc cung cấp thông báo về sự kiện quan trọng. Các lệnh gọi sự kiện API này được thực hiện cho hàm gọi lại hiện được định cấu hình trên đối tượng máy chủ. Trừ khi đượ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 gọi lại sự kiện. Một ngoại lệ là tổng thể của đối tượng Shutdown () phương pháp, trong đó có thể không bao giờ được gọi trong một callback.

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

EchoRequestRenition

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

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

EchoResponseSent

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 tin nhắn (nếu có) và bối cảnh trao đổi mà tin nhắn được gửi qua đó.

Di sản

Các 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
)