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

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

Command Minta definisi parser khusus WDM.

Ringkasan

Inheritance

Mewarisi dari: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Fungsi publik
CheckSchemaValidity(void) const
Secara kasar pastikan bahwa pesan diformat dengan benar.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Mendapatkan waktu tindakan yang dijadwalkan untuk perintah ini.
GetCommandType(uint64_t *const apCommandType) const
Dapatkan ID jenis perintah untuk perintah ini.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Dapatkan waktu habis masa berlaku untuk perintah ini.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Dapatkan waktu inisiasi untuk perintah ini.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Dapatkan versi yang harus dimiliki untuk perintah ini.
GetPath(Path::Parser *const apPath) const
Lakukan inisialisasi Path::Parser dengan komponen jalur dalam perintah ini.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Melakukan inisialisasi TLVReader agar mengarah ke awal komponen argumen dalam perintah ini.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Melakukan inisialisasi TLVReader agar mengarah ke awal komponen jalur dalam perintah ini.
Init(const nl::Weave::TLV::TLVReader & aReader)
Menginisialisasi objek parser dengan TLVReader.

Fungsi publik

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Secara kasar pastikan bahwa pesan diformat dengan benar.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Mendapatkan waktu tindakan yang dijadwalkan untuk perintah ini.

Detail
Parameter
[out] apActionTimeMicroSecond
Pointer ke beberapa variabel untuk menerima waktu tindakan Command jika berhasil
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil
WEAVE_END_OF_TLV
jika tidak ada elemen seperti itu
WEAVE_ERROR_WRONG_TLV_TYPE
jika ada elemen tersebut, tetapi bukan bilangan bulat yang ditandai

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Dapatkan ID jenis perintah untuk perintah ini.

Detail
Parameter
[out] apCommandType
Pointer ke beberapa variabel untuk menerima ID jenis perintah saat berhasil
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil
WEAVE_END_OF_TLV
jika tidak ada elemen seperti itu
WEAVE_ERROR_WRONG_TLV_TYPE
jika ada elemen seperti itu, tetapi itu bukan bilangan bulat yang tidak bertanda tangan

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Dapatkan waktu habis masa berlaku untuk perintah ini.

Detail
Parameter
[out] apExpiryTimeMicroSecond
Penunjuk ke beberapa variabel untuk menerima waktu kedaluwarsa saat berhasil
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil
WEAVE_END_OF_TLV
jika tidak ada elemen seperti itu
WEAVE_ERROR_WRONG_TLV_TYPE
jika ada elemen tersebut, tetapi bukan bilangan bulat yang ditandai

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Dapatkan waktu inisiasi untuk perintah ini.

Detail
Parameter
[out] apInitiationTimeMicroSecond
Pointer ke beberapa variabel untuk menerima waktu inisiasi Command setelah berhasil
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil
WEAVE_END_OF_TLV
jika tidak ada elemen seperti itu
WEAVE_ERROR_WRONG_TLV_TYPE
jika ada elemen tersebut, tetapi bukan bilangan bulat yang ditandai

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Dapatkan versi yang harus dimiliki untuk perintah ini.

Detail
Parameter
[out] apMustBeVersion
Pointer ke beberapa variabel untuk menerima versi wajib saat berhasil
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil
WEAVE_END_OF_TLV
jika tidak ada elemen seperti itu
WEAVE_ERROR_WRONG_TLV_TYPE
jika ada elemen seperti itu, tetapi itu bukan bilangan bulat yang tidak bertanda tangan

GetPath

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

Lakukan inisialisasi Path::Parser dengan komponen jalur dalam perintah ini.

Detail
Parameter
[out] apPath
Pointer ke Path::Parser, yang akan diinisialisasi dengan komponen jalur tersemat jika berhasil
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil
WEAVE_END_OF_TLV
jika tidak ada elemen seperti itu
WEAVE_ERROR_WRONG_TLV_TYPE
jika ada elemen tersebut, tetapi bukan Path

GetReaderOnArgument

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

Melakukan inisialisasi TLVReader agar mengarah ke awal komponen argumen dalam perintah ini.

Detail
Parameter
[out] apReader
Pointer ke TLVReader, yang akan diinisialisasi pada elemen TLV argumen saat berhasil
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil

GetReaderOnPath

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

Melakukan inisialisasi TLVReader agar mengarah ke awal komponen jalur dalam perintah ini.

Detail
Parameter
[out] apReader
Pointer ke TLVReader, yang akan diinisialisasi pada elemen TLV argumen saat berhasil
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil

Inisiasi

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

Menginisialisasi objek parser dengan TLVReader.

Detail
Parameter
[in] aReader
Pointer ke TLVReader, yang akan mengarah ke awal permintaan ini
Nilai Pengembalian
WEAVE_NO_ERROR
saat berhasil