nl::Weave::Profiles::DataManagement_Current::CustomCommand::Parser

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

Parserdefinition für benutzerdefinierte WDM-Befehls.

Zusammenfassung

Übernahme

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

Öffentliche Funktionen
CheckSchemaValidity(void) const
Überprüfen Sie grob, ob die Nachricht das richtige Format hat.
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
Rufen Sie die Ablaufzeit für diesen Befehl ab.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Rufen Sie die Initiierungszeit für diesen Befehl ab.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Rufen Sie die unverzichtbare Version für diesen Befehl ab.
GetPath(Path::Parser *const apPath) const
Initialisieren Sie einen Path::Parser mit der Pfadkomponente in diesem Befehl.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Initialisieren Sie 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 in diesem Befehl auf den Anfang der Pfadkomponente verweist.
Init(const nl::Weave::TLV::TLVReader & aReader)
Initialisieren Sie das Parserobjekt mit TLVReader.

Öffentliche Funktionen

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Überprüfen Sie grob, ob die Nachricht das richtige Format hat.

Details
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

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

Details
Parameter
[out] apActionTimeMicroSecond
Ein Verweis auf eine Variable, um bei Erfolg die Aktionszeit für Command zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist,
WEAVE_ERROR_WRONG_TLV_TYPE
Wenn ein solches Element vorhanden ist, es aber keine vorzeichenbehaftete 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 Zeiger auf eine Variable, um bei Erfolg die Befehlstyp-ID zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist,
WEAVE_ERROR_WRONG_TLV_TYPE
wenn ein solches Element vorhanden ist, es sich aber nicht um eine vorzeichenlose Ganzzahl handelt.

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Rufen Sie die Ablaufzeit für diesen Befehl ab.

Details
Parameter
[out] apExpiryTimeMicroSecond
Ein Zeiger auf eine Variable, um die Ablaufzeit im Erfolgsfall zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist,
WEAVE_ERROR_WRONG_TLV_TYPE
Wenn ein solches Element vorhanden ist, es aber keine vorzeichenbehaftete Ganzzahl ist

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Rufen Sie die Initiierungszeit für diesen Befehl ab.

Details
Parameter
[out] apInitiationTimeMicroSecond
Ein Verweis auf eine Variable, um bei Erfolg die Initiierungszeit für Command zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist,
WEAVE_ERROR_WRONG_TLV_TYPE
Wenn ein solches Element vorhanden ist, es aber keine vorzeichenbehaftete Ganzzahl ist

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Rufen Sie die unverzichtbare Version für diesen Befehl ab.

Details
Parameter
[out] apMustBeVersion
Ein Zeiger auf eine Variable, um bei Erfolg die unverzichtbare Version zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist,
WEAVE_ERROR_WRONG_TLV_TYPE
wenn ein solches Element vorhanden ist, es sich aber nicht um eine vorzeichenlose Ganzzahl handelt.

GetPath

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

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

Details
Parameter
[out] apPath
Ein Verweis auf einen Path::Parser, der im Erfolgsfall mit der Komponente „eingebetteter Pfad“ initialisiert wird.
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist,
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

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

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

GetReaderOnPath

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

Initialisieren Sie einen TLVReader, der in diesem Befehl auf den Anfang der Pfadkomponente verweist.

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

Init

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

Initialisieren Sie das Parserobjekt mit TLVReader.

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