nl::Weave::Profiles::DataManagement_Current::CustomCommand::Builder

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

WDM Custom Command encoder definition.

Summary

The argument, and the authenticator elements are not directly supported, as they do not have a fixed schema.

Inheritance

Inherits from: nl::Weave::Profiles::DataManagement_Current::BuilderBase

Public functions
ActionTimeMicroSecond(const int64_t aActionTimeMicroSecond)
Inject action time into the TLV stream.
CommandType(const uint64_t aCommandType)
Inject command type id into the TLV stream.
CreatePathBuilder(void)
Initialize a Path::Builder for writing into the TLV stream.
EndOfCustomCommand(void)
Mark the end of this command.
ExpiryTimeMicroSecond(const int64_t aExpiryTimeMicroSecond)
Inject expiry time into the TLV stream.
Init(nl::Weave::TLV::TLVWriter *const apWriter)
Initialize a CustomCommand::Builder for writing into a TLV stream.
InitiationTimeMicroSecond(const int64_t aInitiationTimeMicroSecond)
Inject init time into the TLV stream.
MustBeVersion(const uint64_t aMustBeVersion)
Inject must-be version into the TLV stream.

Public functions

ActionTimeMicroSecond

CustomCommand::Builder & ActionTimeMicroSecond(
  const int64_t aActionTimeMicroSecond
)

Inject action time into the TLV stream.

Details
Parameters
[in] aActionTimeMicroSecond
Action time for this command, in microseconds since UNIX epoch
Returns
A reference to *this

CommandType

CustomCommand::Builder & CommandType(
  const uint64_t aCommandType
)

Inject command type id into the TLV stream.

Details
Parameters
[in] aCommandType
Command type ID for this command
Returns
A reference to *this

CreatePathBuilder

Path::Builder & CreatePathBuilder(
  void
)

Initialize a Path::Builder for writing into the TLV stream.

Details
Returns
A reference to Path::Builder

EndOfCustomCommand

CustomCommand::Builder & EndOfCustomCommand(
  void
)

Mark the end of this command.

Details
Returns
A reference to *this

ExpiryTimeMicroSecond

CustomCommand::Builder & ExpiryTimeMicroSecond(
  const int64_t aExpiryTimeMicroSecond
)

Inject expiry time into the TLV stream.

Details
Parameters
[in] aExpiryTimeMicroSecond
Expiry time for this command, in microseconds since UNIX epoch
Returns
A reference to *this

Init

WEAVE_ERROR Init(
  nl::Weave::TLV::TLVWriter *const apWriter
)

Initialize a CustomCommand::Builder for writing into a TLV stream.

Details
Parameters
[in] apWriter
A pointer to TLVWriter
Return Values
WEAVE_NO_ERROR
on success

InitiationTimeMicroSecond

CustomCommand::Builder & InitiationTimeMicroSecond(
  const int64_t aInitiationTimeMicroSecond
)

Inject init time into the TLV stream.

Details
Parameters
[in] aInitiationTimeMicroSecond
Init time for this command, in microseconds since UNIX epoch
Returns
A reference to *this

MustBeVersion

CustomCommand::Builder & MustBeVersion(
  const uint64_t aMustBeVersion
)

Inject must-be version into the TLV stream.

Details
Parameters
[in] aMustBeVersion
Trait instance in the path must be at this version for this command to be accepted
Returns
A reference to *this