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

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

Definition des WDM-Parsers für benutzerdefinierte Befehle

Zusammenfassung

Übernahme

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

Öffentliche Funktionen
CheckSchemaValidity(void) const
Überprüfen Sie das korrekte Format der Nachricht.
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
Ruft das Ablaufdatum 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 erforderliche Version für diesen Befehl ab.
GetPath(Path::Parser *const apPath) const
Hier wird ein Path::Parser mit der Pfadkomponente initialisiert.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Initialisieren Sie einen TLVReader, sodass er auf den Anfang der Argumentkomponente in diesem Befehl verweist.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Initialisieren Sie einen TLVReader, sodass er auf den Anfang der Pfadkomponente in diesem Befehl 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 das korrekte Format der Nachricht.

Details
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Ruft die geplante Aktionszeit für diesen Befehl ab.

Details
Parameter
[out] apActionTimeMicroSecond
Ein Zeiger auf eine Variable, die im Erfolgsfall die Aktionszeit Command erhält.
Rückgabewerte
WEAVE_NO_ERROR
auf Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist
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, die bei Erfolg die Befehlstyp-ID empfängt
Rückgabewerte
WEAVE_NO_ERROR
auf 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 positive Ganzzahl handelt

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Ruft das Ablaufdatum für diesen Befehl ab.

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

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Rufen Sie die Initiierungszeit für diesen Befehl ab.

Details
Parameter
[out] apInitiationTimeMicroSecond
Ein Zeiger auf eine Variable, um die Initiierungszeit von Command bei Erfolg zu erhalten
Rückgabewerte
WEAVE_NO_ERROR
auf Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist
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

Erforderliche Version für diesen Befehl abrufen

Details
Parameter
[out] apMustBeVersion
Ein Zeiger auf eine Variable, die im Erfolgsfall die unverzichtbare Version erhält
Rückgabewerte
WEAVE_NO_ERROR
auf Erfolg
WEAVE_END_OF_TLV
wenn kein solches Element vorhanden ist
WEAVE_ERROR_WRONG_TLV_TYPE
Ein solches Element ist vorhanden, aber es ist keine vorzeichenlose Ganzzahl.

GetPath

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

Hier wird ein Path::Parser mit der Pfadkomponente initialisiert.

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

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 im Erfolgsfall beim Argument TLV-Element initialisiert wird
Rückgabewerte
WEAVE_NO_ERROR
auf Erfolg

GetReaderOnPath

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

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

Details
Parameter
[out] apReader
Ein Zeiger auf TLVReader, der im Erfolgsfall beim Argument TLV-Element 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 Verweis auf einen TLVReader, der auf den Anfang dieser Anfrage verweisen sollte
Rückgabewerte
WEAVE_NO_ERROR
bei Erfolg