nl::
#include <src/lib/core/WeaveFabricState.h>
Chứa thông tin về khoá phiên Weave.
Tóm tắt
Loại công khai |
|
|---|---|
FlagsEnum{
|
enum |
Thuộc tính công khai |
|
|---|---|
AuthMode
|
WeaveAuthMode
Phương tiện mà nút ngang hàng đã được xác thực trong quá trình thiết lập phiên.
|
BoundCon
|
Kết nối mà khoá được liên kết.
|
Flags
|
uint8_t
Nhiều cờ liên quan đến phiên này.
|
MaxRcvdMsgId
|
uint32_t
Mã thông báo tối đa nhận được dưới khoá phiên.
|
MsgEncKey
|
Khoá mã hoá tin nhắn Weave.
|
NextMsgId
|
Mã thông báo tiếp theo sẽ được dùng trong khoá phiên.
|
NodeId
|
uint64_t
Mã của nút mà khoá phiên được chia sẻ.
|
RcvFlags
|
WeaveSessionState::ReceiveFlagsType
Gắn cờ thông báo theo dõi nhận được dưới khoá.
|
ReserveCount
|
uint8_t
Số lần khoá phiên đã được đặt trước.
|
Hàm công khai |
|
|---|---|
Clear(void)
|
void
Đặt lại đối tượng WeaveSessionKey.
|
ClearRecentlyActive()
|
void
Báo hiệu phiên đó là KHÔNG hoạt động trong quá khứ gần đây.
|
ClearSuspended()
|
void
|
Init(void)
|
void
Khởi động một đối tượng WeaveSessionKey.
|
IsAllocated() const
|
bool
|
IsKeySet() const
|
bool
|
IsLocallyInitiated() const
|
bool
|
IsRecentlyActive() const
|
bool
|
IsRemoveOnIdle() const
|
bool
|
IsSharedSession() const
|
bool
|
IsSuspended() const
|
bool
|
MarkRecentlyActive()
|
void
Báo hiệu phiên đó là đã hoạt động trong quá khứ gần đây.
|
MarkSuspended()
|
void
|
SetLocallyInitiated(bool val)
|
void
|
SetRemoveOnIdle(bool val)
|
void
Đặt một cờ cho biết liệu phiên có tự động bị xoá sau một khoảng thời gian không hoạt động hay không.
|
SetSharedSession(bool val)
|
void
Đặt một cờ cho biết phiên này có phải là phiên được chia sẻ hay không.
|
Loại công khai
FlagsEnum
FlagsEnum
| Thuộc tính | |
|---|---|
kFlag_IsLocallyInitiated
|
Phiên do nút cục bộ bắt đầu. |
kFlag_IsRemoveOnIdle
|
Phiên cần được xoá khi không hoạt động (chỉ áp dụng cho các phiên không được liên kết với một kết nối). |
kFlag_IsSharedSession
|
Phiên này là một phiên được chia sẻ. |
kFlag_RecentlyActive
|
Phiên này mới hoạt động gần đây. |
kFlag_Suspended
|
Phiên sự kiện đã bị tạm ngưng. |
Thuộc tính công khai
AuthMode
WeaveAuthMode AuthMode
Phương tiện mà nút ngang hàng đã được xác thực trong quá trình thiết lập phiên.
Cờ
uint8_t Flags
Nhiều cờ liên quan đến phiên này.
MaxRcvdMsgId
uint32_t MaxRcvdMsgId
Mã thông báo tối đa nhận được dưới khoá phiên.
NextMsgId
MonotonicallyIncreasingCounter NextMsgId
Mã thông báo tiếp theo sẽ được dùng trong khoá phiên.
NodeId
uint64_t NodeId
Mã của nút mà khoá phiên được chia sẻ.
RcvFlags
WeaveSessionState::ReceiveFlagsType RcvFlags
Gắn cờ thông báo theo dõi nhận được dưới khoá.
ReserveCount
uint8_t ReserveCount
Số lần khoá phiên đã được đặt trước.
Hàm công khai
ClearRecentlyActive
void ClearRecentlyActive()
Báo hiệu phiên đó là KHÔNG hoạt động trong quá khứ gần đây.
ClearSuspended
void ClearSuspended()
IsAllocated
bool IsAllocated() const
| Thông tin chi tiết | |
|---|---|
| Trả về |
Đúng nếu đối tượng WeaveSessionKey được phân bổ.
|
IsKeySet
bool IsKeySet() const
| Thông tin chi tiết | |
|---|---|
| Trả về |
Đúng nếu giá trị khoá mã hoá đã được đặt trong đối tượng WeaveSessionKey.
|
IsLocallyInitiated
bool IsLocallyInitiated() const
| Thông tin chi tiết | |
|---|---|
| Trả về |
Đúng nếu phiên do nút cục bộ bắt đầu.
|
IsRecentlyActive
bool IsRecentlyActive() const
| Thông tin chi tiết | |
|---|---|
| Trả về |
Đúng nếu phiên đó đã hoạt động gần đây.
|
IsRemoveOnIdle
bool IsRemoveOnIdle() const
| Thông tin chi tiết | |
|---|---|
| Trả về |
Đúng nếu phiên bị gắn cờ để tự động xoá khi không hoạt động trong một khoảng thời gian.
|
IsSharedSession
bool IsSharedSession() const
IsSuspended
bool IsSuspended() const
MarkRecentlyActive
void MarkRecentlyActive()
Báo hiệu phiên đó là đã hoạt động trong quá khứ gần đây.
MarkSuspended
void MarkSuspended()
SetLocallyInitiated
void SetLocallyInitiated( bool val )
SetRemoveOnIdle
void SetRemoveOnIdle( bool val )
Đặt một cờ cho biết liệu phiên có tự động bị xoá sau một khoảng thời gian không hoạt động hay không.
| Thông tin chi tiết | |||
|---|---|---|---|
| Các tham số |
|
||
SetSharedSession
void SetSharedSession( bool val )
Đặt một cờ cho biết phiên này có phải là phiên được chia sẻ hay không.
| Thông tin chi tiết | |||
|---|---|---|---|
| Các tham số |
|
||