nl :: Dệt :: DeviceLayer :: Nội bộ :: DeviceControlServer

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

Triển khai cấu hình Điều khiển thiết bị dệt cho thiết bị Dệt.

Tóm lược

Di sản

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

Chức năng công cộng

Init ()
IsPairedToAccount () const override
virtual bool
Được gọi để xác định xem thiết bị hiện đã được ghép nối với tài khoản hay chưa.
IsResetAllowed (uint16_t resetFlags) override
virtual bool
Kiểm tra xem việc đặt lại cấu hình đã chỉ định có được phép hay không.
OnConnectionMonitorTimeout (uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed (void) override
virtual WEAVE_ERROR
Cho biết rằng cấu hình thiết bị không an toàn đã được trang bị.
OnFailSafeDisarmed (void) override
virtual WEAVE_ERROR
Cho biết rằng cấu hình thiết bị không an toàn đã bị vô hiệu hóa.
OnPlatformEvent (const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone (void) override
virtual void
Cho biết rằng quá trình Điểm hẹn bị động từ xa đã kết thúc.
OnRemotePassiveRendezvousStarted (void) override
virtual void
Cho biết rằng quá trình Điểm hẹn bị động từ xa đã bắt đầu.
OnResetConfig (uint16_t resetFlags) override
virtual WEAVE_ERROR
Đặt lại tất cả 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 kết nối máy chủ, nếu có, có nên được đóng trước khi đặt lại cấu hình hay không.
WillCloseRemotePassiveRendezvous (void) override
virtual void
Chuẩn bị dừng Điểm hẹn Bị động Từ xa.
WillStartRemotePassiveRendezvous (void) override
virtual WEAVE_ERROR
Chuẩn bị cho một cuộc hẹn bị động từ xa.

Các chức năng được bảo vệ

DeviceControlServer ()=default
DeviceControlServer (const DeviceControlServer &)=delete
DeviceControlServer (const DeviceControlServer &&)=delete
operator= (const DeviceControlServer &)=delete
~DeviceControlServer ()=default

Chức năng công cộng

Trong đó

WEAVE_ERROR Init()

IsPairsToAccount

virtual bool IsPairedToAccount() const override

Được gọi để xác định xem thiết bị hiện đã được ghép nối với tài khoản hay chưa.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

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

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

OnConnectionMonitorTimeout

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

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

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 đã được trang bị để đáp ứng yêu cầu từ máy khách. Két an toàn không tự động đặt lại cấu hình thiết bị về trạng thái đã biết nếu quá trình cấu hình không hoàn tất thành công.

Chi tiết
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các mã lỗi Weave hoặc nền tảng cụ thể khác cho biết rằng đã xảy ra lỗi khiến két an toàn không được trang bị.

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ị vô hiệu hóa.

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ị vô hiệu hóa theo yêu cầu từ máy khách. Máy khách sẽ vô hiệu hóa két an toàn sau khi cấu hình xong.

Chi tiết
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các mã lỗi Weave hoặc nền tảng cụ thể khác cho biết rằng đã xảy ra lỗi khiến két sắt không thể giải giáp được.

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

Cho biết rằng quá trình Điểm hẹn bị độ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 bị động từ xa đã bắt đầu.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

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

Việc triển khai chức năng này dự kiến ​​sẽ đặt lại bất kỳ sự kết hợp nào của cấu hình mạng, vải dệt hoặc dịch vụ về trạng thái đã biết, theo cờ đặt lại.

Chi tiết
Thông số
[in] resetFlags
Các cờ chỉ định cấu hình nào cần đặt lại.
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các mã lỗi Weave hoặc nền tảng cụ thể khác cho biết rằng đã xảy ra lỗi khiến thiết bị không thể đặt lại cấu hình của nó.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

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

Chi tiết
Thông số
[in] profileId
ID của hồ sơ của bài kiểm tra được yêu cầu.
[in] testId
ID của bài kiểm tra được yêu cầu.
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các mã lỗi Weave hoặc nền tảng cụ thể khác cho biết rằng đã xảy ra lỗi ngăn cản việc 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.

Chi tiết
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các mã lỗi Weave hoặc nền tảng cụ thể khác cho biết rằng đã xảy ra lỗi ngăn việc dừng kiểm tra hệ thống.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

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

Hàm này được sử dụng để truy vấn người ủy quyền về 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 ĐÚNG đối với phương pháp này sẽ khiến kết nối đó bị đóng trước khi kích hoạt thiết lập lại cấu hình thông qua phương thức OnResetConfig.

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

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

Chuẩn bị dừng Điểm hẹn Bị động Từ xa.

Xem thêm:
WillStartRemotePassiveRendezvous (vô hiệu)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

Chuẩn bị cho một cuộc hẹn bị động từ xa.

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

Chi tiết
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các mã lỗi Weave hoặc nền tảng cụ thể khác cho biết rằng đã xảy ra lỗi khi chuẩn bị bắt đầu Điểm hẹn thụ động từ xa.

Các chức năng được bảo vệ

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

toán tử =

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~ DeviceControlServer

 ~DeviceControlServer()=default