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

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

Mengimplementasikan profil Kontrol Perangkat Weave untuk perangkat Weave.

Ringkasan

Inheritance

Mewarisi dari:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Fungsi publik

Init()
IsPairedToAccount() const override
virtual bool
Dipanggil untuk menentukan apakah perangkat saat ini dipasangkan dengan akun.
IsResetAllowed(uint16_t resetFlags) override
virtual bool
Periksa apakah mereset konfigurasi yang ditentukan diizinkan.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
Menunjukkan bahwa keamanan konfigurasi perangkat telah diaktifkan.
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
Menunjukkan bahwa konfigurasi perangkat gagal aman telah dinonaktifkan.
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
Menunjukkan bahwa proses Rendezvous Pasif Jarak Jauh telah selesai.
OnRemotePassiveRendezvousStarted(void) override
virtual void
Menunjukkan bahwa proses Rendezvous Pasif Jarak Jauh telah dimulai.
OnResetConfig(uint16_t resetFlags) override
virtual WEAVE_ERROR
Reset semua atau sebagian konfigurasi perangkat.
OnSystemTestStarted(uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
Memulai pengujian sistem yang ditentukan.
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
Hentikan pengujian sistem yang sedang berlangsung.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
virtual bool
Menentukan apakah koneksi server, jika ada, harus ditutup sebelum konfigurasi direset.
WillCloseRemotePassiveRendezvous(void) override
virtual void
Bersiaplah untuk menghentikan Rendezvous Pasif Jarak Jauh.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
Bersiaplah untuk Rendezvous Pasif Jarak Jauh.

Fungsi yang dilindungi

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

Fungsi publik

Inisiasi

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

Dipanggil untuk menentukan apakah perangkat saat ini dipasangkan dengan akun.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

Periksa apakah mereset konfigurasi yang ditentukan diizinkan.

Detail
Parameter
[in] resetFlags
Flag yang menentukan konfigurasi yang akan direset.
Nilai Pengembalian
TRUE
jika pengaturan ulang konfigurasi diizinkan.
FALSE
jika mengatur ulang konfigurasi tidak diizinkan.

OnConnectionMonitorTimeout

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

Menunjukkan bahwa keamanan konfigurasi perangkat telah diaktifkan.

Fungsi ini dipanggil saat keamanan konfigurasi perangkat server telah diaktifkan sebagai respons atas permintaan dari klien. Brankas kegagalan akan otomatis mereset konfigurasi perangkat ke status yang diketahui jika proses konfigurasi gagal diselesaikan.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error Weave atau khusus platform lainnya yang menunjukkan bahwa terjadi error yang mencegah kegagalan yang aman dari pengaktifan.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

Menunjukkan bahwa konfigurasi perangkat gagal aman telah dinonaktifkan.

Fungsi ini dipanggil saat konfigurasi perangkat server gagal aman telah dinonaktifkan sebagai respons atas permintaan dari klien. Klien akan menonaktifkan keamanan kegagalan setelah konfigurasi selesai.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error Weave atau khusus platform lainnya yang menunjukkan bahwa terjadi error yang mencegah kegagalan fungsi dinonaktifkan.

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

Menunjukkan bahwa proses Rendezvous Pasif Jarak Jauh telah selesai.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

Menunjukkan bahwa proses Rendezvous Pasif Jarak Jauh telah dimulai.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

Reset semua atau sebagian konfigurasi perangkat.

Implementasi fungsi ini diharapkan akan mereset kombinasi jaringan, Weave fabric, atau konfigurasi layanan ke status yang diketahui, sesuai dengan flag reset.

Detail
Parameter
[in] resetFlags
Flag yang menentukan konfigurasi yang akan direset.
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error Weave lain atau khusus platform yang menunjukkan bahwa terjadi error yang mencegah perangkat mereset konfigurasinya.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

Memulai pengujian sistem yang ditentukan.

Detail
Parameter
[in] profileId
ID profil pengujian yang diminta.
[in] testId
ID pengujian yang diminta.
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error khusus platform atau Weave lain yang menunjukkan bahwa terjadi error yang mencegah dimulainya uji sistem.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

Hentikan pengujian sistem yang sedang berlangsung.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error khusus platform atau Weave lain yang menunjukkan bahwa terjadi error yang mencegah penghentian uji sistem.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

Menentukan apakah koneksi server, jika ada, harus ditutup sebelum konfigurasi direset.

Fungsi ini digunakan untuk mengkueri delegasi untuk perilaku yang diinginkan saat memproses permintaan reset konfigurasi. Jika koneksi server saat ini aktif, respons TRUE untuk metode ini akan menyebabkan koneksi tersebut ditutup sebelum pengaturan ulang konfigurasi dipicu melalui metode OnResetConfig.

Detail
Parameter
[in] resetFlags
Flag yang menentukan konfigurasi yang akan direset.
Nilai Pengembalian
true
jika koneksi perlu ditutup.
false
jika koneksi tidak perlu ditutup.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

Bersiaplah untuk menghentikan Rendezvous Pasif Jarak Jauh.

Lihat juga:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

Bersiaplah untuk Rendezvous Pasif Jarak Jauh.

Misalnya, buat jaringan 15.4/Thread dapat digabungkan.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error Weave atau khusus platform lainnya yang menunjukkan bahwa terjadi error saat bersiap memulai Rendezvous Pasif Jarak Jauh.

Fungsi yang dilindungi

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default