nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningDelegate

Ini adalah class abstrak.

#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>

Delegasikan kelas untuk mengimplementasikan operasi Penyediaan Jaringan.

Ringkasan

Inheritance

Mewarisi dari: nl::Weave::WeaveServerDelegateBase
Subclass yang Dikenal Langsung:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; ImplClass >

Atribut publik
Server
[HANYA BACA] Objek server tempat delegasi ini dilampirkan.

Fungsi publik
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Menerapkan kontrol akses tingkat pesan untuk pesan permintaan Penyediaan Jaringan yang masuk.
HandleAddNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
Tambahkan jaringan tertentu.
HandleDisableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Menonaktifkan jaringan yang ditentukan.
HandleEnableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Mengaktifkan jaringan yang ditentukan.
HandleGetNetworks(uint8_t flags)=0
virtual WEAVE_ERROR
Mendapatkan jaringan yang dikonfigurasi.
HandleGetWirelessRegulatoryConfig(void)
virtual WEAVE_ERROR
Dapatkan informasi konfigurasi peraturan nirkabel.
HandleRemoveNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Menghapus jaringan yang dikonfigurasi.
HandleScanNetworks(uint8_t networkType)=0
virtual WEAVE_ERROR
Lakukan pemindaian jaringan.
HandleSetRendezvousMode(uint16_t rendezvousMode)=0
virtual WEAVE_ERROR
Atur mode pertemuan.
HandleSetWirelessRegulatoryConfig(PacketBuffer *regConfigTLV)
virtual WEAVE_ERROR
Atur informasi konfigurasi peraturan nirkabel.
HandleTestConnectivity(uint32_t networkId)=0
virtual WEAVE_ERROR
Uji konektivitas jaringan yang ditentukan.
HandleUpdateNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
Perbarui konfigurasi jaringan.
IsPairedToAccount() const
virtual bool
Dipanggil untuk menentukan apakah perangkat saat ini dipasangkan ke akun.

Atribut publik

Server

NetworkProvisioningServer * Server

[HANYA BACA] Objek server tempat delegasi ini dilampirkan.

Fungsi publik

EnforceAccessControl

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

Menerapkan kontrol akses tingkat pesan untuk pesan permintaan Penyediaan Jaringan 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.

HandleAddNetwork

virtual WEAVE_ERROR HandleAddNetwork(
  PacketBuffer *networkInfoTLV
)=0

Tambahkan jaringan tertentu.

Detail
Parameter
[in] networkInfoTLV
Konfigurasi jaringan yang dienkode dalam TLV.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah perangkat menambahkan jaringan.
Lihat juga:
NetworkProvisioningDataElementTags untuk jenis yang valid.

HandleDisableNetwork

virtual WEAVE_ERROR HandleDisableNetwork(
  uint32_t networkId
)=0

Menonaktifkan jaringan yang ditentukan.

Detail
Parameter
[in] networkId
ID jaringan yang akan dinonaktifkan.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah perangkat menonaktifkan jaringan.

HandleEnableNetwork

virtual WEAVE_ERROR HandleEnableNetwork(
  uint32_t networkId
)=0

Mengaktifkan jaringan yang ditentukan.

Detail
Parameter
[in] networkId
ID jaringan yang akan diaktifkan.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah perangkat mengaktifkan jaringan.

HandleGetNetworks

virtual WEAVE_ERROR HandleGetNetworks(
  uint8_t flags
)=0

Mendapatkan jaringan yang dikonfigurasi.

Detail
Parameter
[in] flags
Tanda untuk memfilter jaringan yang diambil.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya yang menunjukkan bahwa terjadi error yang mencegah perangkat mendapatkan jaringan yang dikonfigurasi.

HandleGetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleGetWirelessRegulatoryConfig(
  void
)

Dapatkan informasi konfigurasi peraturan nirkabel.

Detail
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah perangkat mengambil informasi yang diminta.

HandleRemoveNetwork

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

Menghapus jaringan yang dikonfigurasi.

Detail
Parameter
[in] networkId
ID jaringan yang akan dihapus.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya yang menunjukkan bahwa terjadi error yang mencegah perangkat menghapus jaringan.

HandleScanNetworks

virtual WEAVE_ERROR HandleScanNetworks(
  uint8_t networkType
)=0

Lakukan pemindaian jaringan.

Detail
Parameter
[in] networkType
Teknologi (misalnya, Wi-Fi atau Thread) yang akan dipindai.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya yang menunjukkan bahwa terjadi error yang mencegah perangkat melakukan pemindaian jaringan.
Lihat juga:
NetworkType untuk mengetahui jenis yang valid.

HandleSetRendezvousMode

virtual WEAVE_ERROR HandleSetRendezvousMode(
  uint16_t rendezvousMode
)=0

Atur mode pertemuan.

Detail
Parameter
[in] rendezvousMode
Mode pertemuan yang akan digunakan.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya yang menunjukkan bahwa terjadi error yang mencegah perangkat menyetel mode pertemuan.
Lihat juga:
RendezvousModeFlags untuk mode yang valid.

HandleSetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

Atur informasi konfigurasi peraturan nirkabel.

Detail
Parameter
[in] regConfigTLV
Buffer paket yang berisi informasi konfigurasi peraturan nirkabel baru yang dienkode dalam format TLV.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah perangkat menyetel informasi yang diminta.

HandleTestConnectivity

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

Uji konektivitas jaringan yang ditentukan.

Detail
Parameter
[in] networkId
ID jaringan yang akan diuji konektivitasnya.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah perangkat menguji konektivitas.

HandleUpdateNetwork

virtual WEAVE_ERROR HandleUpdateNetwork(
  PacketBuffer *networkInfoTLV
)=0

Perbarui konfigurasi jaringan.

Detail
Parameter
[in] networkInfoTLV
Konfigurasi jaringan yang dienkode dalam TLV.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
other
Kode error khusus platform atau Weave lainnya menunjukkan bahwa terjadi error yang mencegah perangkat memperbarui jaringan.
Lihat juga:
NetworkProvisioningDataElementTags untuk jenis yang valid.

IsPairedToAccount

virtual bool IsPairedToAccount() const

Dipanggil untuk menentukan apakah perangkat saat ini dipasangkan ke akun.