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

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

Definição do analisador de solicitações de comando personalizado do WDM.

Resumo

Herança

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

Funções públicas
CheckSchemaValidity(void) const
Verifique se a mensagem está correta.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Receba o horário da ação programada para este comando.
GetCommandType(uint64_t *const apCommandType) const
Receba o ID do tipo de comando para esse comando.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Recebe o tempo de expiração deste comando.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Receber o horário de início desse 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 de caminho neste comando.
Init(const nl::Weave::TLV::TLVReader & aReader)
Inicialize o objeto do analisador com o TLVReader.

Funções públicas

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Verifique se a mensagem está corretamente formatada.

Detalhes
Valores de retorno
WEAVE_NO_ERROR
em caso de sucesso

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

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

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

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Receba o ID do tipo de comando para esse comando.

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

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Recebe o tempo de expiração deste comando.

Detalhes
Parâmetros
[out] apExpiryTimeMicroSecond
Um ponteiro para alguma variável para receber o tempo de expiração em caso de sucesso
Valores de retorno
WEAVE_NO_ERROR
em caso de sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se houver esse elemento, mas não for um número inteiro com sinal

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Receba o horário de início desse comando.

Detalhes
Parâmetros
[out] apInitiationTimeMicroSecond
Um ponteiro para alguma variável para receber o tempo de iniciação Command em caso de êxito
Valores de retorno
WEAVE_NO_ERROR
em caso de sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se houver esse elemento, mas não for um número inteiro com sinal

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

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

Detalhes
Parâmetros
[out] apMustBeVersion
Um ponteiro para alguma variável para receber a versão obrigatória em caso de sucesso
Valores de retorno
WEAVE_NO_ERROR
em caso de sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
Se houver esse elemento, mas ele não for um número inteiro sem sinal

GetPath

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

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

Detalhes
Parâmetros
[out] apPath
Um ponteiro para um Path::Parser, que será inicializado com o componente de caminho incorporado se a operação for bem-sucedida.
Valores de retorno
WEAVE_NO_ERROR
em caso de sucesso
WEAVE_END_OF_TLV
se não houver esse elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se houver esse elemento, mas ele não for um caminho

GetReaderOnArgument

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

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

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

GetReaderOnPath

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

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

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

Init

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

Inicialize o objeto analisador com TLVReader.

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