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

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

Définition de l'analyseur de requêtes de commande personnalisé WDM.

Résumé

Héritage

Hérite de: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Fonctions publiques
CheckSchemaValidity(void) const
Vérifiez de manière approximative que le message est correctement formaté.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Obtenez l'heure de l'action planifiée pour cette commande.
GetCommandType(uint64_t *const apCommandType) const
Obtenez l'ID de type de commande pour cette commande.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Récupérez l'heure d'expiration de cette commande.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Obtenez l'heure de début de cette commande.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Obtenez la version indispensable pour cette commande.
GetPath(Path::Parser *const apPath) const
Initialisez un Path::Parser avec le composant de chemin d'accès dans cette commande.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Initialisez un objet TLVReader pour qu'il pointe vers le début du composant d'argument dans cette commande.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Initialisez un TLVReader pour qu'il pointe vers le début du composant de chemin d'accès dans cette commande.
Init(const nl::Weave::TLV::TLVReader & aReader)
Initialisez l'objet d'analyseur avec TLVReader.

Fonctions publiques

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Vérifiez de manière approximative que le message est correctement formaté.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Obtenez l'heure de l'action planifiée pour cette commande.

Détails
Paramètres
[out] apActionTimeMicroSecond
Un pointeur vers une variable pour recevoir l'action Command (Commande) en cas de réussite
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite
WEAVE_END_OF_TLV
si aucun élément de ce type n'existe
WEAVE_ERROR_WRONG_TLV_TYPE
s'il existe un tel élément, mais que ce n'est pas un entier signé

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Obtenez l'ID du type de commande pour cette commande.

Détails
Paramètres
[out] apCommandType
Pointeur vers une variable pour recevoir l'ID de type de commande en cas de réussite
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite
WEAVE_END_OF_TLV
si aucun élément de ce type n'existe
WEAVE_ERROR_WRONG_TLV_TYPE
si un tel élément existe, mais qu'il ne s'agit pas d'un entier non signé

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Obtenez le délai d'expiration de cette commande.

Détails
Paramètres
[out] apExpiryTimeMicroSecond
Pointeur vers une variable pour recevoir la date d'expiration en cas de réussite
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite
WEAVE_END_OF_TLV
si aucun élément de ce type n'existe
WEAVE_ERROR_WRONG_TLV_TYPE
si un tel élément existe, mais qu'il ne s'agit pas d'un entier signé

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Obtenez l'heure de début de cette commande.

Détails
Paramètres
[out] apInitiationTimeMicroSecond
Un pointeur vers une variable pour recevoir l'heure de lancement de la commande en cas de réussite
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite
WEAVE_END_OF_TLV
si aucun élément de ce type n'existe
WEAVE_ERROR_WRONG_TLV_TYPE
si un tel élément existe, mais qu'il ne s'agit pas d'un entier signé

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Obtenez la version indispensable pour cette commande.

Détails
Paramètres
[out] apMustBeVersion
Pointeur vers une variable pour recevoir la version obligatoire en cas de réussite
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite
WEAVE_END_OF_TLV
si aucun élément de ce type n'existe
WEAVE_ERROR_WRONG_TLV_TYPE
si un tel élément existe, mais qu'il ne s'agit pas d'un entier non signé

GetPath

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

Initialisez un objet Path::Parser avec le composant de chemin d'accès dans cette commande.

Détails
Paramètres
[out] apPath
Un pointeur vers un élément Path::Parser, qui sera initialisé avec le composant de chemin intégré en cas de réussite
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite
WEAVE_END_OF_TLV
si aucun élément de ce type n'existe
WEAVE_ERROR_WRONG_TLV_TYPE
si un tel élément existe, mais que le champ Path n'est pas spécifié ;

GetReaderOnArgument

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

Initialisez un objet TLVReader pour qu'il pointe vers le début du composant d'argument dans cette commande.

Détails
Paramètres
[out] apReader
Un pointeur vers TLVReader, qui sera initialisé au niveau de l'élément d'argument TLV en cas de réussite
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite

GetReaderOnPath

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

Initialisez un TLVReader pour qu'il pointe vers le début du composant de chemin d'accès dans cette commande.

Détails
Paramètres
[out] apReader
Pointeur vers TLVReader, qui sera initialisé à l'élément d'argument TLV en cas de succès
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite

Init

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

Initialisez l'objet analyseur avec TLVReader.

Détails
Paramètres
[in] aReader
Pointeur vers un TLVReader, qui doit pointer vers le début de cette requête
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite