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 )
セッションが共有セッションかどうかを示すフラグを設定します。
| 詳細 | |||
|---|---|---|---|
| パラメータ |
|
||