nl::Weave::HostPortList

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

לניהול רשימת יציאות של מארחים ולטיפול בה, אוסף קומפקטי ומקודד בינארי של צמדי מארחים ומזהי יציאות המשויכים ל-Weave Service Directory.

סיכום

בונים והורסים

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
הרכיב המבוקש של יציאת המארח היה מסוג לא נתמך.
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
)

IsEmpty

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
בהצלחה.