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`	`WEAVE_ERROR` 指定されたインデックスのホスト名とポートをリストから取得します。
`IsEmpty(void) const`	`bool`
`Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)`	`WEAVE_ERROR` 最初のホスト名とポートを取得してリストから削除します。

void Clear(
  void
)

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

WEAVE_ERROR Get(
  uint8_t index,
  char *hostBuf,
  uint32_t hostBufSize,
  uint16_t & port
) const

指定されたインデックスのホスト名とポートをリストから取得します。

詳細

パラメータ

戻り値

`WEAVE_ERROR_INVALID_ARGUMENT`	リクエストされたインデックスがリストのサイズを超えています。
`WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT`	リクエストされたホストポート要素がサポートされていないタイプでした。
`WEAVE_ERROR_BUFFER_TOO_SMALL`	ホストポートのホスト名の長さが、指定されたバッファよりも長くなっています。
`WEAVE_NO_ERROR`	成功時。

 HostPortList(
  void
)

クラスのデフォルト（void）コンストラクタ。

 HostPortList(
  const uint8_t *hostPortList,
  uint8_t hostPortCount,
  const uint8_t *suffixList,
  const uint8_t suffixCount
)

bool IsEmpty(
  void
) const

WEAVE_ERROR Pop(
  char *hostBuf,
  uint32_t hostBufSize,
  uint16_t & port
)

最初のホスト名とポートを取得してリストから削除します。

詳細

パラメータ

戻り値

`WEAVE_ERROR_HOST_PORT_LIST_EMPTY`	このリストにはエントリがありません。
`WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT`	検出されたホストポート要素がサポートされていないタイプでした。
`WEAVE_ERROR_BUFFER_TOO_SMALL`	ホストポートのホスト名の長さが、指定されたバッファよりも長くなっています。
`WEAVE_NO_ERROR`	成功時。