An abstract class to be implemented by a client that will receive telemetry messages from the composition.
Use VuoRunner::setDelegate() to connect a VuoRunnerDelegate to a VuoRunner. The VuoRunner calls the VuoRunnerDelegate functions when it receives telemetry messages from the composition.
VuoRunner calls the VuoRunnerDelegate functions sequentially (not concurrently). VuoRunner waits for each VuoRunnerDelegate function call to return before it calls another. If VuoRunner receives additional telemetry messages while a VuoRunnerDelegate function call is in progress, the messages are enqueued and the additional VuoRunnerDelegate functions are called after the in-progress one completes.
When VuoRunner is replacing or stopping the composition, it waits for any in-progress VuoRunnerDelegate function calls to return.
Inherit from this class if you want to implement all of the delegate methods. If you'd only like to implement some delegate methods, inherit from VuoRunnerDelegateAdapter.
Definition at line 251 of file VuoRunner.hh.
Public Member Functions | |
virtual void | receivedTelemetryStats (unsigned long utime, unsigned long stime)=0 |
This delegate method is invoked twice per second, to provide a heartbeat indicating that the composition is still alive. More... | |
virtual void | receivedTelemetryNodeExecutionStarted (string compositionIdentifier, string nodeIdentifier)=0 |
This delegate method is invoked every time a node has started executing. More... | |
virtual void | receivedTelemetryNodeExecutionFinished (string compositionIdentifier, string nodeIdentifier)=0 |
This delegate method is invoked every time a node has finished executing. More... | |
virtual void | receivedTelemetryInputPortUpdated (string compositionIdentifier, string portIdentifier, bool receivedEvent, bool receivedData, string dataSummary)=0 |
This delegate method is invoked every time any input port receives an event or data. More... | |
virtual void | receivedTelemetryOutputPortUpdated (string compositionIdentifier, string portIdentifier, bool sentEvent, bool sentData, string dataSummary)=0 |
This delegate method is invoked every time any output port transmits/fires an event or data. More... | |
virtual void | receivedTelemetryPublishedOutputPortUpdated (VuoRunner::Port *port, bool sentData, string dataSummary)=0 |
This delegate method is invoked every time any published output port in the top-level composition transmits an event. More... | |
virtual void | receivedTelemetryEventDropped (string compositionIdentifier, string portIdentifier)=0 |
This delegate method is invoked every time any trigger port drops an event. More... | |
virtual void | receivedTelemetryError (string message)=0 |
This delegate method is invoked every time an uncaught error occurs in the composition. More... | |
virtual void | lostContactWithComposition (void)=0 |
This delegate method is invoked if the runner receives no telemetry messages from the composition for at least 1 second, indicating that the composition has crashed or quit on its own. More... | |
|
pure virtual |
This delegate method is invoked if the runner receives no telemetry messages from the composition for at least 1 second, indicating that the composition has crashed or quit on its own.
Implemented in VuoEditorComposition.
|
pure virtual |
This delegate method is invoked every time an uncaught error occurs in the composition.
message | A message with information about the error. |
|
pure virtual |
This delegate method is invoked every time any trigger port drops an event.
compositionIdentifier | A unique identifier representing the composition instance (top-level composition or a subcomposition within it) that contains the port. |
portIdentifier | A unique identifier representing the port that has dropped an event (see VuoCompilerEventPort::getIdentifier()). |
compositionIdentifier
argument. Implemented in VuoEditorComposition.
|
pure virtual |
This delegate method is invoked every time any input port receives an event or data.
compositionIdentifier | A unique identifier representing the composition instance (top-level composition or a subcomposition within it) that contains the port. |
portIdentifier | A unique identifier representing the port that has received an event or data (see VuoCompilerEventPort::getIdentifier()). |
receivedEvent | True if the port received an event. |
receivedData | True if the port received data. |
dataSummary | A brief description of the new data value of the port, or an empty string if the port is event-only. |
compositionIdentifier
argument. Implemented in VuoEditorComposition.
|
pure virtual |
This delegate method is invoked every time a node has finished executing.
compositionIdentifier | A unique identifier representing the composition instance (top-level composition or a subcomposition within it) that contains the node. |
nodeIdentifier | A unique identifier representing the node that finished executing (see VuoCompilerNode::getIdentifier()). |
compositionIdentifier
argument. Implemented in VuoEditorComposition.
|
pure virtual |
This delegate method is invoked every time a node has started executing.
compositionIdentifier | A unique identifier representing the composition instance (top-level composition or a subcomposition within it) that contains the node. |
nodeIdentifier | A unique identifier representing the node that started executing (see VuoCompilerNode::getIdentifier()). |
compositionIdentifier
argument. Implemented in VuoEditorComposition.
|
pure virtual |
This delegate method is invoked every time any output port transmits/fires an event or data.
compositionIdentifier | A unique identifier representing the composition instance (top-level composition or a subcomposition within it) that contains the port. |
portIdentifier | A unique identifier representing the port that has transmitted or fired an event (see VuoCompilerEventPort::getIdentifier()). |
sentEvent | True if the port sent an event. |
sentData | True if the port sent data. |
dataSummary | A brief description of the new data value of the port, or an empty string if the port is event-only. |
compositionIdentifier
, sentEvent
arguments. Implemented in VuoEditorComposition.
|
pure virtual |
This delegate method is invoked every time any published output port in the top-level composition transmits an event.
port | The VuoRunner::Port that has transmitted an event (see VuoRunner::getPublishedOutputPorts() and VuoRunner::getPublishedOutputPortWithName()). |
sentData | True if the port sent data along with the event. |
dataSummary | A brief description of the new data value of the port, or an empty string if the port is event-only. |
|
pure virtual |
This delegate method is invoked twice per second, to provide a heartbeat indicating that the composition is still alive.
It also provides some basic usage stats.
utime | The number of microseconds this process has spent in user-mode execution. |
stime | The number of microseconds spent in the system executing on behalf of this process. |