nl::Weave::HostPortList

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

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

סיכום

בנייה

HostPortList(void)
constructor של ברירת מחדל לסיווג (מבוטל).
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
)

constructor של ברירת מחדל לסיווג (מבוטל).

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