nl::Weave::WeaveSessionKey

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

Weave セッション キーに関する情報が含まれています。

まとめ

パブリック タイプ

FlagsEnum{
  kFlag_IsLocallyInitiated = 0x01,
  kFlag_IsSharedSession = 0x02,
  kFlag_IsRemoveOnIdle = 0x04,
  kFlag_RecentlyActive = 0x08,
  kFlag_Suspended = 0x10
}
列挙型

パブリック属性

AuthMode
WeaveAuthMode
セッション確立中にピアノードが認証された方法。
BoundCon
キーがバインドされる接続。
Flags
uint8_t
セッションに関連するさまざまなフラグ。
MaxRcvdMsgId
uint32_t
セッションキーで受け取った最大メッセージ ID。
MsgEncKey
Weave メッセージ暗号鍵。
NextMsgId
セッション キーの下で使用される次のメッセージ ID。
NodeId
uint64_t
セッションキーが共有されているノードの ID。
RcvFlags
WeaveSessionState::ReceiveFlagsType
キーで受信したメッセージをトラッキングするフラグ。
ReserveCount
uint8_t
セッションキーが予約された回数。

パブリック関数

Clear(void)
void
WeaveSessionKey オブジェクトをリセットします。
ClearRecentlyActive()
void
セッションが最近アクティブではなかったことを示します。
ClearSuspended()
void
Init(void)
void
WeaveSessionKey オブジェクトを初期化します。
IsAllocated() const
bool
IsKeySet() const
bool
IsLocallyInitiated() const
bool
IsRecentlyActive() const
bool
IsRemoveOnIdle() const
bool
IsSharedSession() const
bool
IsSuspended() const
bool
MarkRecentlyActive()
void
セッションが最近アクティブだったことを示します。
MarkSuspended()
void
SetLocallyInitiated(bool val)
void
SetRemoveOnIdle(bool val)
void
一定期間の経過後に、セッションを自動的に削除するかどうかを指定するフラグを設定します。
SetSharedSession(bool val)
void
セッションが共有セッションかどうかを示すフラグを設定します。

パブリック タイプ

FlagsEnum

 FlagsEnum
Properties
kFlag_IsLocallyInitiated

セッションはローカルノードによって開始されました。

kFlag_IsRemoveOnIdle

セッションは、アイドル状態のときは削除する必要があります(接続にバインドされていないセッションにのみ適用されます)。

kFlag_IsSharedSession

セッションは共有セッションです。

kFlag_RecentlyActive

このセッションは最近有効でした。

kFlag_Suspended

セッションを停止しました。

パブリック属性

認証モード

WeaveAuthMode AuthMode

セッション確立中にピアノードが認証された方法。

BoundCon

WeaveConnection * BoundCon

キーがバインドされる接続。

フラグ

uint8_t Flags

セッションに関連するさまざまなフラグ。

MaxRcvdMsgId

uint32_t MaxRcvdMsgId

セッションキーで受け取った最大メッセージ ID。

MSENC キー

WeaveMsgEncryptionKey MsgEncKey

Weave メッセージ暗号鍵。

NextMsgId

MonotonicallyIncreasingCounter NextMsgId

セッション キーの下で使用される次のメッセージ ID。

ノード ID

uint64_t NodeId

セッションキーが共有されているノードの ID。

Rcvflags

WeaveSessionState::ReceiveFlagsType RcvFlags

キーで受信したメッセージをトラッキングするフラグ。

ReserveCount

uint8_t ReserveCount

セッションキーが予約された回数。

パブリック関数

クリア

void Clear(
  void
)

WeaveSessionKey オブジェクトをリセットします。

ClearRecentActive

void ClearRecentlyActive()

セッションが最近アクティブではなかったことを示します。

停止中

void ClearSuspended()

init

void Init(
  void
)

WeaveSessionKey オブジェクトを初期化します。

IsAllocated

bool IsAllocated() const 

詳細
戻り値
WeaveSessionKey オブジェクトが割り当てられている場合は true。

IsKeySet

bool IsKeySet() const 

詳細
戻り値
暗号鍵の値が WeaveSessionKey オブジェクトに設定されている場合は true。

ローカルで開始

bool IsLocallyInitiated() const 

詳細
戻り値
ローカルノードによってセッションが開始された場合は true。

IsRecentActive

bool IsRecentlyActive() const 

詳細
戻り値
セッションが最近アクティブであった場合は true。

IsRemoveOnIdle

bool IsRemoveOnIdle() const 

詳細
戻り値
一定期間アイドル状態のときに、セッションが自動削除であると示されている場合は true。

IsSharedSession

bool IsSharedSession() const 

停止

bool IsSuspended() const 

MarkRecentActive

void MarkRecentlyActive()

セッションが最近アクティブだったことを示します。

マーク停止中

void MarkSuspended()

SetLocallyInitiated

void SetLocallyInitiated(
  bool val
)

SetRemoveOnIdle

void SetRemoveOnIdle(
  bool val
)

一定期間の経過後に、セッションを自動的に削除するかどうかを指定するフラグを設定します。

詳細
パラメータ
[in] val
kFlag_IsRemoveOnIdle フラグに設定する値。

SetSharedSession

void SetSharedSession(
  bool val
)

セッションが共有セッションかどうかを示すフラグを設定します。

詳細
パラメータ
[in] val
kFlag_IsSharedSession フラグに設定する値。