нл:: Переплетение:: ТЛВ:: TLVReader

Получите значение текущего байта или строкового элемента UTF8.

Чтобы определить необходимый размер входного буфера, вызовите метод GetLength() перед вызовом GetBytes() .

Возвращает тип контейнера, внутри которого в данный момент читает TLVReader .

Метод GetContainerType() возвращает тип контейнера TLV , внутри которого читает TLVReader . Если TLVReader расположен на самом внешнем уровне кодировки TLV (т. е. до, после или после самого внешнего элемента TLV ), метод вернет kTLVType_NotSpecified.

Возвращает управляющий байт, связанный с текущим элементом TLV .

В идеале никто никогда не должен знать об управляющем байте, и доступ к нему должна иметь только внутренняя реализация TLV . Но, тем не менее, доступ к управляющему байту полезен для целей отладки с помощью утилит отладки TLV (которые пытаются декодировать управляющий байт тега при печати содержимого буфера TLV ).

Получите указатель на начальный закодированный байт байта TLV или строкового элемента UTF8.

Этот метод возвращает прямой указатель на закодированное строковое значение в базовом входном буфере. Для достижения успеха метод требует, чтобы все строковое значение присутствовало в одном буфере. В противном случае метод возвращает WEAVE_ERROR_TLV_UNDERRUN . Это делает метод ограниченным в использовании при чтении данных из нескольких несмежных буферов.

Возвращает длину данных, связанных с текущим элементом TLV .

Длина данных применяется только к элементам типа строки UTF8 или строки байтов. Для строк UTF8 возвращаемое значение — это количество байтов в строке, а не количество символов.

Возвращает общее количество байтов, прочитанных с момента инициализации средства чтения.

Получает точку в базовом входном буфере, соответствующую текущей позиции средства чтения.

Возвращает общее количество байтов, которые можно прочитать, пока не будет достигнута максимальная длина чтения.

Получите значение текущего байта или строкового элемента UTF8 в виде строки, завершающейся нулем.

Чтобы определить необходимый размер входного буфера, вызовите метод GetLength() перед вызовом GetBytes() . Входной буфер должен быть как минимум на один байт больше длины строки, чтобы вместить нулевой символ.

Возвращает тег, связанный с текущим элементом TLV .

Значение, возвращаемое GetTag(), можно использовать с служебными функциями тегов ( IsProfileTag() , IsContextTag() , ProfileIdFromTag() и т. д.) для определения типа тега и извлечения различных значений полей тега.

Возвращает тип текущего элемента TLV .

Инициализирует объект TLVReader из другого объекта TLVReader .

Инициализирует объект TLVReader для чтения из одного входного буфера.

Инициализирует объект TLVReader для чтения из одного PacketBuffer.

Анализ начинается с начальной позиции буфера (buf->DataStart()) и продолжается до тех пор, пока не закончатся данные в буфере (как обозначено buf->Datalen()) или не будут проанализированы байты maxLen.

Инициализирует объект TLVReader для чтения из одного или нескольких PacketBuffers.

Анализ начинается с начальной позиции исходного буфера (buf->DataStart()). Если параметрallowDiscontigiousBuffers имеет значение true, читатель будет продвигаться по цепочке буферов, связанных указателями Next() . Анализ продолжается до тех пор, пока все данные в цепочке буферов не будут использованы (как обозначено buf->Datalen()) или пока не будут проанализированы байты maxLen.

Перемещает объект TLVReader к следующему элементу TLV для чтения.

Метод Next() позиционирует объект чтения на следующем элементе в кодировке TLV , который находится в том же контексте включения. В частности, если средство чтения расположено на самом внешнем уровне кодировки TLV , вызов Next() переместит средство чтения к следующему, самому верхнему элементу. Если средство чтения расположено внутри элемента контейнера TLV (структуры, массива или пути), вызов Next() переместит средство чтения к следующему элементу-члену контейнера.

Поскольку Next() ограничивает движение читателя текущим контекстом содержания, вызов Next() , когда читатель располагается на элементе контейнера, будет перемещаться по контейнеру, пропуская его элементы-члены (и элементы любых вложенных контейнеров), пока не достигнет первого элемент после контейнера.

Если в определенном контексте включения больше нет элементов, метод Next() вернет ошибку WEAVE_END_OF_TLV , а позиция считывателя останется неизменной.

Перемещает объект TLVReader к следующему читаемому элементу TLV , утверждая тип и тег нового элемента.

Метод Next(TLVType ожидаемый тип, uint64_t ожидаемый тег) — это удобный метод, который имеет то же поведение, что и Next() , но также проверяет, соответствуют ли тип и тег нового элемента TLV предоставленным аргументам.

Инициализирует новый объект TLVReader для чтения членов элемента контейнера TLV .

Метод OpenContainer() инициализирует новый объект TLVReader для чтения элементов-членов контейнера TLV (структуры, массива или пути). При вызове OpenContainer() текущий объект TLVReader должен располагаться на читаемом элементе контейнера. В качестве единственного аргумента метод принимает ссылку на новую программу чтения, которая будет инициализирована для чтения контейнера. Это средство чтения называется средством чтения контейнера , а средство чтения, в котором вызывается OpenContainer(), называется родительским средством чтения .

Когда метод OpenContainer() возвращает значение, средство чтения контейнера располагается непосредственно перед первым элементом контейнера. Вызов Next() в средстве чтения контейнера будет перемещаться по элементам коллекции до тех пор, пока не будет достигнут конец, после чего средство чтения вернет WEAVE_END_OF_TLV.

Пока средство чтения контейнера открыто, приложения не должны выполнять вызовы или иным образом изменять состояние родительского средства чтения. Как только приложение завершило использование средства чтения контейнера, оно должно закрыть его, вызвав CloseContainer() для родительского средства чтения, передав средство чтения контейнера в качестве аргумента. Приложения могут закрыть средство чтения контейнера в любой момент, прочитав или не прочитав все элементы, содержащиеся в базовом контейнере. После закрытия средства чтения контейнера приложения могут продолжать использовать родительское средство чтения.

Средство чтения контейнера наследует различные свойства конфигурации от родительского средства чтения. Это:

• Неявный идентификатор профиля (ImplicitProfileId).
• Указатель данных приложения (AppData)
• Указатель функции GetNextBuffer

Перемещает объект TLVReader сразу после текущего элемента TLV .

Метод Skip() размещает объект чтения сразу после текущего элемента TLV , так что последующий вызов Next() переместит средство чтения к следующему элементу. Как и в случае с Next() , если во время вызова средство чтения находится на элементе контейнера, члены контейнера будут пропущены. Если средство чтения не позиционировано ни на каком элементе, его положение остается неизменным.

Проверяет, что объект TVLreader находится в конце контейнера TLV .

Метод VerifyEndOfContainer () проверяет, что в текущем контейнере TLV нет дополнительных элементов TLV . Это удобный метод, который эквивалентен вызову next () и проверки возврата значения Weave_end_of_tlv.

Очистить состояние TLVreader .

Этот метод используется для размещения читателя перед первым TLV , между TLV или после последнего TLV .

Это частный метод, который возвращает tlvementtype из Mcontrolbyte.

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
)