Skip to main content

Class: HEventPublisher

Defined in: src/sdk/data/HEventPublisher.ts:14

A publisher for publishing H:Events on the bus.

Extends

Constructors

Constructor

new HEventPublisher(bus, pacer): HEventPublisher

Defined in: src/sdk/instruments/BasePublishers.ts:20

Creates an instance of BasePublisher.

Parameters

ParameterTypeDefault valueDescription
busEventBusundefinedThe common event bus.
pacerundefined | PublishPacer<HEvent>undefinedAn optional pacer to control the rate of publishing.

Returns

HEventPublisher

Inherited from

BasePublisher.constructor

Properties

bus

protected readonly bus: EventBus

Defined in: src/sdk/instruments/BasePublishers.ts:10

Inherited from

BasePublisher.bus


pacer

protected readonly pacer: undefined | PublishPacer<HEvent>

Defined in: src/sdk/instruments/BasePublishers.ts:13

Inherited from

BasePublisher.pacer


publishActive

protected publishActive: boolean

Defined in: src/sdk/instruments/BasePublishers.ts:12

Inherited from

BasePublisher.publishActive


publisher

protected readonly publisher: Publisher<HEvent>

Defined in: src/sdk/instruments/BasePublishers.ts:11

Inherited from

BasePublisher.publisher

Methods

dispatchHEvent()

dispatchHEvent(hEvent, sync): void

Defined in: src/sdk/data/HEventPublisher.ts:20

Dispatches an H:Event to the event bus.

Parameters

ParameterTypeDefault valueDescription
hEventstringundefinedThe H:Event to dispatch.
syncbooleanfalseWhether this event should be synced (optional, default false)

Returns

void


isPublishing()

isPublishing(): boolean

Defined in: src/sdk/instruments/BasePublishers.ts:45

Tells whether or not the publisher is currently active.

Returns

boolean

True if the publisher is active, false otherwise.

Inherited from

BasePublisher.isPublishing


onUpdate()

onUpdate(): void

Defined in: src/sdk/instruments/BasePublishers.ts:52

A callback called when the publisher receives an update cycle.

Returns

void

Inherited from

BasePublisher.onUpdate


publish()

protected publish<K>(topic, data, sync, isCached): void

Defined in: src/sdk/instruments/BasePublishers.ts:63

Publish a message if publishing is acpive

Type Parameters

Type Parameter
K extends "hEvent"

Parameters

ParameterTypeDefault valueDescription
topicKundefinedThe topic key to publish to.
dataHEvent[K]undefinedThe data type for chosen topic.
syncbooleanfalseWhether or not the event should be synced to other instruments. Defaults to false.
isCachedbooleantrueWhether or not the event should be cached. Defaults to true.

Returns

void

Inherited from

BasePublisher.publish


startPublish()

startPublish(): void

Defined in: src/sdk/instruments/BasePublishers.ts:30

Start publishing.

Returns

void

Inherited from

BasePublisher.startPublish


stopPublish()

stopPublish(): void

Defined in: src/sdk/instruments/BasePublishers.ts:37

Stop publishing.

Returns

void

Inherited from

BasePublisher.stopPublish