nl::Weave::Profiles::DataManagement_Current::CustomCommand::Builder

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

Définition de l'encodeur de commande personnalisée WDM.

Résumé

L'argument et les éléments d'authentification ne sont pas directement pris en charge, car ils n'ont pas de schéma fixe.

Héritage

Hérite de: nl::Weave::Profiles::DataManagement_Current::BuilderBase

Fonctions publiques
ActionTimeMicroSecond(const int64_t aActionTimeMicroSecond)
Injectez une durée d'action dans le flux TLV.
CommandType(const uint64_t aCommandType)
Injectez l'ID du type de commande dans le flux TLV.
CreatePathBuilder(void)
Initialisez un Path::Builder pour écrire dans le flux TLV.
EndOfCustomCommand(void)
Indique la fin de cette commande.
ExpiryTimeMicroSecond(const int64_t aExpiryTimeMicroSecond)
Injectez un délai d'expiration dans le flux TLV.
Init(nl::Weave::TLV::TLVWriter *const apWriter)
Initialisez une commande CustomCommand::Builder pour écrire dans un flux TLV.
InitiationTimeMicroSecond(const int64_t aInitiationTimeMicroSecond)
Injectez une durée d'initialisation dans le flux TLV.
MustBeVersion(const uint64_t aMustBeVersion)
Injectez la version obligatoire dans le flux TLV.

Fonctions publiques

ActionTimeMicroSecond

CustomCommand::Builder & ActionTimeMicroSecond(
  const int64_t aActionTimeMicroSecond
)

Injectez une durée d'action dans le flux TLV.

Détails
Paramètres
[in] aActionTimeMicroSecond
Durée d'action de cette commande, exprimée en microsecondes depuis l'epoch UNIX
Renvoie
Une référence à *this

CommandType

CustomCommand::Builder & CommandType(
  const uint64_t aCommandType
)

Injectez l'ID de type de commande dans le flux TLV.

Détails
Paramètres
[in] aCommandType
ID de type de commande pour cette commande
Renvoie
Une référence à *this

CreatePathBuilder

Path::Builder & CreatePathBuilder(
  void
)

Initialisez un élément Path::Builder pour l'écriture dans le flux TLV.

Détails
Renvoie
Référence à Path::Builder

EndOfCustomCommand

CustomCommand::Builder & EndOfCustomCommand(
  void
)

Indique la fin de cette commande.

Détails
Renvoie
Référence à *cet élément

ExpiryTimeMicroSecond

CustomCommand::Builder & ExpiryTimeMicroSecond(
  const int64_t aExpiryTimeMicroSecond
)

Injectez le délai d'expiration dans le flux TLV.

Détails
Paramètres
[in] aExpiryTimeMicroSecond
Date d'expiration de cette commande, en microsecondes depuis l'epoch UNIX
Renvoie
Une référence à *this

Init

WEAVE_ERROR Init(
  nl::Weave::TLV::TLVWriter *const apWriter
)

Initialisez un CustomCommand::Builder pour l'écriture dans un flux TLV.

Détails
Paramètres
[in] apWriter
Pointeur vers TLVWriter
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite

InitiationTimeMicroSecond

CustomCommand::Builder & InitiationTimeMicroSecond(
  const int64_t aInitiationTimeMicroSecond
)

Injectez l'heure d'initialisation dans le flux TLV.

Détails
Paramètres
[in] aInitiationTimeMicroSecond
Durée d'initialisation de cette commande, exprimée en microsecondes depuis l'époque UNIX
Renvoie
Référence à *cet élément

MustBeVersion

CustomCommand::Builder & MustBeVersion(
  const uint64_t aMustBeVersion
)

Injectez la version obligatoire dans le flux TLV.

Détails
Paramètres
[in] aMustBeVersion
L'instance de trame dans le chemin d'accès doit utiliser cette version pour que cette commande soit acceptée
Renvoie
Référence à *cet élément