Package org.apache.plc4x.java.scraper.triggeredscraper.triggerhandler.collector

Interface TriggerCollector

All Known Implementing Classes:

TriggerCollectorImpl

public interface TriggerCollector

defines the interface for implementing a TriggerCollector that handles and acquires all triggerRequests at once that needs a PlcConnection

Method Summary

Modifier and Type	Method	Description
Object	requestResult(String uuid)	requests the result of submitted plc request with default timeout
Object	requestResult(String uuid, long timeout)	requests the result of submitted plc request
void	start()	starts the acquirement of triggers
void	stop()	stops acquirement of triggers
String	submitTrigger(String tag, String plcConnectionString, long maxAwaitingTime)	submits a trigger request to TriggerCollector

Method Detail

submitTrigger

String submitTrigger(String tag,
                     String plcConnectionString,
                     long maxAwaitingTime)
              throws ScraperException

submits a trigger request to TriggerCollector

Parameters:

tag - a (plc) tag that is used for triggering procedure

plcConnectionString - the connection string to the regarding source

maxAwaitingTime - max awaiting time until request shall be submitted

Returns:

a uuid under that the request is handled internally

Throws:

ScraperException - something went wrong

requestResult

Object requestResult(String uuid)
              throws ScraperException

requests the result of submitted plc request with default timeout

Parameters:

uuid - uuid that represents the request

Returns:

the object acquired by requesting plc instance

Throws:

ScraperException - something went wrong

requestResult

Object requestResult(String uuid,
                     long timeout)
              throws ScraperException

requests the result of submitted plc request

Parameters:

uuid - uuid that represents the request

timeout - timeout until response shall be acquired

Returns:

the object acquired by requesting plc instance

Throws:

ScraperException - something went wrong

start

void start()

starts the acquirement of triggers

stop

void stop()

stops acquirement of triggers