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

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

Định nghĩa trình phân tích cú pháp yêu cầu WDM Custom Command.

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Hàm công khai

CheckSchemaValidity(void) const
Xác minh xem thư được định dạng đúng hay chưa.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Lấy thời gian thực hiện hành động theo lịch cho lệnh này.
GetCommandType(uint64_t *const apCommandType) const
Lấy mã loại lệnh cho lệnh này.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Lấy thời gian hết hạn cho lệnh này.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Lấy thời gian bắt đầu cho lệnh này.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Tải phiên bản bắt buộc cho lệnh này.
GetPath(Path::Parser *const apPath) const
Khởi động một Path::Parser bằng thành phần đường dẫn trong lệnh này.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Khởi chạy TLVReader để trỏ đến đầu thành phần đối số trong lệnh này.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Khởi động một TLVReader để trỏ đến điểm bắt đầu của thành phần đường dẫn trong lệnh này.
Init(const nl::Weave::TLV::TLVReader & aReader)
Khởi động đối tượng trình phân tích cú pháp bằng TLVReader.

Hàm công khai

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const 

Xác minh xem thư được định dạng đúng hay chưa.

Thông tin chi tiết
Giá trị trả về
WEAVE_NO_ERROR
khi thành công

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const 

Lấy thời gian hành động đã lên lịch cho lệnh này.

Thông tin chi tiết
Thông số
[out] apActionTimeMicroSecond
Con trỏ trỏ đến một biến nào đó để nhận thời gian thực hiện thao tác Command khi thành công
Giá trị trả về
WEAVE_NO_ERROR
khi thành công
WEAVE_END_OF_TLV
nếu không có phần tử như vậy
WEAVE_ERROR_WRONG_TLV_TYPE
nếu có phần tử như vậy nhưng đó không phải là số nguyên đã ký

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const 

Lấy mã loại lệnh cho lệnh này.

Thông tin chi tiết
Thông số
[out] apCommandType
Con trỏ trỏ đến một biến nào đó để nhận mã loại lệnh khi thành công
Giá trị trả về
WEAVE_NO_ERROR
khi thành công
WEAVE_END_OF_TLV
nếu không có phần tử nào như vậy
WEAVE_ERROR_WRONG_TLV_TYPE
nếu có phần tử như vậy nhưng phần tử đó không phải là số nguyên chưa ký

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const 

Lấy thời gian hết hạn cho lệnh này.

Thông tin chi tiết
Thông số
[out] apExpiryTimeMicroSecond
Con trỏ trỏ đến một biến nào đó để nhận thời gian hết hạn khi thành công
Giá trị trả về
WEAVE_NO_ERROR
khi thành công
WEAVE_END_OF_TLV
nếu không có phần tử như vậy
WEAVE_ERROR_WRONG_TLV_TYPE
nếu có phần tử như vậy nhưng không phải là số nguyên có dấu

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const 

Lấy thời gian bắt đầu cho lệnh này.

Thông tin chi tiết
Thông số
[out] apInitiationTimeMicroSecond
Con trỏ đến một số biến để nhận thời gian bắt đầu Lệnh khi thành công
Giá trị trả về
WEAVE_NO_ERROR
khi thành công
WEAVE_END_OF_TLV
nếu không có phần tử như vậy
WEAVE_ERROR_WRONG_TLV_TYPE
nếu có phần tử như vậy nhưng không phải là số nguyên có dấu

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const 

Tải phiên bản bắt buộc cho lệnh này.

Thông tin chi tiết
Thông số
[out] apMustBeVersion
Con trỏ đến một số biến để nhận phiên bản bắt buộc khi thành công
Giá trị trả về
WEAVE_NO_ERROR
khi thành công
WEAVE_END_OF_TLV
nếu không có phần tử nào như vậy
WEAVE_ERROR_WRONG_TLV_TYPE
nếu có phần tử như vậy nhưng không phải là số nguyên không dấu

GetPath

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

Khởi chạy Path::Parser bằng thành phần đường dẫn trong lệnh này.

Thông tin chi tiết
Thông số
[out] apPath
Con trỏ trỏ đến Path::Parser (Đường dẫn::Phân tích cú pháp) sẽ được khởi chạy bằng thành phần đường dẫn được nhúng khi thành công
Giá trị trả về
WEAVE_NO_ERROR
khi thành công
WEAVE_END_OF_TLV
nếu không có phần tử như vậy
WEAVE_ERROR_WRONG_TLV_TYPE
nếu có phần tử như vậy nhưng không phải là Đường dẫn

GetReaderOnArgument

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

Khởi động một TLVReader để trỏ đến phần đầu của thành phần đối số trong lệnh này.

Thông tin chi tiết
Thông số
[out] apReader
Con trỏ đến TLVReader, sẽ được khởi chạy tại phần tử đối số TLV khi thành công
Giá trị trả về
WEAVE_NO_ERROR
khi thành công

GetReaderOnPath

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

Khởi động một TLVReader để trỏ đến điểm bắt đầu của thành phần đường dẫn trong lệnh này.

Thông tin chi tiết
Thông số
[out] apReader
Con trỏ tới TLVReader sẽ được khởi chạy ở phần tử đối số TLV khi thành công
Giá trị trả về
WEAVE_NO_ERROR
khi thành công

Khởi động

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

Khởi tạo đối tượng trình phân tích cú pháp bằng TLVReader.

Thông tin chi tiết
Thông số
[in] aReader
Con trỏ trỏ đến TLVReader, con trỏ này sẽ trỏ đến đầu yêu cầu này
Giá trị trả về
WEAVE_NO_ERROR
khi thành công