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

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

Definição do analisador da solicitação de comando personalizada do WDM.

Resumo

Herança

Herdado de: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Funções públicas
CheckSchemaValidity(void) const
Verifique inicialmente se a mensagem foi escrita corretamente.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Saiba o horário da ação programada para este comando.
GetCommandType(uint64_t *const apCommandType) const
Encontre o ID do tipo desse comando.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Descubra o prazo de validade desse comando.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Descubra o tempo de início deste comando.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Consiga a versão necessária para este comando.
GetPath(Path::Parser *const apPath) const
Inicialize um Path::Parser com o componente de caminho neste comando.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Inicialize um TLVReader para apontar para o início do componente do argumento nesse comando.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Inicialize um TLVReader para apontar para o início do componente do caminho nesse comando.
Init(const nl::Weave::TLV::TLVReader & aReader)
Inicializar o objeto analisador com TLVReader.

Funções públicas

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Verifique inicialmente se a mensagem foi escrita corretamente.

Detalhes
Valores de retorno
WEAVE_NO_ERROR
com sucesso

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Saiba o horário da ação programada para este comando.

Detalhes
Parâmetros
[out] apActionTimeMicroSecond
Um ponteiro para uma variável para receber o tempo da ação Command em caso de êxito
Valores de retorno
WEAVE_NO_ERROR
com sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se existir esse elemento, mas ele não for um número inteiro assinado

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Encontre o ID do tipo desse comando.

Detalhes
Parâmetros
[out] apCommandType
Um ponteiro para uma variável para receber o ID do tipo de comando em caso de êxito
Valores de retorno
WEAVE_NO_ERROR
com sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se esse elemento existir, mas não for um número inteiro sem assinatura

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Descubra o prazo de validade desse comando.

Detalhes
Parâmetros
[out] apExpiryTimeMicroSecond
Ponteiro para alguma variável para receber o prazo de validade em caso de sucesso
Valores de retorno
WEAVE_NO_ERROR
com sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se existir esse elemento, mas ele não for um número inteiro assinado

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Descubra o tempo de início deste comando.

Detalhes
Parâmetros
[out] apInitiationTimeMicroSecond
Um indicador para alguma variável para receber o tempo de início do Command em caso de êxito.
Valores de retorno
WEAVE_NO_ERROR
com sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se existir esse elemento, mas ele não for um número inteiro assinado

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Consiga a versão necessária para este comando.

Detalhes
Parâmetros
[out] apMustBeVersion
Um indicador para alguma variável para receber a versão necessária em caso de sucesso
Valores de retorno
WEAVE_NO_ERROR
com sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se esse elemento existir, mas não for um número inteiro sem assinatura

GetPath

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

Inicialize um Path::Parser com o componente de caminho neste comando.

Detalhes
Parâmetros
[out] apPath
Um ponteiro para um Path::Parser, que será inicializado com o componente de caminho incorporado em caso de êxito.
Valores de retorno
WEAVE_NO_ERROR
com sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se existe um elemento, mas não é um Path

GetReaderOnArgument

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

Inicialize um TLVReader para apontar para o início do componente do argumento nesse comando.

Detalhes
Parâmetros
[out] apReader
Um ponteiro para TLVReader, que será inicializado no elemento TLV do argumento em caso de sucesso.
Valores de retorno
WEAVE_NO_ERROR
com sucesso

GetReaderOnPath

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

Inicialize um TLVReader para apontar para o início do componente do caminho nesse comando.

Detalhes
Parâmetros
[out] apReader
Um ponteiro para TLVReader, que será inicializado no elemento TLV do argumento em caso de sucesso.
Valores de retorno
WEAVE_NO_ERROR
com sucesso

Init

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

Inicializar o objeto analisador com TLVReader.

Detalhes
Parâmetros
[in] aReader
Um ponteiro para um TLVReader, que deve apontar para o início dessa solicitação
Valores de retorno
WEAVE_NO_ERROR
com sucesso