EventStreamSource

All Known Implementing Classes:: FileSource, GatewayEventSource, LastEventSource, SuppliedSource, TagEventSource

public interface EventStreamSource

Provides EventPayload to the Event Stream through the EventStreamSource.Subscriber interface.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

EventStreamSource.Factory

Registered with EventStreamRegistry to create concrete implementation of EventStreamSource from the provided configuration.

static interface

EventStreamSource.Subscriber

Interface for submitting events to the Event Stream.
Method Summary

Modifier and Type

Method

Description

void

onShutdown()

Called on EventStreamSource shutdown.

void

onStartup(EventStreamSource.Subscriber subscriber)

Called on Event Stream startup.

Method Details
- onStartup
  
  void onStartup(EventStreamSource.Subscriber subscriber)
  
  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).
- onShutdown
  
  void onShutdown()
  
  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.