Class DbSyncEpochPollService

Class to handle epoch rollover through db polling

Hierarchy

DbSyncEpochPollService

Implements

EpochMonitor

Index

Constructors

Properties

#callbacks #currentEpoch #db #interval #timeoutId?

Methods

#executePoll #queryLastEpoch #shutdown #start getLastKnownEpoch onEpoch onEpochRollover

Constructors

constructor

new DbSyncEpochPollService(db: Pool, interval: number): DbSyncEpochPollService
Parameters
- db: Pool
  
  Db connection
- interval: number
  
  Polling interval in ms
Returns DbSyncEpochPollService
- Defined in packages/cardano-services/src/util/polling/DbSyncEpochPollService.ts:25

Properties

`Private` #callbacks

#callbacks: Function[]

`Private` #currentEpoch

#currentEpoch: Promise<null | EpochNo>

`Private` #db

#db: Pool

Db connection

`Private` #interval

#interval: number

Polling interval in ms

`Private` `Optional` #timeoutId

#timeoutId?: Timer

Methods

`Private` #executePoll

#executePoll(): Promise<void>
Poll execution to detect a new epoch rollover Upon the occurrence of rollover event it executes all callbacks by registered dependant services

Returns Promise<void>
- Defined in packages/cardano-services/src/util/polling/DbSyncEpochPollService.ts:36

`Private` #queryLastEpoch

#queryLastEpoch(): Promise<EpochNo>
Query the last epoch number stored in db

Returns
epoch number

Returns Promise<EpochNo>
- Defined in packages/cardano-services/src/util/polling/DbSyncEpochPollService.ts:49

`Private` #shutdown

#shutdown(): void
Shutdown the poll execution

Returns void
- Defined in packages/cardano-services/src/util/polling/DbSyncEpochPollService.ts:66

`Private` #start

#start(): void
Starts the poll execution

Returns void
- Defined in packages/cardano-services/src/util/polling/DbSyncEpochPollService.ts:58

getLastKnownEpoch

getLastKnownEpoch(): Promise<null | EpochNo>
Get last known epoch

Returns Promise<null | EpochNo>
- Defined in packages/cardano-services/src/util/polling/DbSyncEpochPollService.ts:81

onEpoch

onEpoch(currentEpoch: EpochNo): void
Parameters
- currentEpoch: EpochNo
Returns void
Implementation of EpochMonitor.onEpoch
- Defined in packages/cardano-services/src/util/polling/DbSyncEpochPollService.ts:85

onEpochRollover

onEpochRollover(cb: Function): (() => void)
Epoch Rollover event - subscription-based mechanism to manage starting and stopping of epoch poll service
Parameters
- cb: Function
Returns (() => void)
- - (): void
  - Returns void
Implementation of EpochMonitor.onEpochRollover
- Defined in packages/cardano-services/src/util/polling/DbSyncEpochPollService.ts:71

Generated using TypeDoc