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

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

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

Tóm tắt

Hàm khởi tạo và phá huỷ
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.

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

Hàm công khai
CancelExchange(void)
Huỷ quá trình trao đổi VerifyRequest đang diễn ra để 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ư VerifyRequest đến một địa chỉ IP cụ thể.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Gửi thông báo Nhận dạng yêu cầu truyền tin để 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.

Chi tiết
Tham số
[in] appState
Con trỏ trỏ đến tập hợp trạng thái do ứng dụng xác định 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 CredentialResponse được gửi đến.

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

[CHỈ ĐỌC] Đối tượng người quản lý Exchange

FabricState

const WeaveFabricState * FabricState

[CHỈ ĐỌC] Đối tượng trạng thái Vải

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Hàm công khai

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Huỷ quá trình trao đổi VerifyRequest đang diễn ra để chờ phản hồi.

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Khởi động trạng thái ứng dụng Mô tả thiết bị.

param[in] ExchangeMgr A con trỏ đến Trình quản lý trao đổi Weave.

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ư VerifyRequest đến một địa chỉ IP cụ thể.

Chi tiết
Tham số
[in] nodeAddr
Thông tin tham chiếu đến địa chỉ IP của nút Weave để truy vấn.
[in] msg
Thông tin tham chiếu đến thông báo VerifyRequest cần gửi.
Giá trị trả về
WEAVE_ERROR_NO_MEMORY
Nếu việc 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 khác của Weave hoặc dành riêng cho nền tảng cho biết đã xảy ra lỗi ngăn không cho gửi Nhận dạng yêu cầu.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Gửi thông báo Nhận dạng yêu cầu truyền tin để khám phá các nút Weave.

Chi tiết
Tham số
[in] msg
Thông tin tham chiếu đến thông báo VerifyRequest cần 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.

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