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

Đây là 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 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 đối với 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 ghép nối với một tài khoản hay chưa.
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
Kiểm tra xem việc đặt lại cấu hình đã chỉ định có được phép không.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
Cho biết đã có thời gian chờ 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 rằng cấu hình thiết bị không an toàn đã bị tắt chuông báo động.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Cho biết rằng quy trình Gặp gỡ thụ động từ xa đã kết thúc.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Cho biết rằng quy trình Gặp gỡ 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 thử hệ thống được chỉ định.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
Dừng quá trình kiểm thử hệ thống đang diễn ra.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
Xác định xem có nê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 Rendezvous từ xa.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Chuẩn bị cho buổi gặp mặt 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 đối với thông báo yêu cầu DeviceControl đến.

Thông tin chi tiết
Thông số
[in] ec
ExchangeContext thông báo nhận được.
[in] msgProfileId
Mã hồ sơ của thư đã nhận.
[in] msgType
Loại thông báo của thông báo đã 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ị liệt kê mô tả kết quả đánh giá chính sách kiểm soát quyền truy cập cho thông báo nhận được. Khi vào phương thức, giá trị này đại diện cho kết quả dự kiến tại điểm hiện tại trong quá trình đánh giá. Khi gửi lại, kết quả dự kiến sẽ thể hiện đá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 ghép nối với một tài khoản hay chưa.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

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

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

OnConnectionMonitorTimeout

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

Cho biết đã có thời gian chờ 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 hệ thống không phát hiện thấy hoạt động kiểm tra tính trực tiếp từ máy chủ từ xa trong một khoảng thời gian nhất định.

Thông tin chi tiết
Thông số
[in] peerNodeId
Mã nút của ứng dụng ngang hàng từ xa mà tính năng kết nối đã hết thời gian chờ.
[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 để phản hồi yêu cầu từ ứng dụng. Tính năng an toàn không an toàn 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 riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi nên không thể bật chế độ không an toàn.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

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

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

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 nên không thể tắt thiết bị an toàn.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Cho biết rằng quy trình Gặp gỡ thụ động từ xa đã kết thúc.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Cho biết rằng quy trình Gặp gỡ 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ị.

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

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

OnSystemTestStarted

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

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

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

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

Dừng quá trình kiểm thử 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 riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi ngăn cản quá trình kiểm thử hệ thống.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

Xác định xem có nê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 thực thể đại diệ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ẽ đóng kết nối trước khi quá trình đặ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
Thông số
[in] resetFlags
Cờ chỉ định cấu hình 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 Rendezvous từ xa.

Xem thêm:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

Chuẩn bị cho buổi gặp mặt thụ động từ xa.

Ví dụ: làm cho mạng 15.4/Thread có thể kết nối.

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 riêng cho biết đã xảy ra lỗi trong quá trình chuẩn bị bắt đầu Remote Passive Rendezvous.