Class EventQueue

Event interface to add blockchain events to the event queue.

Hierarchy

EventQueue

Index

Constructors

Properties

_defaultTopics _events _height

Methods

add createSnapshot getChildQueue getEvents restoreSnapshot unsafeAdd

Constructors

constructor

new EventQueue(height: number, events?: RevertibleEvent[], defaultTopics?: Buffer[]): EventQueue
Parameters
- height: number
- Optional events: RevertibleEvent[]
- Optional defaultTopics: Buffer[]
Returns EventQueue
- Defined in framework/src/state_machine/event_queue.ts:28

Properties

`Private` `Readonly` _defaultTopics

_defaultTopics: Buffer[]

`Private` `Readonly` _events

_events: RevertibleEvent[]

`Private` `Readonly` _height

_height: number

Methods

add

add(module: string, name: string, data: Buffer, topics?: Buffer[], noRevert?: boolean): void
Parameters
- module: string
- name: string
- data: Buffer
- Optional topics: Buffer[]
- Optional noRevert: boolean
Returns void
- Defined in framework/src/state_machine/event_queue.ts:34

createSnapshot

createSnapshot(): number
Returns number
- Defined in framework/src/state_machine/event_queue.ts:81

getChildQueue

getChildQueue(topicID: Buffer): EventQueue
Parameters
- topicID: Buffer
Returns EventQueue
- Defined in framework/src/state_machine/event_queue.ts:77

getEvents

getEvents(): Event[]
Returns Event[]
- Defined in framework/src/state_machine/event_queue.ts:99

restoreSnapshot

restoreSnapshot(snapshotID: number): void
Parameters
- snapshotID: number
Returns void
- Defined in framework/src/state_machine/event_queue.ts:85

unsafeAdd

unsafeAdd(module: string, name: string, data: Buffer, topics?: Buffer[], noRevert?: boolean): void
Parameters
- module: string
- name: string
- data: Buffer
- Optional topics: Buffer[]
- Optional noRevert: boolean
Returns void
- Defined in framework/src/state_machine/event_queue.ts:56

Generated using TypeDoc