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

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

Ağ Temel Hazırlık profilini uygulamak için sunucu sınıfı.

Özet

Devralma

Devralındığı kaynak: nl::Weave::WeaveServerBase
Doğrudan Bilinen Alt Sınıflar:
  nl::Weave::DeviceKatman::Dahili::GenelAğTemelleştirme

Oluşturucular ve Yıkıcılar
NetworkProvisioningServer(void)

Korunan özellikler
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

Herkese açık özellikler
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

Kamu işlevleri
Init(WeaveExchangeManager *exchangeMgr)
Ağ Temel Hazırlık Sunucusu durumunu başlatın ve Ağ Temel Hazırlığı mesajlarını almak için kaydolun.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Ağ başarıyla eklendiyse Ağ Tamamlama Ekle mesajı gönderin.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Önceden taranan ağları içeren bir Get Networks Complete (Ağları Tamamlandı) mesajı gönderin.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Eşe GetWirelessMediationConfigComplete mesajı gönderin.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Taramanın sonuçlarını içeren bir Ağ Taraması Tamamlandı yanıt mesajı gönderin.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Bir isteğe durum raporu yanıtı gönderin.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Ağ Temel Hazırlığı isteğine başarılı bir yanıt gönderin.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Yetki verdiğiniz kullanıcıyı Ağ Temel Hazırlık Sunucusu etkinliklerini işlemesi için ayarlayın.
Shutdown(void)
Ağ Temel Hazırlık Sunucusu'nu kapatın.

Korunan özellikler

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

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

Herkese açık özellikler

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Kamu işlevleri

Başlat

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Ağ Temel Hazırlık Sunucusu durumunu başlatın ve Ağ Temel Hazırlığı mesajlarını almak için kaydolun.

Ayrıntılar
Parametreler
[in] exchangeMgr
Sistem Weave Exchange Manager için işaretçi.
Döndürülen Değerler
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Halihazırda çok fazla ileti işleyici kayıtlıysa.
WEAVE_NO_ERROR
Başarılı olun.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Ağ başarıyla eklendiyse Ağ Tamamlama Ekle mesajı gönderin.

Ayrıntılar
Parametreler
[in] networkId
Eklenen ağın kimliği.
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
Ağ Temel Hazırlık Sunucusu doğru şekilde başlatılmadıysa.
WEAVE_ERROR_NO_MEMORY
PacketBuffer tahsis edilemez.
WEAVE_NO_ERROR
Başarılı olun.
other
Cihazın Ağ Ekleme İşlemini Tamamlama mesajını göndermesini engelleyen bir hata olduğunu belirten diğer Weave veya platforma özgü hata kodları.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Önceden taranan ağları içeren bir Get Networks Complete (Ağları Tamamlandı) mesajı gönderin.

Ayrıntılar
Parametreler
[in] resultCount
Tarama sonuçlarının sayısı.
[in] scanResultsTLV
Tarama sonuçları.
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
Ağ Temel Hazırlık Sunucusu doğru şekilde başlatılmadıysa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Sonuçlar tamponu yeterince büyük değilse.
WEAVE_NO_ERROR
Başarılı olun.
other
Cihazın Get Networks Complete (Ağları Tamamlandı) mesajını göndermesini engelleyen bir hata olduğunu belirten diğer Weave veya platforma özgü hata kodları.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Eşe GetWirelessMediationConfigComplete mesajı gönderin.

Ayrıntılar
Parametreler
[in] resultsTLV
Döndürülecek kablosuz düzenleme yapılandırma bilgilerini içeren bir paket arabelleği.
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
Ağ Temel Hazırlık Sunucusu doğru şekilde başlatılmadıysa.
WEAVE_ERROR_NO_MEMORY
PacketBuffer tahsis edilemez.
WEAVE_NO_ERROR
Başarılı olun.
other
Cihazın Ağ Ekleme İşlemini Tamamlama mesajını göndermesini engelleyen bir hata olduğunu belirten diğer Weave veya platforma özgü hata kodları.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Taramanın sonuçlarını içeren bir Ağ Taraması Tamamlandı yanıt mesajı gönderin.

Ayrıntılar
Parametreler
[in] resultCount
Tarama sonuçlarının sayısı.
[in] scanResultsTLV
Tarama sonuçları.
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
Ağ Temel Hazırlık Sunucusu doğru şekilde başlatılmadıysa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Sonuçlar tamponu yeterince büyük değilse.
WEAVE_NO_ERROR
Başarılı olun.
other
Cihazın Tarama Tamamlandı yanıtını göndermesini engelleyen bir hata oluştuğunu belirten diğer Weave veya platforma özgü hata kodları.

SendStatusReport

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

Bir isteğe durum raporu yanıtı gönderin.

Ayrıntılar
Parametreler
[in] statusProfileId
Bu durum raporunun ait olduğu Örgü profil kimliği.
[in] statusCode
Bu yanıta dahil edilecek durum kodu.
[in] sysError
Bu yanıta eklenecek sistem hatası kodu.
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
İşlenen bir istek yoksa.
WEAVE_NO_ERROR
Başarılı olun.
other
Cihazın durum raporunu göndermesini engelleyen bir hata olduğunu belirten diğer Weave veya platforma özgü hata kodları.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Ağ Temel Hazırlığı isteğine başarılı bir yanıt gönderin.

Ayrıntılar
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
İşlenen bir istek yoksa.
WEAVE_NO_ERROR
Başarılı olun.
other
Cihazın başarılı yanıtı göndermesini engelleyen bir hata olduğunu belirten diğer Weave veya platforma özgü hata kodları.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Yetki verdiğiniz kullanıcıyı Ağ Temel Hazırlık Sunucusu etkinliklerini işlemesi için ayarlayın.

Ayrıntılar
Parametreler
[in] delegate
Ağ Temel Hazırlık Temsilcisi'nin işaretçisi.

Kapat

WEAVE_ERROR Shutdown(
  void
)

Ağ Temel Hazırlık Sunucusu'nu kapatın.

Ayrıntılar
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı olun.