nl::Weave::TLV::Dienstprogramme

Dieser Namespace enthält Typen und Dienstprogrammschnittstellen für die Verwaltung und Arbeit mit Weave TLV.

Fazit

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

Funktionen
Count(const TLVReader & aReader, size_t & aCount)
Die Anzahl der TLV-Elemente im angegebenen TLV-Lesegerät werden in Arrays oder Strukturen absteigend gezählt.
Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)
zählen die Anzahl der TLV-Elemente im angegebenen TLV-Lesegerät (optional in Arrays oder Strukturen absteigend).
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Zähler bei der Iteration über die TLV-Daten erhöhen.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
Suchen Sie im angegebenen TLV-Lesegerät nach dem angegebenen Tag.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
Suchen Sie im angegebenen TLV-Reader nach dem angegebenen Tag und steigen Sie optional in Arrays oder Strukturen ab.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
Suchen Sie nach dem ersten Element, das mit dem Prädikat im TLV-Lesegerät übereinstimmt, der in Arrays oder Strukturen absteigend ist.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
Suchen Sie nach dem ersten Element, das mit dem Prädikat im TLV-Lesegerät übereinstimmt, optional in Arrays oder Strukturen.
FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Suchen Sie im angegebenen TLV-Lesegerät nach dem angegebenen Tag.
FindPredicateHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Iterate(TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)
Iterieren Sie die TLV-Daten, auf die von aReader verwiesen wird, und rufen Sie aHandler für jedes besuchte TLV-Element im Kontext von aContext auf.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Iterieren Sie die TLV-Daten, auf die von aReader verwiesen wird, und rufen Sie aHandler für jedes besuchte TLV-Element im Kontext von aContext auf.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Iterieren Sie die TLV-Daten, auf die von aReader verwiesen wird, und rufen Sie aHandler für jedes besuchte TLV-Element im Kontext von aContext auf.

Strebenklemmen
nl::Weave::TLV::Dienstprogramme:FindContext
nl::Weave::TLV::Dienstprogramme:FindPredicateContext

Typdef.

IterrateHandler

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

Funktionen

Anzahl

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

Die Anzahl der TLV-Elemente im angegebenen TLV-Lesegerät werden in Arrays oder Strukturen absteigend gezählt.

Details
Parameter
[in] aReader
Eine schreibgeschützte Referenz auf das TLV-Lesegerät, für die die Anzahl der TLV-Elemente gezählt werden soll.
[in,out] aCount
Ein Verweis auf den Speicher für die zurückgegebene Anzahl. Dieser Wert wird vor der Zählung auf null (0) gesetzt und auf die Anzahl der erfolgreich gezählten Elemente festgelegt.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.

Anzahl

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

zählen die Anzahl der TLV-Elemente im angegebenen TLV-Lesegerät (optional in Arrays oder Strukturen absteigend).

Details
Parameter
[in] aReader
Eine schreibgeschützte Referenz auf das TLV-Lesegerät, für die die Anzahl der TLV-Elemente gezählt werden soll.
[in,out] aCount
Ein Verweis auf den Speicher für die zurückgegebene Anzahl. Dieser Wert wird vor der Zählung auf null (0) gesetzt und auf die Anzahl der erfolgreich gezählten Elemente festgelegt.
[in] aRecurse
Ein boolescher Wert, der angibt, ob erkannte Arrays oder Strukturen auf „true“ (falsch) oder nicht (falsch) gesetzt werden sollen.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.

CountHandler

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

Zähler bei der Iteration über die TLV-Daten erhöhen.

Details
Parameter
[in] aReader
Ein Verweis auf das TLV-Lesegerät, das die TLV-Daten enthält, um die Anzahl der TLV-Elemente zu zählen.
[in] aDepth
Die aktuelle Tiefe in die TLV-Daten.
[in,out] aContext
Ein Zeiger auf den Handler-spezifischen Kontext, der ein Hinweis zum Speichern für den Zählwert ist.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.
WEAVE_ERROR_INVALID_ARGUMENT
Wenn aContext NULL ist.

Suchen

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

Suchen Sie im angegebenen TLV-Lesegerät nach dem angegebenen Tag.

Details
Parameter
[in] aReader
Ein schreibgeschützter Verweis auf den TLV-Reader, in dem das angegebene Tag gefunden werden soll.
[in] aTag
Ein schreibgeschützter Verweis auf das TLV-Tag, das gefunden werden soll.
[out] aResult
Ein Verweis auf den Speicher eines TLV-Lesegeräts, der bei Erfolg im angegebenen Tag positioniert wird.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Das angegebene Tag aTag wurde nicht gefunden.

Suchen

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

Suchen Sie im angegebenen TLV-Reader nach dem angegebenen Tag und steigen Sie optional in Arrays oder Strukturen ab.

Details
Parameter
[in] aReader
Ein schreibgeschützter Verweis auf den TLV-Reader, in dem das angegebene Tag gefunden werden soll.
[in] aTag
Ein schreibgeschützter Verweis auf das TLV-Tag, das gefunden werden soll.
[out] aResult
Ein Verweis auf den Speicher eines TLV-Lesegeräts, der bei Erfolg im angegebenen Tag positioniert wird.
[in] aRecurse
Ein boolescher Wert, der angibt, ob erkannte Arrays oder Strukturen auf „true“ (falsch) oder nicht (falsch) gesetzt werden sollen.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Das angegebene Tag aTag wurde nicht gefunden.

Suchen

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

Suchen Sie nach dem ersten Element, das mit dem Prädikat im TLV-Lesegerät übereinstimmt, der in Arrays oder Strukturen absteigend ist.

aPredicate wird auf jedes besuchte TLV-Element angewendet. aPredicate gibt WEAVE_ERROR_MAX für die übereinstimmenden Elemente, WEAVE_NO_ERROR für nicht übereinstimmende Elemente und jeden anderen Wert zurück, um die Suche zu beenden.

Details
Parameter
[in] aReader
Ein schreibgeschützter Verweis auf den TLV-Reader, in dem das Element gefunden werden soll, das mit dem Prädikat übereinstimmt.
[in] aPredicate
Ein Prädikat, das auf jedes TLV-Element angewendet werden soll. Um den Code wiederzuverwenden, hat aPredicate den IterateHandler-Typ. Der Wert "return" eines Steuerelements steuert die Suche: ein WEAVE_ERROR_MAXSignal, dass das gewünschte Element gefunden wurde, WEAVE_NO_ERROR dass das gewünschte Element nicht gefunden wurde, und alle anderen Werte geben an, dass es sich um einen Befehl handelt.
[in] aContext
Ein optionaler Zeiger auf vom Anrufer bereitgestellte Kontextdaten.
[out] aResult
Ein Verweis auf den Speicher eines TLV-Lesegeräts, der bei Erfolg im angegebenen Tag positioniert wird.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Wenn das angegebene aPredicate-Element das angegebene Element nicht gefunden hat

Suchen

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

Suchen Sie nach dem ersten Element, das mit dem Prädikat im TLV-Lesegerät übereinstimmt, optional in Arrays oder Strukturen.

aPredicate wird auf jedes besuchte TLV-Element angewendet. aPredicate gibt WEAVE_ERROR_MAX für die übereinstimmenden Elemente, WEAVE_NO_ERROR für nicht übereinstimmende Elemente und jeden anderen Wert zurück, um die Suche zu beenden.

Details
Parameter
[in] aReader
Ein schreibgeschützter Verweis auf den TLV-Reader, in dem das Element gefunden werden soll, das mit dem Prädikat übereinstimmt.
[in] aPredicate
Ein Prädikat, das auf jedes TLV-Element angewendet werden soll. Um den Wiederverwenden des Codes zu ermöglichen, hat APredicate den Typ IterateHandler. Der Wert "return" eines Steuerelements steuert die Suche: ein WEAVE_ERROR_MAXSignal, dass das gewünschte Element gefunden wurde, WEAVE_NO_ERROR dass das gewünschte Element nicht gefunden wurde, und alle anderen Werte geben an, dass es sich um einen Befehl handelt.
[in] aContext
Ein optionaler Zeiger auf vom Anrufer bereitgestellte Kontextdaten.
[out] aResult
Ein Verweis auf den Speicher eines TLV-Lesegeräts, der bei Erfolg im angegebenen Tag positioniert wird.
[in] aRecurse
Ein boolescher Wert, der angibt, ob vorkommende Arrays oder Strukturen auf „true“ (falsch) oder nicht (falsch) gesetzt werden sollen.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Wenn das angegebene aPredicate-Element das angegebene Element nicht gefunden hat

FindHandler

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

Suchen Sie im angegebenen TLV-Lesegerät nach dem angegebenen Tag.

Details
Parameter
[in] aReader
Ein schreibgeschützter Verweis auf den TLV-Reader, in dem das angegebene Tag gefunden werden soll.
[in] aDepth
Die aktuelle Tiefe in die TLV-Daten.
[in,out] aContext
Ein Zeiger auf den Handler-spezifischen Kontext.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.
WEAVE_ERROR_INVALID_ARGUMENT
Wenn aContext NULL ist.
WEAVE_ERROR_MAX
Wenn das angegebene Tag gefunden wird.

FindPredicateHandler

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

Iterieren

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

Iterieren Sie die TLV-Daten, auf die von aReader verwiesen wird, und rufen Sie aHandler für jedes besuchte TLV-Element im Kontext von aContext auf.

Die Iteration wird abgebrochen, wenn aHandler etwas anderes als WEAVE_NO_ERROR zurückgibt.

Details
Parameter
[in] aReader
Ein Verweis auf den TLV-Leser mit den TLV-Daten für die Iteration.
[in] aDepth
Die aktuelle Tiefe in die TLV-Daten.
[in] aHandler
Ein Callback, der für das aktuelle TLV-Element aufgerufen wird.
[in,out] aContext
Ein optionaler Zeiger auf vom Anrufer bereitgestellte Kontextdaten.
[in] aRecurse
Ein boolescher Wert, der angibt, ob erkannte Arrays oder Strukturen auf „true“ (falsch) oder nicht (falsch) gesetzt werden sollen.
Rückgabewerte
WEAVE_END_OF_TLV
Bei einer erfolgreichen Iteration zum Ende einer TLV-Codierung oder zum Ende eines TLV-Containers.
The
Letzter Wert, der von aHandler zurückgegeben wird, falls unterschiedlich als WEAVE_NO_ERROR

Iterieren

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

Iterieren Sie die TLV-Daten, auf die von aReader verwiesen wird, und rufen Sie aHandler für jedes besuchte TLV-Element im Kontext von aContext auf.

Die Iteration wird abgebrochen, wenn aHandler etwas anderes als WEAVE_NO_ERROR zurückgibt.

Details
Parameter
[in] aReader
Ein Verweis auf den TLV-Leser mit den TLV-Daten für die Iteration.
[in] aHandler
Ein Callback, der für das aktuelle TLV-Element aufgerufen wird.
[in,out] aContext
Ein optionaler Zeiger auf vom Anrufer bereitgestellte Kontextdaten.
Rückgabewerte
WEAVE_END_OF_TLV
Bei einer erfolgreichen Iteration zum Ende einer TLV-Codierung oder zum Ende eines TLV-Containers.
WEAVE_ERROR_INVALID_ARGUMENT
Wenn aHandler NULL ist.
The
Letzter Wert, der von aHandler zurückgegeben wird, falls unterschiedlich als WEAVE_NO_ERROR

Iterieren

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

Iterieren Sie die TLV-Daten, auf die von aReader verwiesen wird, und rufen Sie aHandler für jedes besuchte TLV-Element im Kontext von aContext auf.

Die Iteration wird abgebrochen, wenn aHandler etwas anderes als WEAVE_NO_ERROR zurückgibt.

Details
Parameter
[in] aReader
Ein Verweis auf den TLV-Leser mit den TLV-Daten für die Iteration.
[in] aHandler
Ein Callback, der für das aktuelle TLV-Element aufgerufen wird.
[in,out] aContext
Ein optionaler Zeiger auf vom Anrufer bereitgestellte Kontextdaten.
[in] aRecurse
Ein boolescher Wert, der angibt, ob erkannte Arrays oder Strukturen auf „true“ (falsch) oder nicht (falsch) gesetzt werden sollen.
Rückgabewerte
WEAVE_END_OF_TLV
Bei einer erfolgreichen Iteration zum Ende einer TLV-Codierung oder zum Ende eines TLV-Containers.
WEAVE_ERROR_INVALID_ARGUMENT
Wenn aHandler NULL ist.
The
Letzter Wert, der von aHandler zurückgegeben wird, falls unterschiedlich als WEAVE_NO_ERROR