nl:: Weave:: Hồ sơ:: DataManagement_Current:: ResourceIdentifier
#include <src/lib/profiles/data-management/Current/ResourceIdentifier.h>
Cấu trúc đóng gói mã nhận dạng của tài nguyên.
Tóm tắt
ResourceIdentifier có thể là mã đối tượng 64 bit chung cho một loại cụ thể hoặc UUID. Khi được mã hóa bên ngoài, các biểu diễn sau được hỗ trợ:
số nguyên 64 bit không dấu tương ứng với đối tượng được khái quát của loại THIẾT BỊ có ID được chỉ định trong biểu diễn
cách biểu diễn tổng quát được mã hóa dưới dạng một chuỗi byte gồm 10 bát phân. Hai octet đầu tiên mã hóa loại tài nguyên dưới dạng số nguyên 16 bit, đầu cuối nhỏ, với 8 byte còn lại mã hóa một mã tài nguyên 64 bit một chút.
ResourceIdentifier cũng thể hiện các quy ước xuất hiện trong toàn bộ mã WDM: một ResourceIdentifier trống tương ứng với mã nút của THIẾT BỊ và hàm dựng được cung cấp cho những trường hợp sử dụng phổ biến nhất.
Hàm dựng và hàm phá hủy |
|
---|---|
ResourceIdentifier()
Tạo ResourceIdentifier tương ứng với ResourceID chưa chỉ định.
|
|
ResourceIdentifier(const uint64_t & aNodeId)
Tạo ResourceIdentifier của loại thiết bị dựa trên aNodeId nhất định.
|
|
ResourceIdentifier(uint16_t aResourceType, const uint64_t & aResourceId)
Tạo ResourceIdentifier của loại được chỉ định với mã đã cho.
|
|
ResourceIdentifier(uint16_t aResourceType, const uint8_t *aResourceId, size_t aResourceIdLen)
Tạo ResourceIdentifier của loại được chỉ định với mã đã cho.
|
Loại công khai |
|
---|---|
@125{
|
enum |
@126
|
enum Xác định một giá trị đặc biệt cho NodeId tham chiếu & # 39;self\39;. |
@127
|
enum |
Thuộc tính công khai |
|
---|---|
ResourceId
|
uint64_t
|
ResourceIdBytes[8]
|
uint8_t
|
Hàm công khai |
|
---|---|
FromString(const char *inBuffer, size_t inBufferLen)
|
Phân tích cú pháp chuỗi biểu diễn chính tắc của một tài nguyên vào một đối tượng tài nguyên.
|
FromString(const char *inBuffer, size_t inBufferLen, const uint64_t & aSelfNodeId)
|
Phân tích cú pháp chuỗi biểu diễn chính tắc của một tài nguyên vào một đối tượng tài nguyên.
|
FromTLV(nl::Weave::TLV::TLVReader & aReader)
|
Giải mã Mã nhận dạng tài nguyên từ biểu tượng TLV vào đối tượng này.
|
FromTLV(nl::Weave::TLV::TLVReader & aReader, const uint64_t & aSelfNodeId)
|
Giải mã Mã nhận dạng tài nguyên từ biểu tượng TLV vào đối tượng này.
|
GetResourceId() const
|
uint64_t
Hàm truy cập để tìm nạp ResourceId.
|
GetResourceType() const
|
uint16_t
Hàm truy cập để tìm nạp ResourceType.
|
ResourceTypeAsString(void) const
|
const char *
Tạo một biểu diễn chuỗi của ResourceType.
|
ToString(char *buffer, size_t bufferLen)
|
Chuyển đổi ResourceIdentifier thành một chuỗi có thể in.
|
ToTLV(nl::Weave::TLV::TLVWriter & aWriter) const
|
Sắp xếp tuần tự tài nguyên thành biểu diễn TLV bằng thẻ Đường dẫn::ResourceID.
|
ToTLV(nl::Weave::TLV::TLVWriter & aWriter, const uint64_t & aTag) const
|
Nối tiếp tài nguyên với một trang trình bày TLV bằng một thẻ nhất định.
|
Hàm tĩnh công khai |
|
---|---|
ResourceTypeAsString(uint16_t aResourceType)
|
const char *
Tạo một biểu diễn chuỗi của loại tài nguyên.
|
Lớp học của bạn bè |
|
---|---|
operator==
|
friend bool
|
Loại công khai
@125
@125
Thuộc tính | |
---|---|
RESOURCE_TYPE_RESERVED
|
Loại tài nguyên dành riêng. liệt kê bằng Hiện tại, có thể có hai giá trị ResourceId cho loại tài nguyên RESERVED: kNodeIdNotSpecized tương ứng với một ResourceIdentifier hợp nhất, và self_NAMES_ID tương ứng với một tài nguyên sẽ liên kết lại tới self từ bất kỳ biểu thị nào khác. |
@126
@126
Xác định một giá trị đặc biệt cho NodeId tham chiếu & # 39;self\39;.
Trong một số hoạt động tương tác WDM nhất định, việc có giá trị bản thân cho tài nguyên cho phép nén thông tin đó vì thông tin này không cần thiết vào id nút nguồn của thiết bị được thể hiện trong thông báo Weave.
@127
@127
Thuộc tính công khai
Id tài nguyên
uint64_t ResourceId
ResourceIdBytes
uint8_t ResourceIdBytes[8]
Hàm công khai
Chuỗi
WEAVE_ERROR FromString( const char *inBuffer, size_t inBufferLen )
Phân tích cú pháp chuỗi biểu diễn chính tắc của một tài nguyên vào một đối tượng tài nguyên.
Chuyển đổi cách biểu diễn chuỗi chính tắc của một tài nguyên thành đối tượng tài nguyên. Lưu ý rằng chỉ một tập hợp con các tài nguyên có thể được biểu thị dưới dạng một chuỗi, cụ thể là việc triển khai tham chiếu trong Weave sẽ chỉ phân tích cú pháp tài nguyên của các loại chuẩn như được thể hiện trong ResourceTypeEnum.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các thông số |
|
Chuỗi
WEAVE_ERROR FromString( const char *inBuffer, size_t inBufferLen, const uint64_t & aSelfNodeId )
Phân tích cú pháp chuỗi biểu diễn chính tắc của một tài nguyên vào một đối tượng tài nguyên.
Chuyển đổi cách biểu diễn chuỗi chính tắc của một tài nguyên thành đối tượng tài nguyên. Lưu ý rằng chỉ một tập hợp con các tài nguyên có thể được biểu thị dưới dạng một chuỗi, cụ thể là việc triển khai tham chiếu trong Weave sẽ chỉ phân tích cú pháp tài nguyên của các loại chuẩn như được thể hiện trong ResourceTypeEnum.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các thông số |
|
Từ xa
WEAVE_ERROR FromTLV( nl::Weave::TLV::TLVReader & aReader )
Giải mã Mã nhận dạng tài nguyên từ biểu tượng TLV vào đối tượng này.
Thông tin chi tiết | |||
---|---|---|---|
Các thông số |
|
||
Trả về |
WEAVE_NO_ERROR thành công. Lỗi từ TLV Reader nếu không đọc được ResourceIdentifier.
|
Từ xa
WEAVE_ERROR FromTLV( nl::Weave::TLV::TLVReader & aReader, const uint64_t & aSelfNodeId )
Giải mã Mã nhận dạng tài nguyên từ biểu tượng TLV vào đối tượng này.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các thông số |
|
||||
Trả về |
WEAVE_NO_ERROR thành công. Lỗi từ TLV Reader nếu không đọc được ResourceIdentifier.
|
GetResourceId
uint64_t GetResourceId() const
Hàm truy cập để tìm nạp ResourceId.
Loại tài nguyên
uint16_t GetResourceType() const
Hàm truy cập để tìm nạp ResourceType.
Mã nhận dạng Resource
ResourceIdentifier()
Tạo ResourceIdentifier tương ứng với ResourceID chưa chỉ định.
Mã tài nguyên chưa chỉ định là một bộ tài nguyên bao gồm loại tài nguyên RESERVED có tài nguyên kNodeIdNotSpeficical.
Mã nhận dạng Resource
ResourceIdentifier( const uint64_t & aNodeId )
Tạo ResourceIdentifier của loại thiết bị dựa trên aNodeId nhất định.
Thông tin chi tiết | |||
---|---|---|---|
Các thông số |
|
Mã nhận dạng Resource
ResourceIdentifier( uint16_t aResourceType, const uint64_t & aResourceId )
Tạo ResourceIdentifier của loại được chỉ định với mã đã cho.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các thông số |
|
Mã nhận dạng Resource
ResourceIdentifier( uint16_t aResourceType, const uint8_t *aResourceId, size_t aResourceIdLen )
Tạo ResourceIdentifier của loại được chỉ định với mã đã cho.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các thông số |
|
ResourceTypeAsString
const char * ResourceTypeAsString( void ) const
Tạo một biểu diễn chuỗi của ResourceType.
Các loại tài nguyên được chuyển đổi là những loại được liệt kê trong ResourceTypeEnum.h và 0 (tương ứng với Resource_TYPE_RESERVED)
ToString
WEAVE_ERROR ToString( char *buffer, size_t bufferLen )
Chuyển đổi ResourceIdentifier thành một chuỗi có thể in.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các thông số |
|
Điều khoản dịch vụ
WEAVE_ERROR ToTLV( nl::Weave::TLV::TLVWriter & aWriter ) const
Sắp xếp tuần tự tài nguyên thành biểu diễn TLV bằng thẻ Đường dẫn::ResourceID.
Thông tin chi tiết | |||
---|---|---|---|
Các thông số |
|
Điều khoản dịch vụ
WEAVE_ERROR ToTLV( nl::Weave::TLV::TLVWriter & aWriter, const uint64_t & aTag ) const
Nối tiếp tài nguyên với một trang trình bày TLV bằng một thẻ nhất định.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các thông số |
|
Hàm tĩnh công khai
ResourceTypeAsString
const char * ResourceTypeAsString( uint16_t aResourceType )
Tạo một biểu diễn chuỗi của loại tài nguyên.
Các loại tài nguyên được chuyển đổi là những loại được liệt kê trong ResourceTypeEnum.h và 0 (tương ứng với Resource_TYPE_RESERVED)
Thông tin chi tiết | |||
---|---|---|---|
Các thông số |
|
Lớp học của bạn bè
toán tử==
friend bool operator==(const ResourceIdentifier &lhs, const ResourceIdentifier &rhs)