Package com.inductiveautomation.eventstream.gateway.sources

Class TagEventSource

java.lang.Object

com.inductiveautomation.eventstream.gateway.sources.TagEventSource

All Implemented Interfaces:

EventStreamSource

public class TagEventSource
extends Object
implements EventStreamSource

A source that listens for tag changes and publishes them as events. One listener is used for all tag paths provided in config. Individual listeners are created for each tag path on received event. This allows for a wildcard subscription to track changes to individual tag paths.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.eventstream.gateway.api.EventStreamSource

EventStreamSource.Factory, EventStreamSource.Subscriber

Constructor Summary

Constructors

Constructor	Description
TagEventSource(TagManager tagManager, TagEventSourceConfig config, com.inductiveautomation.ignition.common.tags.config.model.TagReferenceLocation tagRefLocation)

Method Summary

Modifier and Type	Method	Description
static EventStreamSource.Factory	createFactory(TagManager tagManager)
void	onShutdown()	Called on EventStreamSource shutdown.
void	onStartup(EventStreamSource.Subscriber subscriber)	Called on Event Stream startup.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TagEventSource

public TagEventSource(TagManager tagManager,
 TagEventSourceConfig config,
 com.inductiveautomation.ignition.common.tags.config.model.TagReferenceLocation tagRefLocation)

Method Details

createFactory

public static EventStreamSource.Factory createFactory(TagManager tagManager)

onStartup

public void onStartup(EventStreamSource.Subscriber subscriber)

Description copied from interface: EventStreamSource

Called on Event Stream startup. Events can safely be sent to EventStreamSource.Subscriber.submitEvents(java.util.List<com.inductiveautomation.eventstream.EventPayload>) or EventStreamSource.Subscriber.submitEvent(com.inductiveautomation.eventstream.EventPayload).

Specified by:

onStartup in interface EventStreamSource

onShutdown

public void onShutdown()

Description copied from interface: EventStreamSource

Called on EventStreamSource shutdown. No more events should be sent through EventStreamSource.Subscriber. If events are submitted after, they'll immediately complete with Error result.

Specified by:

onShutdown in interface EventStreamSource