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 |
Các 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 với khoá.
|
Flags
|
uint8_t
Nhiều cờ liên quan đến phiên.
|
MaxRcvdMsgId
|
uint32_t
Mã tin nhắn tối đa nhận được theo khoá phiên.
|
MsgEncKey
|
Khoá mã hoá thư Weave.
|
NextMsgId
|
Mã tin nhắn tiếp theo sẽ được dùng bên dưới khoá phiên.
|
NodeId
|
uint64_t
Mã của nút mà khoá phiên được chia sẻ.
|
RcvFlags
|
WeaveSessionState::ReceiveFlagsType
Gắn cờ theo dõi tin nhắn 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 thời gian 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ó nên tự động xoá sau một khoảng thời gian không hoạt động hay không.
|
SetSharedSession(bool val)
|
void
Đặt cờ cho biết phiên đó 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ộ khởi tạo. |
kFlag_IsRemoveOnIdle
|
Phiên sẽ bị xoá khi ở trạng thái rảnh (chỉ áp dụng cho các phiên không liên kết với kết nối). |
kFlag_IsSharedSession
|
Phiên này là phiên được chia sẻ. |
kFlag_RecentlyActive
|
Phiên này mới hoạt động gần đây. |
kFlag_Suspended
|
Phiên đã bị tạm ngưng. |
Các 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.
MaxRcvdMsgId
uint32_t MaxRcvdMsgId
Mã tin nhắn tối đa nhận được theo khoá phiên.
NextMsgId
MonotonicallyIncreasingCounter NextMsgId
Mã tin nhắn tiếp theo sẽ được dùng bên dưới 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ờ theo dõi tin nhắn 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
| Chi tiết | |
|---|---|
| Trả về |
Đúng nếu đối tượng WeaveSessionKey được phân bổ.
|
IsKeySet
bool IsKeySet() const
| Chi tiết | |
|---|---|
| Trả về |
Đúng nếu giá trị khoá mã hoá đã được đặt trong đối tượng WeaveSessionKey.
|
IsLocallyInitiated
bool IsLocallyInitiated() const
| Chi tiết | |
|---|---|
| Trả về |
Đúng nếu phiên do nút cục bộ khởi tạo.
|
IsRecentlyActive
bool IsRecentlyActive() const
| Chi tiết | |
|---|---|
| Trả về |
Đúng nếu phiên đã hoạt động trong thời gian gần đây.
|
IsRemoveOnIdle
bool IsRemoveOnIdle() const
| Chi tiết | |
|---|---|
| Trả về |
Đúng nếu phiên bị gắn cờ để tự động xoá khi phiên hoạt động 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 thời gian 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ó nên tự động xoá sau một khoảng thời gian không hoạt động hay không.
| Chi tiết | |||
|---|---|---|---|
| Tham số |
|
||
SetSharedSession
void SetSharedSession( bool val )
Đặt cờ cho biết phiên đó có phải là phiên được chia sẻ hay không.
| Chi tiết | |||
|---|---|---|---|
| Tham số |
|
||