Class SvSubscriber<MappingEntry>

SVS-PS subscriber.

MappingEntry is a subclass of SvMappingEntry. If it is not SvMappingEntry base class, its constructor must be specified in Options.mappingEntryType.

Type Parameters

MappingEntry extends SvMappingEntry = SvMappingEntry

Hierarchy

TypedEventTarget<EventMap>
- SvSubscriber

Implements

Subscriber<Name, Update, SubscribeInfo<MappingEntry>>

Index

Constructors

Methods

close subscribe

Constructors

constructor

new SvSubscriber<MappingEntry>(__namedParameters): SvSubscriber<MappingEntry>
Type Parameters
- MappingEntry extends SvMappingEntry = SvMappingEntry
Parameters
- __namedParameters: SvSubscriber.Options
Returns SvSubscriber<MappingEntry>
Overrides TypedEventTarget<EventMap>.constructor
- Defined in sync/src/svs/subscriber.ts:29

Methods

close

close(): void
Stop subscriber operations. This does not stop the SvSync instance.

Returns void
- Defined in sync/src/svs/subscriber.ts:94

subscribe

subscribe(topic): Subscription<Name, Update>
Subscribe to either a topic prefix or a publisher node ID.
Parameters
- topic: SubscribeInfo<MappingEntry>
Returns Subscription<Name, Update>
Implementation of Subscriber.subscribe
- Defined in sync/src/svs/subscriber.ts:99

Generated using TypeDoc