nl::Weave::Profiles::DataManagement_Current::CustomCommand::Parser
#include <src/lib/profiles/data-management/Current/MessageDef.h>
WDM Custom Command Request parser definition.
Summary
Inheritance
Inherits from:
nl::Weave::Profiles::DataManagement_Current::DataElement::Parser
Public functions
CheckSchemaValidity
WEAVE_ERROR CheckSchemaValidity(
void
) const
Roughly verify the message is correctly formed.
Details |
Return Values |
WEAVE_NO_ERROR
|
on success
|
|
GetActionTimeMicroSecond
WEAVE_ERROR GetActionTimeMicroSecond(
int64_t *const apActionTimeMicroSecond
) const
Get the scheduled action time for this command.
Details |
Parameters |
[out] apActionTimeMicroSecond
|
A pointer to some variable to receive the Command action time 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 a signed integer
|
|
GetCommandType
WEAVE_ERROR GetCommandType(
uint64_t *const apCommandType
) const
Get the command type id for this command.
Details |
Parameters |
[out] apCommandType
|
A pointer to some variable to receive the command type id 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
|
|
GetExpiryTimeMicroSecond
WEAVE_ERROR GetExpiryTimeMicroSecond(
int64_t *const apExpiryTimeMicroSecond
) const
Get the expiry time for this command.
Details |
Parameters |
[out] apExpiryTimeMicroSecond
|
A pointer to some variable to receive the expiry time 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 a signed integer
|
|
GetInitiationTimeMicroSecond
WEAVE_ERROR GetInitiationTimeMicroSecond(
int64_t *const apInitiationTimeMicroSecond
) const
Get the initiation time for this command.
Details |
Parameters |
[out] apInitiationTimeMicroSecond
|
A pointer to some variable to receive the Command initiation time 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 a signed integer
|
|
GetMustBeVersion
WEAVE_ERROR GetMustBeVersion(
uint64_t *const apMustBeVersion
) const
Get the must-be version for this command.
Details |
Parameters |
[out] apMustBeVersion
|
A pointer to some variable to receive the must-be 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
|
|
GetPath
WEAVE_ERROR GetPath(
Path::Parser *const apPath
) const
Initialize a Path::Parser with the path component in this command.
Details |
Parameters |
[out] apPath
|
A pointer to a Path::Parser, which will be initialized with embedded path component 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 a Path
|
|
GetReaderOnArgument
WEAVE_ERROR GetReaderOnArgument(
nl::Weave::TLV::TLVReader *const apReader
) const
Initialize a TLVReader to point to the beginning of the argument component in this command.
Details |
Parameters |
[out] apReader
|
A pointer to TLVReader, which will be initialized at the argument TLV element on success
|
|
Return Values |
WEAVE_NO_ERROR
|
on success
|
|
GetReaderOnPath
WEAVE_ERROR GetReaderOnPath(
nl::Weave::TLV::TLVReader *const apReader
) const
Initialize a TLVReader to point to the beginning of the path component in this command.
Details |
Parameters |
[out] apReader
|
A pointer to TLVReader, which will be initialized at the argument TLV element on success
|
|
Return Values |
WEAVE_NO_ERROR
|
on success
|
|
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 request
|
|
Return Values |
WEAVE_NO_ERROR
|
on success
|
|