Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

nl::Weave::HostPortList

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

ホストポート リストの管理と操作を行うには、Weave Service Directory に関連付けられたホストとポートの ID タプルのコンパクトなバイナリ エンコード コレクションです。

まとめ

コンストラクタとデストラクタ

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
)

リストを空にリセットします。

Get

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