nl::Weave::HostPortList

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

لإدارة ومعالجة قائمة منفذ المضيف، هي مجموعة صغيرة ذات ترميز ثنائي تكون مضيفات معرّفات المضيف والمنافذ المرتبطة بدليل Weave Service.

الملخّص

الماكينات والبناء
`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`	النجاح.