ไม่มี:: สาน:: โปรไฟล์:: การจัดสรรเครือข่าย:: NetworkProvisioningServer

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

คลาสเซิร์ฟเวอร์สำหรับใช้งานโปรไฟล์ Network Provisioning

สรุป

มรดก

สืบทอดจาก: NL :: สาน :: WeaveServerBase
คลาสย่อยที่รู้จักโดยตรง:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< ImplClass >

ตัวสร้างและตัวทำลาย

NetworkProvisioningServer (void)

คุณสมบัติที่ได้รับการคุ้มครอง

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

คุณลักษณะสาธารณะ

StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

งานสาธารณะ

Init ( WeaveExchangeManager *exchangeMgr)
เริ่มต้นสถานะ Network Provisioning Server และลงทะเบียนเพื่อรับข้อความ Network Provisioning
SendAddNetworkComplete (uint32_t networkId)
virtual WEAVE_ERROR
ส่งข้อความ Add Network Complete หากเพิ่มเครือข่ายสำเร็จ
SendGetNetworksComplete (uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
ส่งข้อความ Get Networks Complete ที่มีเครือข่ายที่สแกนก่อนหน้านี้
SendGetWirelessRegulatoryConfigComplete ( PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
ส่งข้อความ GetWirelessRegulatoryConfigComplete ถึงเพื่อน
SendNetworkScanComplete (uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
ส่งข้อความตอบกลับ Network Scan Complete ที่มีผลลัพธ์ของการสแกน
SendStatusReport (uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
ส่งการตอบกลับรายงานสถานะตามคำขอ
SendSuccessResponse (void)
virtual WEAVE_ERROR
ส่งการตอบสนองที่สำเร็จไปยังคำขอการจัดสรรเครือข่าย
SetDelegate ( NetworkProvisioningDelegate *delegate)
void
ตั้งค่าผู้รับมอบสิทธิ์เพื่อประมวลผลเหตุการณ์ Network Provisioning Server
Shutdown (void)
ปิดเซิร์ฟเวอร์การจัดสรรเครือข่าย

คุณสมบัติที่ได้รับการคุ้มครอง

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

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

คุณลักษณะสาธารณะ

รหัสสถานะ

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

งานสาธารณะ

ในนั้น

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

เริ่มต้นสถานะ Network Provisioning Server และลงทะเบียนเพื่อรับข้อความ Network Provisioning

รายละเอียด
พารามิเตอร์
[in] exchangeMgr
ตัวชี้ไปยังระบบ Weave Exchange Manager
ส่งกลับค่า
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
หากมีการลงทะเบียนตัวจัดการข้อความมากเกินไป
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

ส่งข้อความ Add Network Complete หากเพิ่มเครือข่ายสำเร็จ

รายละเอียด
พารามิเตอร์
[in] networkId
ID ของเครือข่ายที่เพิ่ม
ส่งกลับค่า
WEAVE_ERROR_INCORRECT_STATE
หาก Network Provisioning Server ไม่ได้เตรียมใช้งานอย่างถูกต้อง
WEAVE_ERROR_NO_MEMORY
เมื่อล้มเหลวในการจัดสรร PacketBuffer
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
รหัสข้อผิดพลาดเฉพาะของ Weave หรือแพลตฟอร์มที่ระบุว่ามีข้อผิดพลาดเกิดขึ้นซึ่งทำให้อุปกรณ์ไม่สามารถส่งข้อความ Add Network Complete

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

ส่งข้อความ Get Networks Complete ที่มีเครือข่ายที่สแกนก่อนหน้านี้

รายละเอียด
พารามิเตอร์
[in] resultCount
จำนวนผลการสแกน
[in] scanResultsTLV
ผลการสแกน
ส่งกลับค่า
WEAVE_ERROR_INCORRECT_STATE
หาก Network Provisioning Server ไม่ได้เตรียมใช้งานอย่างถูกต้อง
WEAVE_ERROR_BUFFER_TOO_SMALL
หากบัฟเฟอร์ผลลัพธ์ไม่ใหญ่พอ
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
รหัสข้อผิดพลาดเฉพาะของ Weave หรือแพลตฟอร์มที่ระบุว่ามีข้อผิดพลาดเกิดขึ้นซึ่งทำให้อุปกรณ์ไม่สามารถส่งข้อความ Get Networks Complete

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

ส่งข้อความ GetWirelessRegulatoryConfigComplete ถึงเพื่อน

รายละเอียด
พารามิเตอร์
[in] resultsTLV
แพ็กเก็ตบัฟเฟอร์ที่มีข้อมูลการตั้งค่าคอนฟิกการควบคุมแบบไร้สายที่จะส่งคืน
ส่งกลับค่า
WEAVE_ERROR_INCORRECT_STATE
หาก Network Provisioning Server ไม่ได้เตรียมใช้งานอย่างถูกต้อง
WEAVE_ERROR_NO_MEMORY
เมื่อล้มเหลวในการจัดสรร PacketBuffer
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
รหัสข้อผิดพลาดเฉพาะของ Weave หรือแพลตฟอร์มที่ระบุว่ามีข้อผิดพลาดเกิดขึ้นซึ่งทำให้อุปกรณ์ไม่สามารถส่งข้อความ Add Network Complete

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

ส่งข้อความตอบกลับ Network Scan Complete ที่มีผลลัพธ์ของการสแกน

รายละเอียด
พารามิเตอร์
[in] resultCount
จำนวนผลการสแกน
[in] scanResultsTLV
ผลการสแกน
ส่งกลับค่า
WEAVE_ERROR_INCORRECT_STATE
หาก Network Provisioning Server ไม่ได้เตรียมใช้งานอย่างถูกต้อง
WEAVE_ERROR_BUFFER_TOO_SMALL
หากบัฟเฟอร์ผลลัพธ์ไม่ใหญ่พอ
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
รหัสข้อผิดพลาด Weave หรือเฉพาะแพลตฟอร์มอื่น ๆ ที่ระบุว่ามีข้อผิดพลาดเกิดขึ้นซึ่งทำให้อุปกรณ์ไม่สามารถส่งการตอบสนอง Scan Complete

SendStatusReport

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

ส่งการตอบกลับรายงานสถานะตามคำขอ

รายละเอียด
พารามิเตอร์
[in] statusProfileId
รหัสโปรไฟล์ Weave รายงานสถานะนี้เกี่ยวข้องกับ
[in] statusCode
รหัสสถานะที่จะรวมในการตอบกลับนี้
[in] sysError
รหัสข้อผิดพลาดของระบบที่จะรวมในการตอบกลับนี้
ส่งกลับค่า
WEAVE_ERROR_INCORRECT_STATE
หากไม่มีการร้องขอให้ดำเนินการ
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
รหัสข้อผิดพลาด Weave หรือเฉพาะแพลตฟอร์มอื่น ๆ ที่ระบุว่าเกิดข้อผิดพลาดที่ทำให้อุปกรณ์ไม่สามารถส่งรายงานสถานะได้

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

ส่งการตอบสนองที่สำเร็จไปยังคำขอการจัดสรรเครือข่าย

รายละเอียด
ส่งกลับค่า
WEAVE_ERROR_INCORRECT_STATE
หากไม่มีการร้องขอให้ดำเนินการ
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
รหัสข้อผิดพลาด Weave หรือเฉพาะแพลตฟอร์มอื่น ๆ ที่ระบุว่ามีข้อผิดพลาดเกิดขึ้นซึ่งทำให้อุปกรณ์ไม่สามารถส่งการตอบสนองที่สำเร็จ

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

ตั้งค่าผู้รับมอบสิทธิ์เพื่อประมวลผลเหตุการณ์ Network Provisioning Server

รายละเอียด
พารามิเตอร์
[in] delegate
ตัวชี้ไปยัง Network Provisioning Delegate

ปิดตัวลง

WEAVE_ERROR Shutdown(
  void
)

ปิดเซิร์ฟเวอร์การจัดสรรเครือข่าย

รายละเอียด
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ