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

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

Definição do codificador de comando personalizado do WDM.

Resumo

O argumento e os elementos do autenticador não têm suporte direto, porque não têm um esquema fixo.

Herança

Herda de: nl::Weave::Profiles::DataManagement_Current::BuilderBase

Funções públicas
ActionTimeMicroSecond(const int64_t aActionTimeMicroSecond)
Injete o tempo de ação no fluxo TLV.
CommandType(const uint64_t aCommandType)
Injete o ID do tipo de comando no fluxo TLV.
CreatePathBuilder(void)
Inicialize um Path::Builder para gravar no fluxo TLV.
EndOfCustomCommand(void)
Marque o final desse comando.
ExpiryTimeMicroSecond(const int64_t aExpiryTimeMicroSecond)
Injete o tempo de expiração no fluxo de TLV.
Init(nl::Weave::TLV::TLVWriter *const apWriter)
Inicialize um CustomCommand::Builder para gravar em um stream TLV.
InitiationTimeMicroSecond(const int64_t aInitiationTimeMicroSecond)
Injete o tempo de inicialização no fluxo TLV.
MustBeVersion(const uint64_t aMustBeVersion)
Injete a versão necessária no fluxo TLV.

Funções públicas

ActionTimeMicroSecond

CustomCommand::Builder & ActionTimeMicroSecond(
  const int64_t aActionTimeMicroSecond
)

Injete o tempo de ação no fluxo TLV.

Detalhes
Parâmetros
[in] aActionTimeMicroSecond
Tempo de ação para este comando, em microssegundos desde a época do UNIX
Retornos
Uma referência a *this

CommandType

CustomCommand::Builder & CommandType(
  const uint64_t aCommandType
)

Injete o ID do tipo de comando no fluxo TLV.

Detalhes
Parâmetros
[in] aCommandType
ID do tipo Command para este comando
Retornos
Uma referência a *este

CreatePathBuilder

Path::Builder & CreatePathBuilder(
  void
)

Inicialize um Path::Builder para gravar no stream TLV.

Detalhes
Retornos
Uma referência a Path::Builder

EndOfCustomCommand

CustomCommand::Builder & EndOfCustomCommand(
  void
)

Marca o fim do comando.

Detalhes
Retornos
Uma referência a *this

ExpiryTimeMicroSecond

CustomCommand::Builder & ExpiryTimeMicroSecond(
  const int64_t aExpiryTimeMicroSecond
)

Injete o tempo de expiração no fluxo de TLV.

Detalhes
Parâmetros
[in] aExpiryTimeMicroSecond
Prazo de validade do comando, em microssegundos desde a época do UNIX
Retornos
Uma referência a *this

Init

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

Inicialize um CustomCommand::Builder para gravar em um stream TLV.

Detalhes
Parâmetros
[in] apWriter
Um ponteiro para TLVWriter
Valores de retorno
WEAVE_NO_ERROR
em caso de sucesso

InitiationTimeMicroSecond

CustomCommand::Builder & InitiationTimeMicroSecond(
  const int64_t aInitiationTimeMicroSecond
)

Injete o tempo de inicialização no fluxo de TLV.

Detalhes
Parâmetros
[in] aInitiationTimeMicroSecond
Tempo de inicialização do comando, em microssegundos, a partir da época do UNIX
Retornos
Uma referência a *this

MustBeVersion

CustomCommand::Builder & MustBeVersion(
  const uint64_t aMustBeVersion
)

Injete a versão obrigatória no fluxo TLV.

Detalhes
Parâmetros
[in] aMustBeVersion
A instância de atributo no caminho precisa estar nessa versão para que o comando seja aceito.
Retornos
Uma referência a *este