Class: HEventPublisher

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

A publisher for publishing H events on the bus.

Extends

• BasePublisher<HEvent>

Constructors

Constructor

new HEventPublisher(bus, pacer): HEventPublisher

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

Creates an instance of BasePublisher.

Parameters

Parameter	Type	Default value	Description
bus	EventBus	undefined	The common event bus.
pacer	undefined | PublishPacer<HEvent>	undefined	An 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()

Call Signature

dispatchHEvent(hEvent, sync?): void

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

Dispatches an H event to the event bus. If the H event has arguments, then it will be published to the event bus under the hEvent_with_args topic. If the H event does not have any arguments, then it will be published to the event bus under the hEvent topic.

Parameters

Parameter	Type	Description
hEvent	readonly string[]	The name and arguments of the H event to dispatch. The name of the H event should be the first element of the array, followed by any arguments passed to the H event.
sync?	boolean	Whether this event should be synced to other instruments. Defaults to false.

Returns

void

Call Signature

dispatchHEvent(hEvent, sync?): void

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

Dispatches an H event without arguments to the event bus. The H event will be published under the hEvent topic.

Parameters

Parameter	Type	Description
hEvent	string	The name of the H event to dispatch.
sync?	boolean	Whether this event should be synced to other instruments. Defaults to false.

Returns

void

Deprecated

Please use the overload that takes an array of H event arguments instead.

---

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 keyof HEvent

Parameters

Parameter	Type	Default value	Description
topic	K	undefined	The topic key to publish to.
data	HEvent[K]	undefined	The data type for chosen topic.
sync	boolean	false	Whether or not the event should be synced to other instruments. Defaults to false.
isCached	boolean	true	Whether 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