Server side cycle trigger methods A cycle trigger interface. More...
Public Member Functions | |
| void | update (int cycleNumber, int status) |
| Is processed following an incoming cycle number event. More... | |
Server side cycle trigger methods A cycle trigger interface.
The update() method will be called upon incoming cycle triggers (or system error). The current cycle number will be passed along with the status (usually 0).
| void de.desy.tine.server.equipment.TCycleTrigger.update | ( | int | cycleNumber, |
| int | status | ||
| ) |
Is processed following an incoming cycle number event.
If a CYCLER exists and a TCycleTrigger is in use, then its update routine will be called following the trigger event associated with the incoming cycle number or a link timeout notification.
By default a CYCLER is a server called "CYCLER" in the same context as the initializing device server and produces a keyword (property) called "CycleNumber". This gives rise to the Cycle Key: "/<context>/CYCLER/CycleNumber". If it is known a priori, that the CYCLER exists in another context or uses another server name or property name, the cycle key can be set via API (setCyclerNumberKey() in TEquipmentModule) or via environment (set TINE_CYCLE_KEY=<key>).
| cycleNumber | is the last arrived cycle number |
| status | is the cycle link status |
1.8.17