nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer

#include <src/lib/profiles/device-description/DeviceDescription.h>

Đối tượng máy chủ để phản hồi các yêu cầu Mô tả thiết bị.

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::WeaveServerBase
Lớp con đã biết trực tiếp: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

Hàm khởi tạo và hàm phá
DeviceDescriptionServer(void)

Loại công khai
HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg) typedef
void(*

Thuộc tính công khai
AppState
void *
Con trỏ trạng thái do ứng dụng xác định để cung cấp ngữ cảnh cho các lệnh gọi lại.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Hàm này chịu trách nhiệm xử lý thông báo IdentityRequest.

Hàm công khai
Init(WeaveExchangeManager *exchangeMgr)
Khởi động trạng thái Máy chủ mô tả thiết bị và đăng ký nhận thông báo Mô tả thiết bị.
Shutdown(void)
Tắt máy chủ mô tả thiết bị.

Loại công khai

HandleIdentifyRequestFunct

void(* HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg)

Thuộc tính công khai

AppState

void * AppState

Con trỏ trạng thái do ứng dụng xác định để cung cấp ngữ cảnh cho các lệnh gọi lại.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Hàm này chịu trách nhiệm xử lý thông báo IdentityRequest.

Thông tin chi tiết
Thông số
[in] appState
Con trỏ đến trạng thái do ứng dụng xác định được đặt khi đăng ký nhận loại thông báo này.
[in] nodeId
Mã nút Weave của nguồn thông báo.
[in] nodeAddr
Địa chỉ IP của nguồn thư.
[in] reqMsg
Tham chiếu đến thông báo VerifyRequest đến.
[out] sendResp
Tham chiếu đến một boolean phải được đặt thành true nếu thông báo phản hồi được gửi đến trình khởi tạo.
[out] respMsg
Tham chiếu đến thông báoIdentifyResponse sẽ được gửi đến trình tạo.

Hàm công khai

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Bắt đầu

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Khởi động trạng thái Máy chủ mô tả thiết bị và đăng ký nhận thông báo Mô tả thiết bị.

param[in] ExchangeMgr Một con trỏ tới Trình quản lý Trao đổi Weave.

Thông tin chi tiết
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Khi một máy chủ điểm hẹn thụ động từ xa đã được đăng ký.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Khi có quá nhiều trình xử lý tin nhắn không mong muốn được đăng ký.
WEAVE_NO_ERROR
Khi thành công.

Tắt

WEAVE_ERROR Shutdown(
  void
)

Tắt máy chủ mô tả thiết bị.

Thông tin chi tiết
Giá trị trả về
WEAVE_NO_ERROR
một cách vô điều kiện.