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

Ini adalah class abstrak.

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

Delegasikan class untuk mengimplementasikan operasi Kontrol Perangkat yang masuk di perangkat server.

Ringkasan

Inheritance

Mewarisi dari: nl::Weave::WeaveServerDelegateBase
Subclass yang Dikenal 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 ke akun.
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
Periksa apakah reset konfigurasi yang ditentukan diizinkan.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
Menunjukkan bahwa waktu tunggu pemantau koneksi telah berlangsung.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Menunjukkan bahwa konfigurasi perangkat gagal aman 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
Tentukan apakah koneksi server, jika ada, harus ditutup sebelum reset konfigurasi.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Bersiaplah untuk menghentikan Rendezvous Pasif Jarak Jauh.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Bersiap 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 pada 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 masuk ke metode, nilai tersebut mewakili hasil sementara pada tahap saat ini dalam proses evaluasi. Setelah dikembalikan, hasilnya diharapkan mewakili penilaian akhir kebijakan kontrol akses untuk pesan tersebut.

IsPairedToAccount

virtual bool IsPairedToAccount() const

Dipanggil untuk menentukan apakah perangkat saat ini dipasangkan ke akun.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

Periksa apakah reset konfigurasi yang ditentukan diizinkan.

Detail
Parameter
[in] resetFlags
Tanda yang menentukan konfigurasi yang akan direset.
Nilai yang Ditampilkan
TRUE
jika reset konfigurasi diizinkan.
FALSE
jika tidak diizinkan mengatur ulang konfigurasi.

OnConnectionMonitorTimeout

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

Menunjukkan bahwa waktu tunggu pemantau koneksi telah berlangsung.

Fungsi ini dipanggil saat waktu tunggu Pemantau Koneksi 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 keaktifannya telah habis.
[in] peerAddr
Alamat peer jarak jauh.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

Menunjukkan bahwa konfigurasi perangkat gagal aman telah diaktifkan.

Fungsi ini dipanggil saat konfigurasi perangkat server gagal aman telah diaktifkan sebagai respons atas permintaan klien. Fail safe secara otomatis mereset konfigurasi perangkat ke status yang diketahui jika proses konfigurasi gagal diselesaikan.

Detail
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya yang menunjukkan bahwa terjadi error yang mencegah pengaktifan kegagalan pengaman.

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 alat pengaman setelah konfigurasi selesai.

Detail
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya yang menunjukkan bahwa terjadi error yang mencegah fungsi gagal aman 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 mereset kombinasi jaringan, kain Weave, atau konfigurasi layanan apa pun ke status yang diketahui, sesuai dengan tanda reset.

Detail
Parameter
[in] resetFlags
Tanda yang menentukan konfigurasi yang akan direset.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya 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 yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah dimulainya pengujian sistem.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

Hentikan pengujian sistem yang sedang berlangsung.

Detail
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah penghentian pengujian sistem.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

Tentukan apakah koneksi server, jika ada, harus ditutup sebelum reset konfigurasi.

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

Detail
Parameter
[in] resetFlags
Tanda yang menentukan konfigurasi yang akan direset.
Nilai yang Ditampilkan
true
jika koneksi harus 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 yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya yang menunjukkan bahwa error terjadi saat bersiap memulai Rendezvous Pasif Jarak Jauh.