EventStreamHandler.Factory

All Superinterfaces:: EventStreamRegistry.Item

Enclosing interface:: EventStreamHandler

public static interface EventStreamHandler.Factory extends EventStreamRegistry.Item

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

Method Summary

Modifier and Type

Method

Description

EventStreamHandler

create(EventStreamContext context, com.inductiveautomation.ignition.common.gson.JsonObject jsonConfig)

Called once when Event Stream is first created.

HandlerDescriptor

getDescriptor()

default String

getTypeId()

Method Details
- getTypeId
  
  default String getTypeId()
  
  Specified by:
  
  getTypeId in interface EventStreamRegistry.Item
- getDescriptor
  
  HandlerDescriptor getDescriptor()
- create
  
  EventStreamHandler create(EventStreamContext context, com.inductiveautomation.ignition.common.gson.JsonObject jsonConfig) throws Exception
  
  Called once when Event Stream is first created.
  
  Parameters:
  
  context - EventStreamContext
  
  jsonConfig - EventStreamHandler configuration that defines its behavior
  
  Returns:
  
  EventStreamSource
  
  Throws:
  
  Exception