nl::Weave::Profiles::DataManagement_Current::CustomCommandResponse::Parser

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

WDM Custom Command Response parser definition.

Summary

Inheritance

Inherits from: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Public functions
CheckSchemaValidity(void) const
Roughly verify the message is correctly formed.
GetReaderOnResponse(nl::Weave::TLV::TLVReader *const apReader) const
Initialize a TLVReader to point to the beginning of the response component in this message.
GetVersion(uint64_t *const apVersion) const
Get the trait instance version in this response.
Init(const nl::Weave::TLV::TLVReader & aReader)
Initialize the parser object with TLVReader.

Public functions

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Roughly verify the message is correctly formed.

Details
Return Values
WEAVE_NO_ERROR
on success

GetReaderOnResponse

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

Initialize a TLVReader to point to the beginning of the response component in this message.

Details
Parameters
[out] apReader
A pointer to TLVReader, which will be initialized at the response TLV element on success
Return Values
WEAVE_NO_ERROR
on success

GetVersion

WEAVE_ERROR GetVersion(
  uint64_t *const apVersion
) const

Get the trait instance version in this response.

Details
Parameters
[out] apVersion
A pointer to some variable to receive the version on success
Return Values
WEAVE_NO_ERROR
on success
WEAVE_END_OF_TLV
if there is no such element
WEAVE_ERROR_WRONG_TLV_TYPE
if there is such element but it's not an unsigned integer

Init

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

Initialize the parser object with TLVReader.

Details
Parameters
[in] aReader
A pointer to a TLVReader, which should point to the beginning of this response
Return Values
WEAVE_NO_ERROR
on success