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

Ini adalah class abstrak.

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

Delegasikan class untuk menerapkan operasi Kontrol Perangkat yang masuk pada perangkat server.

Ringkasan

Inheritance

Mewarisi dari: nl::Weave::WeaveServerDelegateBase
Subclasses yang Diketahui Langsung: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Fungsi publik
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Terapkan kontrol akses tingkat pesan untuk pesan permintaan DeviceControl yang masuk.
IsPairedToAccount() const
virtual bool
Dipanggil untuk menentukan apakah perangkat saat ini dipasangkan dengan akun.
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
Periksa apakah mereset konfigurasi yang ditentukan diizinkan.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
Mengindikasikan bahwa telah ada waktu tunggu pemantau koneksi.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Menunjukkan bahwa keamanan konfigurasi perangkat telah diaktifkan.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
Menunjukkan bahwa konfigurasi perangkat gagal aman telah dinonaktifkan.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Menunjukkan bahwa proses Rendezvous Pasif Jarak Jauh telah selesai.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Menunjukkan bahwa proses Rendezvous Pasif Jarak Jauh telah dimulai.
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
Reset semua atau sebagian konfigurasi perangkat.
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
Memulai pengujian sistem yang ditentukan.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
Hentikan pengujian sistem yang sedang berlangsung.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
Menentukan apakah koneksi server, jika ada, harus ditutup sebelum konfigurasi direset.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Bersiaplah untuk menghentikan Rendezvous Pasif Jarak Jauh.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Bersiaplah untuk Rendezvous Pasif Jarak Jauh.

Fungsi publik

EnforceAccessControl

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

Terapkan kontrol akses tingkat pesan untuk pesan permintaan DeviceControl yang masuk.

Detail
Parameter
[in] ec
ExchangeContext tempat pesan diterima.
[in] msgProfileId
ID profil pesan yang diterima.
[in] msgType
Jenis pesan untuk pesan yang diterima.
[in] msgInfo
Struktur WeaveMessageInfo yang berisi informasi tentang pesan yang diterima.
[in,out] result
Nilai terenumerasi yang menjelaskan hasil evaluasi kebijakan kontrol akses untuk pesan yang diterima. Setelah entri ke metode tersebut, nilai mewakili hasil tentatif pada titik saat ini dalam proses evaluasi. Setelah dikembalikan, hasilnya diharapkan mewakili penilaian akhir kebijakan kontrol akses untuk pesan.

IsPairedToAccount

virtual bool IsPairedToAccount() const

Dipanggil untuk menentukan apakah perangkat saat ini dipasangkan dengan akun.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

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

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

Mengindikasikan bahwa telah ada waktu tunggu pemantau koneksi.

Fungsi ini dipanggil ketika waktu tunggu Connection Monitor telah terjadi, yaitu ketika pemeriksaan keaktifan belum terdeteksi dari host jarak jauh untuk jangka waktu tertentu.

Detail
Parameter
[in] peerNodeId
ID node peer jarak jauh yang waktu aktif koneksinya telah habis.
[in] peerAddr
Alamat peer jarak jauh.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

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
)=0

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.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Menunjukkan bahwa proses Rendezvous Pasif Jarak Jauh telah selesai.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Menunjukkan bahwa proses Rendezvous Pasif Jarak Jauh telah dimulai.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

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
)=0

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
)=0

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
)=0

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
)=0

Bersiaplah untuk menghentikan Rendezvous Pasif Jarak Jauh.

Lihat juga:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

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.