nl:: بافت:: HostPortList

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

برای مدیریت و دستکاری فهرست پورت میزبان، مجموعه ای فشرده و کدگذاری شده باینری از تاپل های شناسه میزبان و پورت مرتبط با فهرست خدمات Weave.

خلاصه

سازندگان و ویرانگرها

HostPortList (void)
سازنده پیش فرض کلاس (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
عنصر Host Port درخواست شده یک نوع پشتیبانی نشده بود.
WEAVE_ERROR_BUFFER_TOO_SMALL
طول نام میزبان پورت میزبان بیشتر از بافر ارائه شده است.
WEAVE_NO_ERROR
در مورد موفقیت

HostPortList

 HostPortList(
  void
)

سازنده پیش فرض کلاس (void).

HostPortList

 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
عنصر Host Port که با آن مواجه شد یک نوع پشتیبانی نشده بود.
WEAVE_ERROR_BUFFER_TOO_SMALL
طول نام میزبان پورت میزبان بیشتر از بافر ارائه شده است.
WEAVE_NO_ERROR
در مورد موفقیت