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

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

คลาสของเซิร์ฟเวอร์สำหรับการปรับใช้โปรไฟล์การจัดสรรเครือข่าย

สรุป

การสืบทอด

รับค่าจาก nl::Weave::WeaveServerBase
Direct Known Subclasses:
  nl::Weave::DeviceLayer::Internal::genericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Impl1NetworkServer::generic Implserver{/0

ผู้ผลิตและผู้ทำลาย
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)
เริ่มต้นสถานะเซิร์ฟเวอร์การจัดสรรเครือข่าย และลงทะเบียนเพื่อรับข้อความการจัดสรรเครือข่าย
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
ส่งข้อความ "เพิ่มเครือข่ายให้สมบูรณ์" หากเพิ่มเครือข่ายเรียบร้อยแล้ว
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
ส่งข้อความ "รับเครือข่ายโดยสมบูรณ์" ที่มีเครือข่ายที่สแกนไว้ก่อนหน้านี้
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
ส่งข้อความ Get WirelessRegulatoryConfigComplete ไปยังเพียร์
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
ส่งข้อความตอบกลับการสแกนเครือข่ายโดยสมบูรณ์ที่มีผลลัพธ์ของการสแกน
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
ส่งการตอบกลับรายงานสถานะไปยังคำขอ
SendSuccessResponse(void)
virtual WEAVE_ERROR
ส่งการตอบกลับที่สำเร็จไปยังคำขอการจัดสรรเครือข่าย
SetDelegate(NetworkProvisioningDelegate *delegate)
void
ตั้งค่าผู้รับมอบสิทธิ์เพื่อประมวลผลเหตุการณ์ของเซิร์ฟเวอร์การจัดสรรเครือข่าย
Shutdown(void)
ปิดเซิร์ฟเวอร์การจัดสรรเครือข่าย

แอตทริบิวต์ที่ได้รับการปกป้อง

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

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

แอตทริบิวต์สาธารณะ

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

ฟังก์ชันสาธารณะ

เริ่มต้น

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

เริ่มต้นสถานะเซิร์ฟเวอร์การจัดสรรเครือข่าย และลงทะเบียนเพื่อรับข้อความการจัดสรรเครือข่าย

รายละเอียด
พารามิเตอร์
[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
)

ส่งข้อความ "เพิ่มเครือข่ายให้สมบูรณ์" หากเพิ่มเครือข่ายเรียบร้อยแล้ว

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

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

ส่งข้อความ "รับเครือข่ายโดยสมบูรณ์" ที่มีเครือข่ายที่สแกนไว้ก่อนหน้านี้

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

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

ส่งข้อความ Get WirelessRegulatoryConfigComplete ไปยังเพียร์

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

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

ส่งข้อความตอบกลับการสแกนเครือข่ายโดยสมบูรณ์ที่มีผลลัพธ์ของการสแกน

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

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
)

ตั้งค่าผู้รับมอบสิทธิ์เพื่อประมวลผลเหตุการณ์ของเซิร์ฟเวอร์การจัดสรรเครือข่าย

รายละเอียด
พารามิเตอร์
[in] delegate
ตัวชี้ไปยังการมอบสิทธิ์การจัดสรรเครือข่าย

ปิดการทำงาน

WEAVE_ERROR Shutdown(
  void
)

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

รายละเอียด
แสดงผลค่า
WEAVE_NO_ERROR
ความสำเร็จ