Package com.inductiveautomation.eventstream.rpc

Interface EventStreamRpc

All Known Implementing Classes:

GatewayEventStreamRpc

public interface EventStreamRpc

Field Summary

Fields

Modifier and Type	Field	Description
static final ProtoRpcSerializer	SERIALIZER

Method Summary

Modifier and Type	Method	Description
EventStreamDiagnostics	getDiagnostics(String projectName, String path)	Returns the current diagnostics for the given Event Stream.
List<EventStreamEncoder.Descriptor>	getEventStreamEncoders()	Returns a list of all available Event Stream encoders.
List<HandlerDescriptor>	getHandlerDescriptors()	List of all available Event Stream Handler descriptors.
List<SourceDescriptor>	getSourceDescriptors()	List of all available Event Stream Source descriptors.
EventStreamState	getState(String project, String path)	Returns the current state of the Event Stream.
List<EventStreamDescription>	listEventStreams(String project)	Returns a list of all Event Streams in the given project.
EventStreamDiagnostics	runEventStream(String projectName, String path, EventStreamConfig config, EventStreamRunConfig runConfig)	Starts the Event Stream with the given configuration.

Field Details

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

Method Details

getSourceDescriptors

List<SourceDescriptor> getSourceDescriptors()

List of all available Event Stream Source descriptors.

getHandlerDescriptors

List<HandlerDescriptor> getHandlerDescriptors()

List of all available Event Stream Handler descriptors.

getEventStreamEncoders

List<EventStreamEncoder.Descriptor> getEventStreamEncoders()

Returns a list of all available Event Stream encoders.

Returns:

List of Event Stream encoder descriptors

listEventStreams

List<EventStreamDescription> listEventStreams(String project)

Returns a list of all Event Streams in the given project.

Parameters:

project - Project name

Returns:

List of Event Stream descriptions

getDiagnostics

EventStreamDiagnostics getDiagnostics(String projectName,
 String path)

Returns the current diagnostics for the given Event Stream.

Parameters:

projectName - Project name

path - Path to Event Stream

Returns:

Current diagnostics for the Event Stream

runEventStream

EventStreamDiagnostics runEventStream(String projectName,
 String path,
 EventStreamConfig config,
 EventStreamRunConfig runConfig)

Starts the Event Stream with the given configuration. Stops immediately after the first event.

Parameters:

projectName - Project name

path - Path to Event Stream

config - Configuration for the Event Stream

runConfig - Run configuration for the Event Stream

Returns:

Current diagnostics for the Event Stream

getState

EventStreamState getState(String project,
 String path)

Returns the current state of the Event Stream.

Parameters:

project - Project name

path - Path to Event Stream

Returns:

Current state of the Event Stream