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

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

ชั้นยูทิลิตี้สำหรับ serializing และ deserializing payloads สื่อสารผ่าน NetworkProvisioning รายละเอียด: มันสุนทรีย์ที่เกี่ยวข้องกับข้อมูลการตรวจสอบและการกำหนดค่าเครือข่าย

สรุป

คลาสนี้อาศัยการจัดเก็บข้อมูลระดับกลางของข้อมูลการจัดเตรียมเครือข่าย (ตัวกลางระหว่างที่เก็บข้อมูลขั้นสุดท้ายกับเพย์โหลดของเครือข่าย) และใช้การจัดการหน่วยความจำแบบไดนามิกเพื่อให้ออบเจ็กต์รันไทม์ที่ยืดหยุ่นได้ ด้วยเหตุนี้ คลาสนี้จึงไม่เหมาะสำหรับสภาพแวดล้อมที่มีข้อจำกัดมากที่สุด แต่อาจใช้กับระบบที่ใหญ่กว่าได้

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

NetworkInfo ()
~NetworkInfo ()

ประเภทสาธารณะ

@210 enum
@211 enum

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

Hidden
bool
ไม่ว่าเครือข่ายจะถูกซ่อนหรือไม่
NetworkId
int64_t
รหัสเครือข่ายที่กำหนดให้กับเครือข่ายโดยอุปกรณ์ -1 หากไม่ได้ระบุ
NetworkType
ประเภทของเครือข่าย
ThreadChannel
uint8_t
ช่องสัญญาณปัจจุบัน (ปัจจุบัน [11.2.26]) ที่เครือข่ายเธรดทำงาน หรือ kThreadChannel_NotSpecified
ThreadExtendedPANId
uint8_t *
เธรดที่ขยาย PAN ID
ThreadNetworkKey
uint8_t *
คีย์เครือข่ายหลักของเธรด หรือ NULL หากไม่ได้ระบุไว้
ThreadNetworkName
char *
ชื่อของเครือข่ายเธรด หรือ NULL หากไม่ได้ระบุ
ThreadPANId
uint32_t
PAN ID ของเธรด 16 บิต หรือ kThreadPANId_NotSpecified
ThreadPSKc
uint8_t *
เธรดคีย์ที่แชร์ล่วงหน้าสำหรับคอมมิชชัน หรือ NULL หากไม่ได้ระบุไว้
WiFiKey
uint8_t *
คีย์ WiFi หรือ NULL หากไม่ได้ระบุไว้
WiFiKeyLen
uint32_t
ความยาวเป็นไบต์ของคีย์ WiFi
WiFiMode
โหมดการทำงานของเครือข่าย WiFi
WiFiRole
บทบาทของอุปกรณ์ในเครือข่าย WiFi
WiFiSSID
char *
WiFi SSID หรือ NULL หากไม่ได้ระบุไว้
WiFiSecurityType
ประเภทการรักษาความปลอดภัย WiFi
WirelessSignalStrength
int16_t
ความแรงของสัญญาณเครือข่าย หรือ INT16_MIN หากไม่มี/ใช้ได้

งานสาธารณะ

Clear (void)
void
รีเซ็ตเป็นค่าเริ่มต้นและฟรีค่าทั้งหมดที่อยู่ในนี้ NetworkInfo วัตถุ
CopyTo ( NetworkInfo & dest)
แทนที่เนื้อหาของเรื่องนี้ NetworkInfo วัตถุที่มีสำเนาลึกของเนื้อหาของการโต้แย้ง
Decode (nl::Weave::TLV::TLVReader & reader)
deserialize เนื้อหานี้ NetworkInfo วัตถุจากของ TLV ตัวแทน
Encode (nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const
อันดับเนื้อหาของเรื่องนี้ NetworkInfo วัตถุเป็นของ TLV ตัวแทน
MergeTo ( NetworkInfo & dest)
รวมเนื้อหาของเรื่องนี้ NetworkInfo วัตถุที่มีสำเนาลึกของเนื้อหาของการโต้แย้ง

ฟังก์ชั่นคงที่สาธารณะ Public

DecodeList (nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)
deserialize รายการ NetworkInfo องค์ประกอบจากของ TLV ตัวแทน
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)
อันดับอาร์เรย์ของ NetworkInfo วัตถุเป็นของ TLV ตัวแทน
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, :: nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount)
อันดับอาร์เรย์ของ NetworkInfo วัตถุเป็นของ TLV ตัวแทนเลือกเฉพาะเครือข่ายประเภทที่เฉพาะเจาะจง

ประเภทสาธารณะ

@210

 @210

@211

 @211

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

ซ่อนเร้น

bool Hidden

ไม่ว่าเครือข่ายจะถูกซ่อนหรือไม่

รหัสเครือข่าย

int64_t NetworkId

รหัสเครือข่ายที่กำหนดให้กับเครือข่ายโดยอุปกรณ์ -1 ถ้าไม่ได้ระบุ

ประเภทเครือข่าย

::nl::Weave::Profiles::NetworkProvisioning::NetworkType NetworkType

ประเภทของเครือข่าย

ThreadChannel

uint8_t ThreadChannel

ช่องสัญญาณปัจจุบัน (ปัจจุบัน [11.2.26]) ที่เครือข่ายเธรดทำงาน หรือ kThreadChannel_NotSpecified

กระทู้ExtendedPANId

uint8_t * ThreadExtendedPANId

เธรดที่ขยาย PAN ID

เป็นอาร์เรย์ที่จัดสรรแบบไดนามิกของ 8 octects ซึ่งเป็นเจ้าของโดยคลาส ทำลายบนเงื่อนไขใด ๆ ที่เรียกร้อง Clear() บนวัตถุ

ThreadNetworkKey

uint8_t * ThreadNetworkKey

คีย์เครือข่ายหลักของเธรด หรือ NULL หากไม่ได้ระบุไว้

มันเป็นอาร์เรย์จัดสรรแบบไดนามิกของ octets โดยพลการเป็นเจ้าของโดยชั้นถูกทำลายในสภาพใด ๆ ที่เรียกร้อง Clear() บนวัตถุ

ThreadNetworkName

char * ThreadNetworkName

ชื่อของเครือข่ายเธรด หรือ NULL หากไม่ได้ระบุ

เป็นสตริง C ที่สิ้นสุดด้วย NUL ที่จัดสรรแบบไดนามิก ซึ่งเป็นเจ้าของโดยคลาส ทำลายบนเงื่อนไขใด ๆ ที่เรียกร้อง Clear() บนวัตถุ

กระทู้PANId

uint32_t ThreadPANId

PAN ID ของเธรด 16 บิต หรือ kThreadPANId_NotSpecified

กระทู้PSKc

uint8_t * ThreadPSKc

เธรดคีย์ที่แชร์ล่วงหน้าสำหรับคอมมิชชัน หรือ NULL หากไม่ได้ระบุไว้

มันเป็นอาร์เรย์จัดสรรแบบไดนามิกของ octets โดยพลการเป็นเจ้าของโดยชั้นถูกทำลายในสภาพใด ๆ ที่เรียกร้อง Clear() บนวัตถุ

WiFiKey

uint8_t * WiFiKey

คีย์ WiFi หรือ NULL หากไม่ได้ระบุไว้

มันเป็นอาร์เรย์จัดสรรแบบไดนามิกของ octets โดยพลการเป็นเจ้าของโดยชั้นที่มีความยาวตามที่ระบุไว้ WiFiKeyLen ทำลายบนเงื่อนไขใด ๆ ที่เรียกร้อง Clear() บนวัตถุ

WiFiKeyLen

uint32_t WiFiKeyLen

ความยาวเป็นไบต์ของคีย์ WiFi

โหมด WiFi

::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode

โหมดการทำงานของเครือข่าย WiFi

บทบาท WiFi

::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole

บทบาทของอุปกรณ์ในเครือข่าย WiFi

WiFiSSID

char * WiFiSSID

WiFi SSID หรือ NULL หากไม่ได้ระบุ

เป็นสตริง C ที่สิ้นสุดด้วย NUL ที่จัดสรรแบบไดนามิก ซึ่งเป็นเจ้าของโดยคลาส ทำลายบนเงื่อนไขใด ๆ ที่เรียกร้อง Clear() บนวัตถุ

WiFiSecurityType

::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType

ประเภทการรักษาความปลอดภัย WiFi

ความแรงของสัญญาณไร้สาย

int16_t WirelessSignalStrength

ความแรงของสัญญาณเครือข่าย หรือ INT16_MIN หากไม่มี/ใช้ได้

งานสาธารณะ

ชัดเจน

void Clear(
  void
)

รีเซ็ตเป็นค่าเริ่มต้นและฟรีค่าทั้งหมดที่อยู่ในนี้ NetworkInfo วัตถุ

CopyTo

WEAVE_ERROR CopyTo(
  NetworkInfo & dest
)

แทนที่เนื้อหาของเรื่องนี้ NetworkInfo วัตถุที่มีสำเนาลึกของเนื้อหาของการโต้แย้ง

รายละเอียด
พารามิเตอร์
[in] dest
NetworkInfo วัตถุที่มีข้อมูลที่จะถูกคัดลอกลงในวัตถุนี้
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
WEAVE_ERROR_NOT_IMPLEMENTED
เมื่อแพลตฟอร์มไม่รองรับ malloc หรือฟรี
WEAVE_ERROR_NO_MEMORY
เกี่ยวกับความล้มเหลวในการจัดสรรหน่วยความจำ

ถอดรหัส

WEAVE_ERROR Decode(
  nl::Weave::TLV::TLVReader & reader
)

deserialize เนื้อหานี้ NetworkInfo วัตถุจากของ TLV ตัวแทน

รายละเอียด
พารามิเตอร์
[in] reader
TLVReader อยู่ในตำแหน่งองค์ประกอบโครงสร้างที่มีข้อมูลเครือข่าย
คืนสินค้า
WEAVE_NO_ERROR ในความสำเร็จ WEAVE_ERROR_INVALID_TLV_ELEMENT ในองค์ประกอบใด ๆ ที่ไม่สอดคล้องกับเครือข่ายรายละเอียดใด ๆ ของการจัดเตรียม TLV ข้อผิดพลาดในการถอดรหัสอ่านไม่ถูกต้องขององค์ประกอบ

เข้ารหัส

WEAVE_ERROR Encode(
  nl::Weave::TLV::TLVWriter & writer,
  uint8_t encodeFlags
) const 

อันดับเนื้อหาของเรื่องนี้ NetworkInfo วัตถุเป็นของ TLV ตัวแทน

รายละเอียด
พารามิเตอร์
[in] writer
TLVWriter อยู่ในตำแหน่งที่อ็อบเจ็กต์จะถูกจัดลำดับ ฟังก์ชันจะปล่อยแท็กที่ไม่ระบุชื่อสำหรับวัตถุนี้เมื่อวัตถุนี้เป็นส่วนหนึ่งของอาร์เรย์ขององค์ประกอบหรือแท็กโปรไฟล์สำหรับ kTag_NetworkInformation เมื่อปล่อยออกมาเป็นองค์ประกอบแบบสแตนด์อโลน
[in] encodeFlags
ธงควบคุมไม่ว่าจะเป็นข้อมูลประจำตัวของ NetworkInfo ควรจะต่อเนื่องกัน
คืนสินค้า
WEAVE_NO_ERROR ในความสำเร็จ WEAVE_ERROR_INVALID_TLV_ELEMENT ในองค์ประกอบใด ๆ ที่ไม่สอดคล้องกับเครือข่ายรายละเอียดใด ๆ ของการจัดเตรียม TLV ข้อผิดพลาดในการถอดรหัสอ่านไม่ถูกต้องขององค์ประกอบ

MergeTo

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

รวมเนื้อหาของเรื่องนี้ NetworkInfo วัตถุที่มีสำเนาลึกของเนื้อหาของการโต้แย้ง

ค่าที่ไม่ใช่ค่าเริ่มต้นทั้งหมดจากวัตถุอาร์กิวเมนต์จะแทนที่ค่าในวัตถุนี้

รายละเอียด
พารามิเตอร์
[in] dest
NetworkInfo วัตถุที่มีข้อมูลที่จะถูกคัดลอกลงในวัตถุนี้
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
WEAVE_ERROR_NOT_IMPLEMENTED
เมื่อแพลตฟอร์มไม่รองรับ malloc หรือฟรี
WEAVE_ERROR_NO_MEMORY
เกี่ยวกับความล้มเหลวในการจัดสรรหน่วยความจำ

ข้อมูลเครือข่าย

 NetworkInfo()

~ข้อมูลเครือข่าย

 ~NetworkInfo()

ฟังก์ชั่นคงที่สาธารณะ Public

ถอดรหัสรายการ

WEAVE_ERROR DecodeList(
  nl::Weave::TLV::TLVReader & reader,
  uint16_t & elemCount,
  NetworkInfo *& elemArray
)

deserialize รายการ NetworkInfo องค์ประกอบจากของ TLV ตัวแทน

รายละเอียด
พารามิเตอร์
[in] reader
TLVReader อยู่ที่จุดเริ่มต้นอาร์เรย์ เมื่อส่งคืนได้สำเร็จ ผู้เขียนจะอยู่หลังส่วนท้ายของอาร์เรย์
[in,out] elemCount
เมื่อป้อนข้อมูล จำนวนองค์ประกอบสูงสุดที่จะดีซีเรียลไลซ์จาก TLVReader ที่เอาต์พุต จำนวนขององค์ประกอบถูกดีซีเรียลจากสตรีมจริงๆ
[in,out] elemArray
การอ้างอิงไปยังอาร์เรย์ของ NetworkInfo องค์ประกอบที่จะมี deserialized NetworkInfo วัตถุ เมื่ออาร์เรย์เป็น NULL จะมีการจัดสรรภายในโดยฟังก์ชันด้านล่าง มิฉะนั้น จะถือว่าอาร์เรย์ที่จัดสรรภายนอกมีอย่างน้อย elemCount ออบเจ็กต์
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
WEAVE_ERROR_NOT_IMPLEMENTED
บนแพลตฟอร์มที่ไม่รองรับการจัดการหน่วยความจำแบบไดนามิก
other
ข้อผิดพลาดกลับมาจาก Decode() ฟังก์ชั่น

EncodeList

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t elemCount,
  const NetworkInfo *elemArray,
  uint8_t encodeFlags
)

อันดับอาร์เรย์ของ NetworkInfo วัตถุเป็นของ TLV ตัวแทน

อาร์เรย์จะเป็นองค์ประกอบที่ไม่ระบุชื่อใน TLV ตัวแทน

รายละเอียด
พารามิเตอร์
[in] writer
TLVWriter อยู่ในตำแหน่งที่เหมาะสม
[in] elemCount
จำนวนขององค์ประกอบใน elemArray
[in] elemArray
อาร์เรย์ของ NetworkInfo วัตถุต่อเนื่อง
[in] encodeFlags
ธงควบคุมไม่ว่าจะเป็นข้อมูลประจำตัวของ NetworkInfo ควรจะต่อเนื่องกัน
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
Other
ข้อผิดพลาดกลับมาจาก Encode() ฟังก์ชั่น

EncodeList

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t arrayLen,
  const NetworkInfo *elemArray,
  ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType,
  uint8_t encodeFlags,
  uint16_t & encodedElemCount
)

อันดับอาร์เรย์ของ NetworkInfo วัตถุเป็นของ TLV ตัวแทนเลือกเฉพาะเครือข่ายประเภทที่เฉพาะเจาะจง

รายละเอียด
พารามิเตอร์
[in] writer
TLVWriter อยู่ในตำแหน่งที่เหมาะสม
[in] arrayLen
จำนวนขององค์ประกอบใน elemArray
[in] elemArray
อาร์เรย์ของ NetworkInfo วัตถุต่อเนื่อง
[in] networkType
ประเภทของ NetworkInfo วัตถุอันดับ
[in] encodeFlags
ธงควบคุมไม่ว่าจะเป็นข้อมูลประจำตัวของ NetworkInfo ควรจะต่อเนื่องกัน
[out] encodedElemCount
จำนวนองค์ประกอบที่เรียงลำดับตามจริง
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
Other
ข้อผิดพลาดกลับมาจาก Encode() ฟังก์ชั่น