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
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
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
pacer
protected
readonly
pacer:undefined
|PublishPacer
<HEvent
>
Defined in: src/sdk/instruments/BasePublishers.ts:13
Inherited from
publishActive
protected
publishActive:boolean
Defined in: src/sdk/instruments/BasePublishers.ts:12
Inherited from
publisher
Defined in: src/sdk/instruments/BasePublishers.ts:11
Inherited from
Methods
dispatchHEvent()
dispatchHEvent(
hEvent
,sync
):void
Defined in: src/sdk/data/HEventPublisher.ts:20
Dispatches an H:Event to the event bus.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
hEvent | string | undefined | The H:Event to dispatch. |
sync | boolean | false | Whether 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
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
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
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
startPublish()
startPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:30
Start publishing.
Returns
void
Inherited from
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void