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

Это пространство имен включает в себя типы и служебные интерфейсы для управления и работы с Weave TLV .

Краткое содержание

Определения типов

IterateHandler )(const TLVReader &aReader, size_t aDepth, void *aContext) определение типа

Функции

Count (const TLVReader & aReader, size_t & aCount)
Подсчитайте количество элементов TLV в указанном средстве чтения TLV , упорядочивая их по массивам или структурам.
Count (const TLVReader & aReader, size_t & aCount, const bool aRecurse)
Подсчитайте количество элементов TLV в указанном средстве чтения TLV , при необходимости уменьшив их до массивов или структур.
CountHandler (const TLVReader & aReader, size_t aDepth, void *aContext)
Увеличивайте счетчик при проходе по данным TLV .
Find (const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
Найдите указанный тег в предоставленном средстве чтения TLV .
Find (const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
Найдите указанный тег в предоставленном средстве чтения TLV , при необходимости спустившись к массивам или структурам.
Find (const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
Найдите первый элемент, соответствующий предикату, в средстве чтения TLV , спускающемся в массивы или структуры.
Find (const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
Найдите первый элемент, соответствующий предикату, в средстве чтения TLV , при необходимости спускаясь в массивы или структуры.
FindHandler (const TLVReader & aReader, size_t aDepth, void *aContext)
Найдите указанный тег в предоставленном средстве чтения TLV .
FindPredicateHandler (const TLVReader & aReader, size_t aDepth, void *aContext)
Iterate ( TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)
Перебирайте данные TLV , на которые ссылается aReader, и вызывайте aHandler для каждого посещенного элемента TLV в контексте aContext .
Iterate (const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Перебирайте данные TLV , на которые ссылается aReader, и вызывайте aHandler для каждого посещенного элемента TLV в контексте aContext .
Iterate (const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Перебирайте данные TLV , на которые ссылается aReader, и вызывайте aHandler для каждого посещенного элемента TLV в контексте aContext .

Структуры

nl:: Weave:: TLV:: Утилиты:: FindContext
nl:: Weave:: TLV:: Utilities:: FindPredicateContext

Определения типов

ИтерироватьОбработчик 

WEAVE_ERROR(* IterateHandler)(const TLVReader &aReader, size_t aDepth, void *aContext)

Функции

Считать 

WEAVE_ERROR Count(
  const TLVReader & aReader,
  size_t & aCount
)

Подсчитайте количество элементов TLV в указанном средстве чтения TLV , упорядочивая их по массивам или структурам.

Подробности
Параметры
[in] aReader
Доступная только для чтения ссылка на средство чтения TLV , для которого подсчитывается количество элементов TLV .
[in,out] aCount
Ссылка на хранилище для возвращенного счетчика. Перед подсчетом оно инициализируется нулем (0) и устанавливается равным количеству элементов, подсчитанных в случае успеха.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.

Считать 

WEAVE_ERROR Count(
  const TLVReader & aReader,
  size_t & aCount,
  const bool aRecurse
)

Подсчитайте количество элементов TLV в указанном средстве чтения TLV , при необходимости уменьшив их до массивов или структур.

Подробности
Параметры
[in] aReader
Доступная только для чтения ссылка на средство чтения TLV , для которого подсчитывается количество элементов TLV .
[in,out] aCount
Ссылка на хранилище для возвращенного счетчика. Перед подсчетом оно инициализируется нулем (0) и устанавливается равным количеству элементов, подсчитанных в случае успеха.
[in] aRecurse
Логическое значение, указывающее, следует ли (true) или нет (false) спускаться к любым встреченным массивам или структурам.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.

Графхэндлер 

WEAVE_ERROR CountHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

Увеличивайте счетчик при проходе по данным TLV .

Подробности
Параметры
[in] aReader
Ссылка на средство чтения TLV , содержащее данные TLV для подсчета количества элементов TLV .
[in] aDepth
Текущая глубина данных TLV .
[in,out] aContext
Указатель на контекст, специфичный для обработчика, который является указателем на хранилище значения счетчика.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
WEAVE_ERROR_INVALID_ARGUMENT
Если aContext имеет значение NULL.

Находить 

WEAVE_ERROR Find(
  const TLVReader & aReader,
  const uint64_t & aTag,
  TLVReader & aResult
)

Найдите указанный тег в предоставленном средстве чтения TLV .

Подробности
Параметры
[in] aReader
Доступная только для чтения ссылка на средство чтения TLV , в котором можно найти указанный тег.
[in] aTag
Ссылка только для чтения на тег TLV, который необходимо найти.
[out] aResult
Ссылка на хранилище для устройства чтения TLV , которое в случае успеха будет помещено в указанный тег.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Если указанный тег aTag не найден.

Находить 

WEAVE_ERROR Find(
  const TLVReader & aReader,
  const uint64_t & aTag,
  TLVReader & aResult,
  const bool aRecurse
)

Найдите указанный тег в предоставленном средстве чтения TLV , при необходимости спустившись к массивам или структурам.

Подробности
Параметры
[in] aReader
Доступная только для чтения ссылка на средство чтения TLV , в котором можно найти указанный тег.
[in] aTag
Ссылка только для чтения на тег TLV, который необходимо найти.
[out] aResult
Ссылка на хранилище для устройства чтения TLV , которое в случае успеха будет помещено в указанный тег.
[in] aRecurse
Логическое значение, указывающее, следует ли (true) или нет (false) спускаться к любым встреченным массивам или структурам.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Если указанный тег aTag не найден.

Находить 

WEAVE_ERROR Find(
  const TLVReader & aReader,
  IterateHandler aPredicate,
  void *aContext,
  TLVReader & aResult
)

Найдите первый элемент, соответствующий предикату, в средстве чтения TLV , спускающемся в массивы или структуры.

aPredicate применяется к каждому посещенному элементу TLV ; aPredicate должен возвращать WEAVE_ERROR_MAX для совпадающих элементов, WEAVE_NO_ERROR для несовпадающих элементов и любое другое значение для прекращения поиска.

Подробности
Параметры
[in] aReader
Доступная только для чтения ссылка на средство чтения TLV , в которой можно найти элемент, соответствующий предикату.
[in] aPredicate
Предикат, который будет применяться к каждому элементу TLV . Для поддержки повторного использования кода aPredicate имеет тип IterateHandler. Возвращаемое значение aPredicate управляет поиском: WEAVE_ERROR_MAX сигнализирует о том, что нужный элемент найден, WEAVE_NO_ERROR сигнализирует о том, что нужный элемент не найден, а все остальные значения сигнализируют о том, что поиск следует прекратить.
[in] aContext
Необязательный указатель на контекстные данные, предоставленные вызывающей стороной.
[out] aResult
Ссылка на хранилище для устройства чтения TLV , которое в случае успеха будет помещено в указанный тег.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Если указанный aPredicate не нашел указанный элемент

Находить 

WEAVE_ERROR Find(
  const TLVReader & aReader,
  IterateHandler aPredicate,
  void *aContext,
  TLVReader & aResult,
  const bool aRecurse
)

Найдите первый элемент, соответствующий предикату, в средстве чтения TLV , при необходимости спускаясь в массивы или структуры.

aPredicate применяется к каждому посещенному элементу TLV ; aPredicate должен возвращать WEAVE_ERROR_MAX для совпадающих элементов, WEAVE_NO_ERROR для несовпадающих элементов и любое другое значение для прекращения поиска.

Подробности
Параметры
[in] aReader
Доступная только для чтения ссылка на средство чтения TLV , в которой можно найти элемент, соответствующий предикату.
[in] aPredicate
Предикат, который будет применяться к каждому элементу TLV . Для поддержки повторного использования кода aPredicate имеет тип IterateHandler . Возвращаемое значение aPredicate управляет поиском: WEAVE_ERROR_MAX сигнализирует о том, что нужный элемент найден, WEAVE_NO_ERROR сигнализирует о том, что нужный элемент не найден, а все остальные значения сигнализируют о том, что поиск следует прекратить.
[in] aContext
Необязательный указатель на контекстные данные, предоставленные вызывающей стороной.
[out] aResult
Ссылка на хранилище для устройства чтения TLV , которое в случае успеха будет помещено в указанный тег.
[in] aRecurse
Логическое значение, указывающее, следует ли (true) или нет (false) спуститься к каким-либо встреченным массивам или структурам.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Если указанный aPredicate не нашел указанный элемент

НайтиОбработчик 

WEAVE_ERROR FindHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

Найдите указанный тег в предоставленном средстве чтения TLV .

Подробности
Параметры
[in] aReader
Доступная только для чтения ссылка на средство чтения TLV , в котором можно найти указанный тег.
[in] aDepth
Текущая глубина данных TLV .
[in,out] aContext
Указатель на контекст, специфичный для обработчика.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
WEAVE_ERROR_INVALID_ARGUMENT
Если aContext имеет значение NULL.
WEAVE_ERROR_MAX
Если указанный тег найден.

FindPredicateHandler 

WEAVE_ERROR FindPredicateHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

Итерировать 

WEAVE_ERROR Iterate(
  TLVReader & aReader,
  size_t aDepth,
  IterateHandler aHandler,
  void *aContext,
  bool aRecurse
)

Перебирайте данные TLV , на которые ссылается aReader, и вызывайте aHandler для каждого посещенного элемента TLV в контексте aContext .

Итерация прерывается, если aHandler возвращает что-либо, кроме WEAVE_NO_ERROR.

Подробности
Параметры
[in] aReader
Ссылка на средство чтения TLV , содержащее данные TLV для итерации.
[in] aDepth
Текущая глубина данных TLV .
[in] aHandler
Обратный вызов для вызова текущего посещаемого элемента TLV .
[in,out] aContext
Необязательный указатель на контекстные данные, предоставленные вызывающей стороной.
[in] aRecurse
Логическое значение, указывающее, следует ли (true) или нет (false) спускаться к любым встреченным массивам или структурам.
Возвращаемые значения
WEAVE_END_OF_TLV
При успешной итерации до конца кодировки TLV или до конца контейнера TLV .
The
последнее значение, возвращаемое aHandler , если оно отличается от WEAVE_NO_ERROR

Итерировать 

WEAVE_ERROR Iterate(
  const TLVReader & aReader,
  IterateHandler aHandler,
  void *aContext
)

Перебирайте данные TLV , на которые ссылается aReader, и вызывайте aHandler для каждого посещенного элемента TLV в контексте aContext .

Итерация прерывается, если aHandler возвращает что-либо, кроме WEAVE_NO_ERROR.

Подробности
Параметры
[in] aReader
Ссылка на средство чтения TLV , содержащее данные TLV для итерации.
[in] aHandler
Обратный вызов для вызова текущего посещаемого элемента TLV .
[in,out] aContext
Необязательный указатель на контекстные данные, предоставленные вызывающей стороной.
Возвращаемые значения
WEAVE_END_OF_TLV
При успешной итерации до конца кодировки TLV или до конца контейнера TLV .
WEAVE_ERROR_INVALID_ARGUMENT
Если aHandler имеет значение NULL.
The
последнее значение, возвращаемое aHandler , если оно отличается от WEAVE_NO_ERROR

Итерировать 

WEAVE_ERROR Iterate(
  const TLVReader & aReader,
  IterateHandler aHandler,
  void *aContext,
  const bool aRecurse
)

Перебирайте данные TLV , на которые ссылается aReader, и вызывайте aHandler для каждого посещенного элемента TLV в контексте aContext .

Итерация прерывается, если aHandler возвращает что-либо, кроме WEAVE_NO_ERROR.

Подробности
Параметры
[in] aReader
Ссылка на средство чтения TLV , содержащее данные TLV для итерации.
[in] aHandler
Обратный вызов для вызова текущего посещаемого элемента TLV .
[in,out] aContext
Необязательный указатель на контекстные данные, предоставленные вызывающей стороной.
[in] aRecurse
Логическое значение, указывающее, следует ли (true) или нет (false) спускаться к любым встреченным массивам или структурам.
Возвращаемые значения
WEAVE_END_OF_TLV
При успешной итерации до конца кодировки TLV или до конца контейнера TLV .
WEAVE_ERROR_INVALID_ARGUMENT
Если aHandler имеет значение NULL.
The
последнее значение, возвращаемое aHandler , если оно отличается от WEAVE_NO_ERROR