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
成功时。