Class PersistedMessageCounter

Enhanced Message counter that can be persisted and will be initialized from the persisted value (if existing).

Hierarchy (view full)

MessageCounter
- PersistedMessageCounter

Index

Constructors

Properties

aboutToRolloverCallback? messageCounter rolloverInfoDifference

Accessors

Methods

getIncrementedCounter create

Constructors

constructor

new PersistedMessageCounter(storageContext, storageKey, aboutToRolloverCallback?, rolloverInfoDifference?): PersistedMessageCounter
Parameters
- storageContext: StorageContext<any>
- storageKey: string
- OptionalaboutToRolloverCallback: (() => void)
  - - (): void
    - Returns void
- OptionalrolloverInfoDifference: number
Returns PersistedMessageCounter
Overrides MessageCounter.constructor
- Defined in packages/protocol/dist/esm/protocol/MessageCounter.d.ts:54

Properties

`Protected` `Optional` `Readonly`aboutToRolloverCallback

aboutToRolloverCallback?: (() => void)

`Protected`messageCounter

messageCounter: number

`Protected` `Readonly`rolloverInfoDifference

rolloverInfoDifference: number

Accessors

construction

get construction(): Construction<PersistedMessageCounter>
Returns Construction<PersistedMessageCounter>
- Defined in packages/protocol/dist/esm/protocol/MessageCounter.d.ts:52

Methods

getIncrementedCounter

getIncrementedCounter(): Promise<number>
Returns Promise<number>
Overrides MessageCounter.getIncrementedCounter
- Defined in packages/protocol/dist/esm/protocol/MessageCounter.d.ts:55

`Static`create

create(storageContext, storageKey, aboutToRolloverCallback?, rolloverInfoDifference?): Promise<PersistedMessageCounter>
Parameters
- storageContext: StorageContext<any>
- storageKey: string
- OptionalaboutToRolloverCallback: (() => void)
  - - (): void
    - Returns void
- OptionalrolloverInfoDifference: number
Returns Promise<PersistedMessageCounter>
- Defined in packages/protocol/dist/esm/protocol/MessageCounter.d.ts:53