nl::Weave::HostPortList

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

用於管理及操控主機通訊埠清單,這是與 Weave Service Directory 相關聯的精簡且採用二進位編碼的主機和通訊埠 ID 組合。

摘要

建構函式和解構函式

HostPortList(void)
類別 default (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
)

類別 default (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
成功時。