nl::
#include <src/lib/core/WeaveFabricState.h>
Weave セッションキーに関する情報が含まれています。
概要
パブリック タイプ |
|
|---|---|
FlagsEnum{
|
enum |
パブリック属性 |
|
|---|---|
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
| プロパティ | |
|---|---|
kFlag_IsLocallyInitiated
|
セッションがローカルノードによって開始されました。 |
kFlag_IsRemoveOnIdle
|
アイドル状態のときはセッションを削除する必要があります（接続にバインドされていないセッションにのみ適用されます）。 |
kFlag_IsSharedSession
|
このセッションは共有セッションです。 |
kFlag_RecentlyActive
|
セッションが最近アクティブになりました。 |
kFlag_Suspended
|
セッションは一時停止されました。 |
パブリック属性
AuthMode
WeaveAuthMode AuthMode
セッションの確立中にピアノードが認証された手段。
フラグ
uint8_t Flags
セッションに関連するさまざまなフラグ。
MaxRcvdMsgId
uint32_t MaxRcvdMsgId
セッションキーで受信した最大メッセージ ID。
NodeId
uint64_t NodeId
セッションキーを共有するノードの ID。
RcvFlags
WeaveSessionState::ReceiveFlagsType RcvFlags
キーで受信したトラッキング メッセージにフラグを設定します。
ReserveCount
uint8_t ReserveCount
セッションキーが予約された回数。
パブリック関数
ClearRecentlyActive
void ClearRecentlyActive()
最近セッションがアクティブでなかったことを通知します。
ClearSuspended
void ClearSuspended()
IsLocallyInitiated
bool IsLocallyInitiated() const
| 詳細 | |
|---|---|
| 戻り値 |
セッションがローカルノードによって開始された場合は true。
|
IsRecentlyActive
bool IsRecentlyActive() const
| 詳細 | |
|---|---|
| 戻り値 |
セッションが最近アクティブだった場合は true。
|
IsRemoveOnIdle
bool IsRemoveOnIdle() const
| 詳細 | |
|---|---|
| 戻り値 |
アイドル状態が一定時間続いたときにセッションの自動削除のフラグが立てられた場合は true。
|
IsSharedSession
bool IsSharedSession() const
IsSuspended
bool IsSuspended() const
MarkRecentlyActive
void MarkRecentlyActive()
セッションが最近アクティブであったことを通知します。
MarkSuspended
void MarkSuspended()
SetLocallyInitiated
void SetLocallyInitiated( bool val )
SetRemoveOnIdle
void SetRemoveOnIdle( bool val )
アイドル時間が経過した後にセッションを自動的に削除するかどうかを示すフラグを設定します。
| 詳細 | |||
|---|---|---|---|
| パラメータ |
|
||
SetSharedSession
void SetSharedSession( bool val )
セッションが共有セッションかどうかを示すフラグを設定します。
| 詳細 | |||
|---|---|---|---|
| パラメータ |
|
||