nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Đây là một lớp trừu tượng.

#include <src/lib/profiles/device-control/DeviceControl.h>

Lớp uỷ quyền triển khai các thao tác Điều khiển thiết bị đến trên thiết bị máy chủ.

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::WeaveServerDelegateBase
Lớp học con đã biết trực tiếp: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Hàm công khai

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Thực thi kiểm soát quyền truy cập ở cấp thông báo cho thông báo yêu cầu DeviceControl đến.
IsPairedToAccount() const
virtual bool
Được gọi để xác định xem thiết bị hiện có được ghép nối với một tài khoản nào đó hay không.
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
Kiểm tra xem bạn có được phép đặt lại cấu hình đã chỉ định không.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
Cho biết đã hết thời gian chờ trình giám sát kết nối.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Cho biết cấu hình thiết bị không an toàn đã được bật.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
Cho biết cấu hình thiết bị không an toàn đã bị tắt.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Cho biết rằng quá trình Điểm hẹn thụ động từ xa đã kết thúc.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Cho biết rằng quá trình Điểm hẹn thụ động từ xa đã bắt đầu.
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
Đặt lại toàn bộ hoặc một phần cấu hình thiết bị.
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
Bắt đầu kiểm tra hệ thống được chỉ định.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
Dừng quá trình kiểm tra hệ thống đang diễn ra.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
Xác định xem có cần đóng kết nối máy chủ (nếu có) trước khi đặt lại cấu hình hay không.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Chuẩn bị dừng Điều phối thụ động từ xa.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Chuẩn bị cho Điểm hẹn thụ động từ xa.

Hàm công khai

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

Thực thi kiểm soát quyền truy cập ở cấp thông báo cho thông báo yêu cầu DeviceControl đến.

Thông tin chi tiết
Tham số
[in] ec
ExchangeContext mà thông qua đó đã được nhận.
[in] msgProfileId
Mã hồ sơ của thư đã nhận.
[in] msgType
Loại tin nhắn của tin nhắn đã nhận.
[in] msgInfo
Cấu trúc WeaveMessageInfo chứa thông tin về tin nhắn đã nhận.
[in,out] result
Một giá trị được liệt kê mô tả kết quả đánh giá chính sách kiểm soát quyền truy cập đối với thông báo đã nhận. Khi bắt đầu vào phương thức này, giá trị này biểu thị kết quả dự kiến ở thời điểm hiện tại trong quá trình đánh giá. Khi trả lại thông báo, kết quả dự kiến sẽ là kết quả đánh giá cuối cùng về chính sách kiểm soát quyền truy cập đối với thông báo.

IsPairedToAccount

virtual bool IsPairedToAccount() const 

Được gọi để xác định xem thiết bị hiện có được ghép nối với một tài khoản nào đó hay không.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

Kiểm tra xem bạn có được phép đặt lại cấu hình đã chỉ định không.

Thông tin chi tiết
Tham số
[in] resetFlags
Cờ chỉ định cấu hình nào cần đặt lại.
Giá trị trả về
TRUE
nếu cho phép đặt lại cấu hình.
FALSE
nếu không được phép đặt lại cấu hình.

OnConnectionMonitorTimeout

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

Cho biết đã hết thời gian chờ trình giám sát kết nối.

Hàm này được gọi khi hết thời gian chờ của Trình theo dõi kết nối, tức là khi tính năng kiểm tra sự trực tiếp chưa được phát hiện từ máy chủ từ xa trong một khoảng thời gian nhất định.

Thông tin chi tiết
Tham số
[in] peerNodeId
Mã nút của ứng dụng ngang hàng từ xa đã hết thời gian chờ để kết nối trực tiếp.
[in] peerAddr
Địa chỉ của ứng dụng ngang hàng từ xa.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

Cho biết cấu hình thiết bị không an toàn đã được bật.

Hàm này được gọi khi cấu hình thiết bị máy chủ không an toàn được bật theo yêu cầu của ứng dụng. Tính năng an toàn không thành công sẽ tự động đặt lại cấu hình thiết bị về trạng thái đã biết nếu quá trình định cấu hình không hoàn tất thành công.

Thông tin chi tiết
Giá trị trả về
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 khiến không thể bật chuông báo động.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

Cho biết cấu hình thiết bị không an toàn đã bị tắt.

Hàm này được gọi khi cấu hình thiết bị máy chủ không an toàn bị tắt tính năng theo yêu cầu của ứng dụng. Ứng dụng sẽ tắt báo động không an toàn sau khi định cấu hình xong.

Thông tin chi tiết
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi khác của Weave hoặc nền tảng cụ thể cho biết đã xảy ra lỗi khiến không thể tắt chuông báo động.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Cho biết rằng quá trình Điểm hẹn thụ động từ xa đã kết thúc.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Cho biết rằng quá trình Điểm hẹn thụ động từ xa đã bắt đầu.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

Đặt lại toàn bộ hoặc một phần cấu hình thiết bị.

Theo dự kiến, quá trình triển khai hàm này sẽ đặt lại mọi tổ hợp mạng, cấu hình vải Weave hoặc cấu hình dịch vụ về trạng thái đã biết, theo cờ đặt lại.

Thông tin chi tiết
Tham số
[in] resetFlags
Cờ chỉ định cấu hình nào cần đặt lại.
Giá trị trả về
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 thiết bị đặt lại cấu hình.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

Bắt đầu kiểm tra hệ thống được chỉ định.

Thông tin chi tiết
Tham số
[in] profileId
Mã hồ sơ của hoạt động kiểm thử được yêu cầu.
[in] testId
Mã của thử nghiệm được yêu cầu.
Giá trị trả về
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 bắt đầu kiểm tra hệ thống.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

Dừng quá trình kiểm tra hệ thống đang diễn ra.

Thông tin chi tiết
Giá trị trả về
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 việc dừng kiểm thử hệ thống.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

Xác định xem có cần đóng kết nối máy chủ (nếu có) trước khi đặt lại cấu hình hay không.

Hàm này dùng để truy vấn uỷ quyền cho hành vi mong muốn khi xử lý yêu cầu đặt lại cấu hình. Nếu kết nối máy chủ hiện đang hoạt động, phản hồi TRUE cho phương thức này sẽ khiến kết nối bị đóng trước khi đặt lại cấu hình được kích hoạt thông qua phương thức OnResetConfig.

Thông tin chi tiết
Tham số
[in] resetFlags
Cờ chỉ định cấu hình nào cần đặt lại.
Giá trị trả về
true
nếu cần đóng kết nối.
false
nếu không cần đóng kết nối.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

Chuẩn bị dừng Điều phối thụ động từ xa.

Xem thêm:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

Chuẩn bị cho Điểm hẹn thụ động từ xa.

Ví dụ: làm cho mạng 15.4/Thread có thể kết hợp.

Thông tin chi tiết
Giá trị trả về
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 khi chuẩn bị khởi động Cuộc hẹn bị động từ xa.