หน้านี้ได้รับการแปลโดย Cloud Translation API

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`	`WEAVE_ERROR` รับชื่อโฮสต์และพอร์ตที่ดัชนีที่ระบุจากรายการ
`IsEmpty(void) const`	`bool`
`Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)`	`WEAVE_ERROR` รับและนำชื่อโฮสต์และพอร์ตแรกออกจากรายการ

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`	สำเร็จแล้ว