nl::Weave::Profiles::DataManagement_Current::UpdateRequest::Parser
#include <src/lib/profiles/data-management/Current/MessageDef.h>
WDM Update 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
|
|
GetExpiryTimeMicroSecond
WEAVE_ERROR GetExpiryTimeMicroSecond(
int64_t *const apExpiryTimeMicroSecond
) const
Get the expiry time for this request.
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 unsigned integer
|
|
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 request.
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
|
|
GetUpdateRequestIndex
WEAVE_ERROR GetUpdateRequestIndex(
uint32_t *const apUpdateRequestIndex
) const
Get the UpdateRequestIndex of this request.
Details |
Parameters |
[out] apUpdateRequestIndex
|
A pointer to some variable to receive the index of the payload.
|
|
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 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 request
|
|
Return Values |
WEAVE_NO_ERROR
|
on success
|
|