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

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

Definición del analizador de solicitudes de comando personalizado de WDM.

Resumen

Herencia

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

Funciones públicas
CheckSchemaValidity(void) const
Verifica aproximadamente que el mensaje tenga el formato correcto.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Obtén la hora de acción programada para este comando.
GetCommandType(uint64_t *const apCommandType) const
Obtén el ID de tipo de comando para este comando.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Obtén la hora de vencimiento de este comando.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Obtén la hora de inicio de este comando.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Obtén la versión imprescindible para este comando.
GetPath(Path::Parser *const apPath) const
Inicializa un Path::Parser con el componente de la ruta de acceso en este comando.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Inicializa un TLVReader para que apunte al comienzo del componente del argumento en este comando.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Inicializa un TLVReader para que apunte al principio del componente de la ruta de acceso en este comando.
Init(const nl::Weave::TLV::TLVReader & aReader)
Inicializa el objeto del analizador con TLVReader.

Funciones públicas

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Verifica aproximadamente que el mensaje tenga el formato correcto.

Detalles
Valores de retorno
WEAVE_NO_ERROR
en función del éxito

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Obtén la hora de la acción programada para este comando.

Detalles
Parámetros
[out] apActionTimeMicroSecond
Un puntero a alguna variable para recibir el tiempo de acción del Comando en caso de éxito
Valores de retorno
WEAVE_NO_ERROR
en caso de éxito
WEAVE_END_OF_TLV
si no existe tal elemento
WEAVE_ERROR_WRONG_TLV_TYPE
si hay un elemento de este tipo, pero no es un número entero firmado

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Obtén el ID del tipo de comando para este comando.

Detalles
Parámetros
[out] apCommandType
Un puntero a alguna variable para recibir el ID de tipo de comando en caso de éxito
Valores de retorno
WEAVE_NO_ERROR
en caso de éxito
WEAVE_END_OF_TLV
si no existe tal elemento
WEAVE_ERROR_WRONG_TLV_TYPE
si existe ese elemento, pero no es un número entero sin firma

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Obtén la hora de vencimiento de este comando.

Detalles
Parámetros
[out] apExpiryTimeMicroSecond
Un puntero a alguna variable para recibir el tiempo de vencimiento en caso de éxito
Valores de retorno
WEAVE_NO_ERROR
en caso de éxito
WEAVE_END_OF_TLV
si no existe tal elemento
WEAVE_ERROR_WRONG_TLV_TYPE
si existe ese elemento, pero no es un número entero firmado

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Obtén la hora de inicio de este comando.

Detalles
Parámetros
[out] apInitiationTimeMicroSecond
Un puntero a alguna variable para recibir el tiempo de inicio del Comando en caso de éxito
Valores de retorno
WEAVE_NO_ERROR
en caso de éxito
WEAVE_END_OF_TLV
si no existe tal elemento
WEAVE_ERROR_WRONG_TLV_TYPE
si hay un elemento de este tipo, pero no es un número entero firmado

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Obtén la versión imprescindible para este comando.

Detalles
Parámetros
[out] apMustBeVersion
Un puntero a alguna variable para recibir la versión imprescindible en caso de éxito
Valores de retorno
WEAVE_NO_ERROR
en caso de éxito
WEAVE_END_OF_TLV
si no existe tal elemento
WEAVE_ERROR_WRONG_TLV_TYPE
si existe ese elemento, pero no es un número entero sin firma

GetPath

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

Inicializa un Path::Parser con el componente de ruta en este comando.

Detalles
Parámetros
[out] apPath
Un puntero para un elemento Path::Parser, que se inicializará con el componente de ruta incorporado de forma correcta
Valores de retorno
WEAVE_NO_ERROR
en caso de éxito
WEAVE_END_OF_TLV
si no existe tal elemento
WEAVE_ERROR_WRONG_TLV_TYPE
si existe ese elemento, pero no es una Path

GetReaderOnArgument

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

Inicializa un TLVReader para que apunte al principio del componente de argumento en este comando.

Detalles
Parámetros
[out] apReader
Es un puntero a TLVReader, que se inicializará en el elemento TLV del argumento si se realiza correctamente.
Valores de retorno
WEAVE_NO_ERROR
en función del éxito

GetReaderOnPath

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

Inicializa un TLVReader para que apunte al principio del componente de ruta de acceso en este comando.

Detalles
Parámetros
[out] apReader
Un puntero para TLVReader, que se inicializará en el elemento TLV de argumento si la operación es exitosa
Valores de retorno
WEAVE_NO_ERROR
en caso de éxito

Init

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

Inicializa el objeto del analizador con TLVReader.

Detalles
Parámetros
[in] aReader
Un puntero para un TLVReader, que debe apuntar al comienzo de esta solicitud
Valores de retorno
WEAVE_NO_ERROR
en función del éxito