nl::Weave::DeviceLayer::Internal::DeviceControlServer

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/internal/DeviceControlServer.h>

Triển khai hồ sơ Weave Device Control cho thiết bị Weave.

Tóm tắt

Tính kế thừa

Kế thừa từ:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Hàm công khai
Init()
IsPairedToAccount() const override
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) override
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) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
Cho biết cấu hình thiết bị không an toàn đã được bật.
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
Cho biết cấu hình thiết bị không an toàn đã bị tắt.
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
Cho biết rằng quá trình Điểm hẹn thụ động từ xa đã kết thúc.
OnRemotePassiveRendezvousStarted(void) override
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) override
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) override
virtual WEAVE_ERROR
Bắt đầu kiểm tra hệ thống được chỉ định.
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
Dừng quá trình kiểm tra hệ thống đang diễn ra.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
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) override
virtual void
Chuẩn bị dừng Điều phối thụ động từ xa.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
Chuẩn bị cho Điểm hẹn thụ động từ xa.

Hàm được bảo vệ
DeviceControlServer()=default
DeviceControlServer(const DeviceControlServer &)=delete
DeviceControlServer(const DeviceControlServer &&)=delete
operator=(const DeviceControlServer &)=delete
~DeviceControlServer()=default

Hàm công khai

Init

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

Đượ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
) override

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

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

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
) override

Cho biết rằng 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 dành riêng cho nền tảng cho biết đã xảy ra lỗi khiến không thể tắt chuông báo động.

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

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
) override

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
) override

Đặ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
) override

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
) override

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
) override

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
) override

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

Xem thêm:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

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ị bắt đầu Cuộc hẹn bị động từ xa.

Hàm được bảo vệ

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default