Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl::Weave::Profile::DataManagement_Current::CustomCommand::Parser

#include <src/lib/profiles/data-management/Current/MessageDef.h>

Benutzerdefinierte DM-Anfragebefehlsparser-Definition.

Fazit

Übernahme

Übernimmt von: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Öffentliche Funktionen

CheckSchemaValidity(void) const
Prüfen Sie, ob die Nachricht richtig formatiert ist.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Rufen Sie die geplante Aktionszeit für diesen Befehl ab.
GetCommandType(uint64_t *const apCommandType) const
Rufen Sie die Befehlstyp-ID für diesen Befehl ab.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Sehen Sie sich die Ablaufzeit für diesen Befehl an.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Startzeit für diesen Befehl abrufen.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Rufen Sie die Must-have-Version für diesen Befehl ab.
GetPath(Path::Parser *const apPath) const
Initialisieren Sie den Befehl Path::Parser mit der Pfadkomponente in diesem Befehl.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Initialisiere einen TLVReader, der auf den Anfang der Argumentkomponente in diesem Befehl verweist.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Initialisieren Sie einen TLVReader, der auf diesen Abschnitt verweist.
Init(const nl::Weave::TLV::TLVReader & aReader)
Initialisiere das Parser-Objekt mit TLVReader.

Öffentliche Funktionen

SchemaSchemaity prüfen

WEAVE_ERROR CheckSchemaValidity(
  void
) const 

Prüfen Sie, ob die Nachricht richtig formatiert ist.

Details
Rückgabewerte
WEAVE_NO_ERROR
Erfolg

GetActionTimeMikroSekunde

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const 

Rufen Sie die geplante Aktionszeit für diesen Befehl ab.

Details
Parameter
[out] apActionTimeMicroSecond
Ein Mauszeiger auf eine Variable, um die Aktion Befehl bei Erfolg zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
Erfolg
WEAVE_END_OF_TLV
wenn es kein entsprechendes Element gibt
WEAVE_ERROR_WRONG_TLV_TYPE
Wenn es ein solches Element gibt, es aber keine signierte Ganzzahl ist

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const 

Rufen Sie die Befehlstyp-ID für diesen Befehl ab.

Details
Parameter
[out] apCommandType
Ein Verweis auf eine Variable, um bei erfolgreichem Befehl die Befehlstyp-ID zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
Erfolg
WEAVE_END_OF_TLV
wenn es kein entsprechendes Element gibt
WEAVE_ERROR_WRONG_TLV_TYPE
Wenn es ein solches Element gibt, dieses aber keine signierte Ganzzahl ist

GetExpiryTimeMicroSekunde

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const 

Sehen Sie sich die Ablaufzeit für diesen Befehl an.

Details
Parameter
[out] apExpiryTimeMicroSecond
Ein Mauszeiger auf eine Variable, um die Ablaufzeit für den Erfolg zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
Erfolg
WEAVE_END_OF_TLV
wenn es kein entsprechendes Element gibt
WEAVE_ERROR_WRONG_TLV_TYPE
Wenn es ein solches Element gibt, es aber keine signierte Ganzzahl ist

GetInitiationTimeMikrosekunde

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const 

Startzeit für diesen Befehl abrufen.

Details
Parameter
[out] apInitiationTimeMicroSecond
Ein Verweis auf eine Variable, um den Beginn des Befehls zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
Erfolg
WEAVE_END_OF_TLV
wenn es kein entsprechendes Element gibt
WEAVE_ERROR_WRONG_TLV_TYPE
Wenn es ein solches Element gibt, es aber keine signierte Ganzzahl ist

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const 

Rufen Sie die Must-have-Version für diesen Befehl ab.

Details
Parameter
[out] apMustBeVersion
Ein Hinweis auf eine Variable, die bei einem Erfolg die Must-have-Version sein soll
Rückgabewerte
WEAVE_NO_ERROR
Erfolg
WEAVE_END_OF_TLV
wenn es kein entsprechendes Element gibt
WEAVE_ERROR_WRONG_TLV_TYPE
Wenn es ein solches Element gibt, dieses aber keine signierte Ganzzahl ist

Pfad abrufen

WEAVE_ERROR GetPath(
  Path::Parser *const apPath
) const 

Initialisieren Sie den Befehl Path::Parser mit der Pfadkomponente in diesem Befehl.

Details
Parameter
[out] apPath
Ein Verweis auf einen Path::Parser, der bei Erfolg mit der eingebetteten Pfadkomponente initialisiert wird
Rückgabewerte
WEAVE_NO_ERROR
Erfolg
WEAVE_END_OF_TLV
wenn es kein entsprechendes Element gibt
WEAVE_ERROR_WRONG_TLV_TYPE
wenn es ein solches Element gibt, es aber kein Path ist

GetReaderOnArgument

WEAVE_ERROR GetReaderOnArgument(
  nl::Weave::TLV::TLVReader *const apReader
) const 

Initialisiere einen TLVReader, der auf den Anfang der Argumentkomponente in diesem Befehl verweist.

Details
Parameter
[out] apReader
Ein Zeiger auf TLVReader, der bei Erfolg über das Argument TLV initialisiert wird
Rückgabewerte
WEAVE_NO_ERROR
Erfolg

GetReaderOnPath

WEAVE_ERROR GetReaderOnPath(
  nl::Weave::TLV::TLVReader *const apReader
) const 

Initialisieren Sie einen TLVReader, der auf diesen Abschnitt verweist.

Details
Parameter
[out] apReader
Ein Zeiger auf TLVReader, der bei Erfolg über das Argument TLV initialisiert wird
Rückgabewerte
WEAVE_NO_ERROR
Erfolg

Init

WEAVE_ERROR Init(
  const nl::Weave::TLV::TLVReader & aReader
)

Initialisiere das Parser-Objekt mit TLVReader.

Details
Parameter
[in] aReader
Ein Zeiger auf einen TLVReader, der auf den Anfang dieser Anfrage verweisen soll
Rückgabewerte
WEAVE_NO_ERROR
Erfolg