nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

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

Đối tượng ứng dụng khách để đưa ra yêu cầu Mô tả thiết bị.

Tóm tắt

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

Loại công khai
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Hàm này chịu trách nhiệm xử lý thông báo IdentityResponse.

Thuộc tính công khai
AppState
void *
Đối tượng trạng thái do ứng dụng xác định.
ExchangeMgr
[READ ONLY] Đối tượng người quản lý Exchange
FabricState
[READ ONLY] Đối tượng trạng thái Fabric
OnIdentifyResponseReceived

Hàm công khai
CancelExchange(void)
Huỷ một cuộc trao đổi Nhận dạngRequest đang diễn ra và đang chờ phản hồi.
Init(WeaveExchangeManager *exchangeMgr)
Khởi động trạng thái ứng dụng Mô tả thiết bị.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Gửi thông báo VerifyRequest đến một địa chỉ IP cụ thể.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Gửi thông báo phát đichúngRequest để khám phá các nút Weave.
Shutdown(void)
Tắt ứng dụng Mô tả thiết bị.

Loại công khai

HandleIdentifyResponseFunct

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

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

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 tạo Ngữ cảnh trao đổi IdentityRequest.
[in] nodeId
Mã nút Weave của nguồn thông báo.
[in] nodeAddr
Địa chỉ IP của nút phản hồi.
[in] msg
Tham chiếu đến thông báo Nhận dạngResponse đến.

Thuộc tính công khai

AppState

void * AppState

Đối tượng trạng thái do ứng dụng xác định.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[READ ONLY] Đối tượng người quản lý Exchange

FabricState

const WeaveFabricState * FabricState

[READ ONLY] Đối tượng trạng thái Fabric

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Hàm công khai

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Huỷ một cuộc trao đổi Nhận dạngRequest đang diễn ra và đang chờ phản hồi.

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Bắt đầu

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Khởi động trạng thái ứng dụng 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_NO_ERROR
Khi thành công.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

Gửi thông báo VerifyRequest đến một địa chỉ IP cụ thể.

Thông tin chi tiết
Thông số
[in] nodeAddr
Tham chiếu đến địa chỉ IP của nút Weave để truy vấn.
[in] msg
Tham chiếu đến thông báo Xác nhận sẽ gửi.
Giá trị trả về
WEAVE_ERROR_NO_MEMORY
Nếu phân bổ ngữ cảnh trao đổi của vùng đệm gói không thành công.
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi ngăn chặn việc gửi ConfigureRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Gửi thông báo phát đichúngRequest để khám phá các nút Weave.

Thông tin chi tiết
Thông số
[in] msg
Tham chiếu đến thông báo Xác nhận sẽ gửi.

Tắt

WEAVE_ERROR Shutdown(
  void
)

Tắt ứng dụng Mô tả thiết bị.

Hàm này đóng mọi ngữ cảnh trao đổi đang hoạt động và đặt lại con trỏ. Bạn có thể sử dụng lại đối tượng bằng cách gọi lại phương thức Init.

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