nl::Weave::PersistedCounter

#include <src/lib/support/PersistedCounter.h>

カウンタを整数値として管理するクラス。再起動後も保持されることを目的としています。

概要

継承

継承元: nl::Weave::MonotonicallyIncreasingCounter

コンストラクタとデストラクタ
PersistedCounter(void)
~PersistedCounter(void)

パブリック関数
Advance(void)
virtual WEAVE_ERROR
現在のエポックが完了したら、カウンタを増やして永続ストレージに書き込みます。
AdvanceEpochRelative(uint32_t aValue)
Init(const nl::Weave::Platform::PersistedStorage::Key aId, uint32_t aEpoch)
PersistedCounter オブジェクトを初期化します。
SetValue(uint32_t value)
永続イベントからイベント カウンタを設定するために使用します。

パブリック関数

進める

virtual WEAVE_ERROR Advance(
  void
)

現在のエポックが完了したら、カウンタを増やして永続ストレージに書き込みます。

詳細
戻り値
永続ストレージへの書き込みによって返されたエラー。

AdvanceEpochRelative

WEAVE_ERROR AdvanceEpochRelative(
  uint32_t aValue
)

init

WEAVE_ERROR Init(
  const nl::Weave::Platform::PersistedStorage::Key aId,
  uint32_t aEpoch
)

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

詳細
パラメータ
[in] aId
この PersistedCounter インスタンスの ID。
[in] aEpoch
起動時に、販売する値はこのパラメータの倍数から始まります。
戻り値
aId が NULL の場合 WEAVE_ERROR_INVALID_ARGUMENT . aId が WEAVE_CONFIG_PERSISTED_STORAGE_MAX_KEY_LENGTH より長い場合、WEAVE_ERROR_INVALID_STRING_LENGTHaEpoch が 0 の場合、WEAVE_ERROR_INVALID_INTEGER_VALUE。それ以外の場合は WEAVE_NO_ERROR です。

PersistedCounter

 PersistedCounter(
  void
)

SetValue

WEAVE_ERROR SetValue(
  uint32_t value
)

永続イベントからイベント カウンタを設定するために使用されます。

~PersistedCounter

virtual  ~PersistedCounter(
  void
)