nl::Weave::HostPortList

#include <src/lib/core/HostPortList.h>

สําหรับการจัดการและแทรกแซงรายการโฮสต์ของโฮสต์ คอลเล็กชันของโฮสต์และตัวระบุพอร์ตขนาดกะทัดรัดที่เข้ารหัสแบบไบนารีซึ่งเชื่อมโยงกับ Weave Service Directory

สรุป

เครื่องมือสร้างและตัวสร้าง
HostPortList(void)
เครื่องมือสร้างค่าเริ่มต้น (ว่าง)
HostPortList(const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

ฟังก์ชันสาธารณะ
Clear(void)
void
รีเซ็ตรายการว่างเปล่า
Get(uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
รับชื่อโฮสต์และพอร์ตที่ดัชนีที่ระบุจากรายการ
IsEmpty(void) const
bool
Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)
รับและนําชื่อโฮสต์และพอร์ตแรกออกจากรายการ

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

ล้าง

void Clear(
  void
)

รีเซ็ตรายการว่างเปล่า

ดาวน์โหลด

WEAVE_ERROR Get(
  uint8_t index,
  char *hostBuf,
  uint32_t hostBufSize,
  uint16_t & port
) const

รับชื่อโฮสต์และพอร์ตที่ดัชนีที่ระบุจากรายการ

รายละเอียด
พารามิเตอร์
[in] index
ตําแหน่งในรายการเพื่อแสดงชื่อโฮสต์และพอร์ต
[in,out] hostBuf
ตัวชี้ไปยังพื้นที่เก็บข้อมูลที่จะคัดลอกชื่อโฮสต์
[in] hostBufSize
ปริมาณพื้นที่เก็บข้อมูลที่ใช้ได้ใน hostBuf
[out] port
หมายเลขพอร์ต
แสดงผลค่า
WEAVE_ERROR_INVALID_ARGUMENT
ดัชนีที่ขอเกินขนาดของรายการ
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
องค์ประกอบพอร์ตโฮสต์ที่ขอเป็นประเภทที่ไม่รองรับ
WEAVE_ERROR_BUFFER_TOO_SMALL
ความยาวของชื่อโฮสต์โฮสต์โฮสต์นานกว่าบัฟเฟอร์ที่ระบุ
WEAVE_NO_ERROR
สําเร็จแล้ว

รายการโฮสต์

 HostPortList(
  void
)

เครื่องมือสร้างค่าเริ่มต้น (ว่าง)

รายการโฮสต์

 HostPortList(
  const uint8_t *hostPortList,
  uint8_t hostPortCount,
  const uint8_t *suffixList,
  const uint8_t suffixCount
)

ว่างเปล่า

bool IsEmpty(
  void
) const

ป๊อป

WEAVE_ERROR Pop(
  char *hostBuf,
  uint32_t hostBufSize,
  uint16_t & port
)

รับและนําชื่อโฮสต์และพอร์ตแรกออกจากรายการ

รายละเอียด
พารามิเตอร์
[in,out] hostBuf
ตัวชี้ไปยังพื้นที่เก็บข้อมูลที่จะคัดลอกชื่อโฮสต์
[in] hostBufSize
ปริมาณพื้นที่เก็บข้อมูลที่ใช้ได้ใน hostBuf
[out] port
หมายเลขพอร์ต
แสดงผลค่า
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
ไม่มีรายการในรายการ
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
องค์ประกอบพอร์ตโฮสต์ที่พบเป็นประเภทที่ไม่รองรับ
WEAVE_ERROR_BUFFER_TOO_SMALL
ความยาวของชื่อโฮสต์โฮสต์โฮสต์นานกว่าบัฟเฟอร์ที่ระบุ
WEAVE_NO_ERROR
สําเร็จแล้ว