nl::Weave::TLV::TLVReader

获取当前字节或 UTF8 字符串元素的值。

要确定所需的输入缓冲区空间，请先调用 GetLength() 方法，然后再调用 GetBytes()。

返回 TLVReader 当前从中读取数据的容器类型。

GetContainerType() 方法会返回 TLVReader 从中读取数据的 TLV 容器的类型。如果 TLVReader 位于 TLV 编码的最外层（即最外层 TLV 元素之前、之后或之后），该方法将返回 kTLVType_NotSpecified。

返回与当前 TLV 元素关联的控制字节。

理想情况下，没有人需要了解控制字节，只有 TLV 的内部实现可以访问控制字节。不过，TLV调试实用程序（在美化输出 TLV 缓冲区内容时会尝试解码标记控制字节），访问控制字节对调试目的很有帮助。

获取指向 TLV 字节或 UTF8 字符串元素的初始编码字节的指针。

此方法会返回一个直接指针，该指针指向底层输入缓冲区中的编码字符串值。要成功，该方法要求整个字符串值都存在于单个缓冲区中。否则，该方法会返回 WEAVE_ERROR_TLV_UNDERRUN。这样，在从多个不连续的缓冲区读取数据时，该方法的使用就会受到限制。

返回与当前 TLV 元素关联的数据长度。

数据长度仅适用于 UTF8 字符串或字节字符串类型的元素。对于 UTF8 字符串，返回的值是字符串中的字节数，而不是字符数。

返回自读取器初始化以来读取的总字节数。

获取底层输入缓冲区中对应于读取器当前位置的点。

返回在达到读取长度上限之前可以读取的总字节数。

获取当前字节或 UTF8 字符串元素的值（以 null 终止的字符串形式）。

要确定所需的输入缓冲区大小，请先调用 GetLength() 方法，然后再调用 GetBytes()。输入缓冲区至少应比字符串长度大一个字节，才能容纳 null 字符。

返回与当前 TLV 元素关联的代码。

GetTag() 返回的值可与标签实用函数（IsProfileTag()、IsContextTag()、ProfileIdFromTag() 等）结合使用，以便确定标签类型并提取各种标签字段值。

返回当前 TLV 元素的类型。

从其他 TLVReader 对象初始化 TLVReader 对象。

初始化要从单个输入缓冲区读取数据的 TLVReader 对象。

初始化 TLVReader 对象，以便从单个 PacketBuffer 中读取数据。

解析从缓冲区的起始位置 (buf->DataStart()) 开始，并一直持续到缓冲区中数据的末尾（如 buf->Datalen() 所示），或 maxLen 字节解析完毕。

初始化 TLVReader 对象，以从一个或多个 PacketBuffer 读取数据。

解析从初始缓冲区的起始位置 (buf->DataStart()) 开始。如果 allowDiscontiguousBuffers 为 true，读取器将遍历由其 Next() 指针关联的缓冲区链。一直解析，直到缓冲区链中的所有数据都已使用（用 buf->Datalen() 表示），或 maxLen 字节已解析完成。

将 TLVReader 对象前进到下一个要读取的 TLV 元素。

Next() 方法会将 Reader 对象放置在 TLV 编码中位于同一包含上下文的下一个元素上。特别是，如果读取器位于 TLV 编码的最外层，调用 Next() 会使读取器转到下一个最顶层的元素。如果读取器位于 TLV 容器元素（结构、数组或路径）内，调用 Next() 会使读取器转到容器的下一个成员元素。

由于 Next() 会将读者移动限制到当前的包含上下文，因此当读取器位于容器元素上时，调用 Next() 将跳过该容器，跳过该容器的成员元素（以及任何嵌套容器的成员），直到到达容器后的第一个元素。

当特定包含上下文中没有其他元素时，Next() 方法将返回 WEAVE_END_OF_TLV 错误，并且读取器的位置将保持不变。

将 TLVReader 对象推进到要读取的下一个 TLV 元素，并断言新元素的类型和标记。

Next(TLVTypeexpectedType, uint64_texpectedTag) 方法是一种便捷方法，其行为与 Next() 相同，但也会验证新 TLV 元素的类型和标记是否与所提供的参数匹配。

初始化新的 TLVReader 对象，用于读取 TLV 容器元素的成员。

OpenContainer() 方法会初始化一个新的 TLVReader 对象，用于读取 TLV 容器的成员元素（结构、数组或路径）。调用 OpenContainer() 时，必须将当前的 TLVReader 对象放置在要读取的容器元素上。该方法将对将被初始化为读取容器的新读取器的引用作为其唯一参数。此读取器称为“容器读取器”，而调用 OpenContainer() 的读取器称为“父级读取器”。

当 OpenContainer() 方法返回时，容器读取器会紧邻容器的第一个成员之前。对容器读取器调用 Next() 将遍历集合的各个成员，直到到达末尾，此时读取器将返回 WEAVE_END_OF_TLV。

当容器读取器处于打开状态时，应用不得调用或以其他方式更改父级读取器的状态。当应用使用完容器读取器后，应用必须通过对父级读取器调用 CloseContainer() 并传递容器读取器作为参数来将其关闭。应用可以随时关闭容器读取器，无论是否读取底层容器中的所有元素。容器读取器关闭后，应用可以继续使用父级读取器。

容器读取器会从父级读取器继承各种配置属性。它们是：

• 隐式个人资料 ID (ImplicitProfileId)
• 应用数据指针 (AppData)
• GetNextBuffer 函数指针

将 TLVReader 对象移到当前 TLV 元素之后，且紧邻该元素。

Skip() 方法将读取器对象放置在当前 TLV 元素之后紧跟着的位置，这样一来，在后续调用 Next() 时，读者便可以跳转到下一个元素。与 Next() 一样，如果读取器在调用时位于某个容器元素上，则会跳过该容器的成员。如果读取器未放置在任何元素上，则其位置将保持不变。

验证 TVLReader 对象是否位于 TLV 容器的末尾。

VerifyEndOfContainer() 方法可验证当前 TLV 容器中没有其他 TLV 元素可供读取。该方法非常便捷，等同于调用 Next() 并检查返回值是否为 WEAVE_END_OF_TLV。

清除 TLVReader 的状态。

此方法用于将读取器放置在第一个 TLV 之前、TLV 之间或最后一个 TLV 之后。

这是一种从 mControlByte 返回 TLVElementType 的私有方法。

GetElementHeadLength

WEAVE_ERROR GetElementHeadLength(
  uint8_t & elemHeadBytes
) const 

IsContainerOpen

bool IsContainerOpen(
  void
) const 

WEAVE_ERROR ReadData(
  uint8_t *buf,
  uint32_t len
)

WEAVE_ERROR ReadElement(
  void
)

uint64_t ReadTag(
  TLVTagControl tagControl,
  const uint8_t *& p
)

void SetContainerOpen(
  bool aContainerOpen
)

WEAVE_ERROR SkipData(
  void
)

WEAVE_ERROR SkipToEndOfContainer(
  void
)

WEAVE_ERROR VerifyElement(
  void
)

WEAVE_ERROR FailGetNextBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)

WEAVE_ERROR GetNextPacketBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)