nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

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

Kelas server untuk menerapkan profil Penyediaan Jaringan.

Ringkasan

Inheritance

Mewarisi dari: nl::Weave::WeaveServerBase
Direct Known Subclasses:
  nl::Weave::DeviceLayer::Internal::GenericNetworkMenyediakanServerImpl< NetworkProviderServerImpl >
  nl::Weave::DeviceLayer::Internal::ImplClassServer>

Konstruktor dan Destruktor
NetworkProvisioningServer(void)

Atribut yang dilindungi
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

Atribut publik
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

Fungsi publik
Init(WeaveExchangeManager *exchangeMgr)
Melakukan inisialisasi status Server Penyediaan Jaringan dan mendaftar untuk menerima pesan Penyediaan Jaringan.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Kirim pesan Tambahkan Jaringan Selesai jika jaringan berhasil ditambahkan.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Kirim pesan Get Networks Complete yang berisi jaringan yang dipindai sebelumnya.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Mengirim pesan GetWirelessRegulatoryConfigComplete ke peer.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Kirim pesan respons Pemindaian Jaringan Selesai yang berisi hasil pemindaian.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Mengirim respons laporan status ke permintaan.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Kirim respons berhasil untuk permintaan Penyediaan Jaringan.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Tetapkan delegasi untuk memproses peristiwa Server Penyediaan Jaringan.
Shutdown(void)
Matikan Server Penyediaan Jaringan.

Atribut yang dilindungi

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult

Atribut publik

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Fungsi publik

Inisiasi

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Melakukan inisialisasi status Server Penyediaan Jaringan dan mendaftar untuk menerima pesan Penyediaan Jaringan.

Detail
Parameter
[in] exchangeMgr
Pointer ke sistem Weave Exchange Manager.
Nilai Pengembalian
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Jika terlalu banyak pengendali pesan yang telah didaftarkan.
WEAVE_NO_ERROR
Setelah berhasil.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Kirim pesan Tambahkan Jaringan Selesai jika jaringan berhasil ditambahkan.

Detail
Parameter
[in] networkId
ID jaringan yang ditambahkan.
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
Jika Server Penyediaan Jaringan tidak diinisialisasi dengan benar.
WEAVE_ERROR_NO_MEMORY
Jika gagal mengalokasikan PacketBuffer.
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error khusus platform atau Weave lain yang menunjukkan bahwa terjadi error yang mencegah perangkat mengirimkan pesan Tambahkan Jaringan Selesai.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Kirim pesan Get Networks Complete yang berisi jaringan yang dipindai sebelumnya.

Detail
Parameter
[in] resultCount
Jumlah hasil pemindaian.
[in] scanResultsTLV
Hasil pemindaian.
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
Jika Server Penyediaan Jaringan tidak diinisialisasi dengan benar.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika buffer hasil tidak cukup besar.
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error khusus platform atau Weave lain yang menunjukkan bahwa terjadi error yang mencegah perangkat mengirim pesan Get Networks Complete.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Mengirim pesan GetWirelessRegulatoryConfigComplete ke peer.

Detail
Parameter
[in] resultsTLV
Buffering paket yang berisi informasi konfigurasi peraturan nirkabel yang akan ditampilkan.
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
Jika Server Penyediaan Jaringan tidak diinisialisasi dengan benar.
WEAVE_ERROR_NO_MEMORY
Jika gagal mengalokasikan PacketBuffer.
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error khusus platform atau Weave lain yang menunjukkan bahwa terjadi error yang mencegah perangkat mengirimkan pesan Tambahkan Jaringan Selesai.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Kirim pesan respons Pemindaian Jaringan Selesai yang berisi hasil pemindaian.

Detail
Parameter
[in] resultCount
Jumlah hasil pemindaian.
[in] scanResultsTLV
Hasil pemindaian.
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
Jika Server Penyediaan Jaringan tidak diinisialisasi dengan benar.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika buffer hasil tidak cukup besar.
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error khusus platform atau Weave lain yang menunjukkan bahwa terjadi error yang mencegah perangkat mengirim respons Pindai Selesai.

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Mengirim respons laporan status ke permintaan.

Detail
Parameter
[in] statusProfileId
ID profil Weave yang terkait dengan laporan status ini.
[in] statusCode
Kode status yang akan disertakan dalam respons ini.
[in] sysError
Kode error sistem yang akan disertakan dalam respons ini.
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
Jika tidak ada permintaan yang diproses.
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error khusus platform atau Weave lain yang menunjukkan bahwa terjadi error yang mencegah perangkat mengirim laporan status.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Kirim respons berhasil untuk permintaan Penyediaan Jaringan.

Detail
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
Jika tidak ada permintaan yang diproses.
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error khusus platform atau Weave lain yang menunjukkan bahwa terjadi error yang mencegah perangkat mengirim respons berhasil.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Tetapkan delegasi untuk memproses peristiwa Server Penyediaan Jaringan.

Detail
Parameter
[in] delegate
Pointer ke Delegasi Penyediaan Jaringan.

Nonaktif

WEAVE_ERROR Shutdown(
  void
)

Matikan Server Penyediaan Jaringan.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.