nl :: Dệt :: WeaveSessionKey

#include <src/lib/core/WeaveFabricState.h>

Chứa thông tin về khóa phiên Weave.

Tóm lược

Các loại công khai
`FlagsEnum { kFlag_IsLocallyInitiated = 0x01, kFlag_IsSharedSession = 0x02, kFlag_IsRemoveOnIdle = 0x04, kFlag_RecentlyActive = 0x08, kFlag_Suspended = 0x10 }`	enum

Thuộc tính công cộng
`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`	`WeaveConnection *` Kết nối mà khóa được ràng buộc.
`Flags`	`uint8_t` Các cờ khác nhau được liên kết với phiên.
`MaxRcvdMsgId`	`uint32_t` Id tin nhắn tối đa nhận được trong khóa phiên.
`MsgEncKey`	`WeaveMsgEncryptionKey` Khóa mã hóa tin nhắn Weave.
`NextMsgId`	`MonotonicallyIncreasingCounter` Id tin nhắn tiếp theo sẽ được sử dụng trong khóa phiên.
`NodeId`	`uint64_t` Id 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 dưới phím.
`ReserveCount`	`uint8_t` Số lần khóa phiên đã được đặt trước.

Chức năng công cộng
`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 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 đã 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ó nên 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 phiên có phải là phiên được chia sẻ hay không.

Các loại công khai

FlagsEnum

 FlagsEnum

Tính chất
`kFlag_IsLocallyInitiated`	Phiên được bắt đầu bởi nút cục bộ.
`kFlag_IsRemoveOnIdle`	Phiên sẽ được 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 chia sẻ.
`kFlag_RecentlyActive`	Phiên hoạt động gần đây.
`kFlag_Suspended`	Phiên họp đã bị tạm dừng.

Thuộc tính công cộng

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.

BoundCon

WeaveConnection * BoundCon

Kết nối mà khóa được ràng buộc.

Cờ

uint8_t Flags

Các cờ khác nhau được liên kết với phiên.

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

Id tin nhắn tối đa nhận được trong khóa phiên.

MsgEncKey

WeaveMsgEncryptionKey MsgEncKey

Khóa mã hóa tin nhắn Weave.

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

Id tin nhắn tiếp theo sẽ được sử dụng trong khóa phiên.

NodeId

uint64_t NodeId

Id của nút mà khóa phiên được chia sẻ.

RcvFlags

WeaveSessionState::ReceiveFlagsType RcvFlags

Gắn cờ theo dõi tin nhắn nhận được dưới phím.

Dự trữ

uint8_t ReserveCount

Số lần khóa phiên đã được đặt trước.

Chức năng công cộng

Thông thoáng

void Clear(
  void
)

Đặt lại đối tượng WeaveSessionKey .

ClearRecentlyActive

void ClearRecentlyActive()

Báo hiệu phiên là KHÔNG hoạt động trong quá khứ gần đây.

ClearSuspended

void ClearSuspended()

Trong đó

void Init(
  void
)

Khởi tạo một đối tượng WeaveSessionKey .

IsAllocated

bool IsAllocated() const

Chi tiết
Lợi nhuận	Đúng nếu đối tượng WeaveSessionKey được cấp phát.

IsKeySet

bool IsKeySet() const

Chi tiết
Lợi nhuận	Đúng nếu giá trị khóa mã hóa đã được đặt trong đối tượng WeaveSessionKey .

IsLocallyInitiated

bool IsLocallyInitiated() const

Chi tiết
Lợi nhuận	Đúng nếu phiên được bắt đầu bởi nút cục bộ.

IsRecentlyActive

bool IsRecentlyActive() const

Chi tiết
Lợi nhuận	Đúng nếu phiên hoạt động trong quá khứ gần đây.

IsRemoveOnIdle

bool IsRemoveOnIdle() const

Chi tiết
Lợi nhuận	Đúng nếu phiên được gắn cờ để tự động xóa khi không hoạt động trong một khoảng thời gian.

IsSharedSession

bool IsSharedSession() const

Bị đình chỉ

bool IsSuspended() const

MarkRecentlyActive

void MarkRecentlyActive()

Báo hiệu phiên đã hoạt động trong quá khứ gần đây.

MarkSuspended

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

Đặt cờ cho biết liệu phiên có nên tự động bị xóa sau một khoảng thời gian không hoạt động hay không.

Chi tiết

Thông số

[in] val

Giá trị để đặt cờ kFlag_IsRemoveOnIdle thành.

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

Thông số

[in] val

Giá trị để đặt cờ kFlag_IsSharedSession thành.