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