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

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

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

สรุป

การสืบทอด

รับค่าจาก: nl::Weave::WeaveServerBase
คลาสย่อยที่รู้จักโดยตรง:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; 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)
เริ่มต้นสถานะเซิร์ฟเวอร์การจัดสรรเครือข่ายและลงทะเบียนเพื่อรับข้อความการจัดสรรเครือข่าย
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
ส่งข้อความเพิ่มเครือข่ายเสร็จสมบูรณ์หากเพิ่มเครือข่ายสำเร็จแล้ว
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
ส่งข้อความ "รับเครือข่ายให้เสร็จสมบูรณ์" ซึ่งมีเครือข่ายที่สแกนไว้ก่อนหน้านี้
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
ส่งข้อความ GetWirelessRegulatoryConfigComplete ไปยังเพียร์
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

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

Init

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
)

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

รายละเอียด
พารามิเตอร์
[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
สำเร็จแล้ว