Vuo  0.3
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Enumerations | Functions
VuoTelemetry.h File Reference

Description

VuoTelemetry interface.

Enumerations

enum  VuoControlRequest {
  VuoControlRequestCompositionStop, VuoControlRequestCompositionPause, VuoControlRequestCompositionUnpause, VuoControlRequestCompositionHibernate,
  VuoControlRequestPortValueModify, VuoControlRequestPortValueRetrieve, VuoControlRequestPublishedInputPortNamesRetrieve, VuoControlRequestPublishedOutputPortNamesRetrieve,
  VuoControlRequestPublishedInputPortTypesRetrieve, VuoControlRequestPublishedOutputPortTypesRetrieve, VuoControlRequestPublishedInputPortConnectedIdentifiersRetrieve, VuoControlRequestPublishedOutputPortConnectedIdentifiersRetrieve,
  VuoControlRequestPublishedInputPortGenerateEvent
}
 Control Requests, sent by the Vuo Editor. More...
 
enum  VuoControlReply {
  VuoControlReplyCompositionStopping, VuoControlReplyCompositionPaused, VuoControlReplyCompositionUnpaused, VuoControlReplyCompositionHibernated,
  VuoControlReplyPortValueModified, VuoControlReplyPortValueRetrieved, VuoControlReplyPublishedInputPortNamesRetrieved, VuoControlReplyPublishedOutputPortNamesRetrieved,
  VuoControlReplyPublishedInputPortTypesRetrieved, VuoControlReplyPublishedOutputPortTypesRetrieved, VuoControlReplyPublishedInputPortConnectedIdentifiersRetrieved, VuoControlReplyPublishedOutputPortConnectedIdentifiersRetrieved,
  VuoControlReplyPublishedInputPortGeneratedEvent
}
 Control Replies, sent by the built composition. More...
 
enum  VuoTelemetry {
  VuoTelemetryStats, VuoTelemetryNodeExecutionStarted, VuoTelemetryNodeExecutionFinished, VuoTelemetryPortValuesChanged,
  VuoTelemetryEdgeHit
}
 Types of published telemetry data. More...
 

Functions

char * copyStringFromMessage (zmq_msg_t *message)
 Copies the message data into a newly allocated string.
 
char * receiveAndCopyString (void *socket)
 Receives the next message on the socket and copies it into a newly allocated string.
 
unsigned long receiveUnsignedLong (void *socket)
 Receives the next message on the socket and copies it into an unsigned long.
 

Enumeration Type Documentation

Control Replies, sent by the built composition.

Enumerator
VuoControlReplyCompositionStopping 

Composition shutdown has been initiated.

VuoControlReplyCompositionPaused 

Composition has been paused.

VuoControlReplyCompositionUnpaused 

Composition has been unpaused.

VuoControlReplyCompositionHibernated 

Hibernation is complete.

At this point any composition outputs remain open but frozen, waiting for the Vuo Editor to launch and unserialize the successor process. When that's complete, the Vuo Editor should send VuoControlCompositionStop to this process.

Includes data message-parts: (serialized data, to be determined)

VuoControlReplyPortValueModified 

The input port's value has been set.

VuoControlReplyPortValueRetrieved 

A string representation of the output port's value has been retrieved.

Includes data message-parts:

  • char *valueAsString;
VuoControlReplyPublishedInputPortNamesRetrieved 

The list of published input ports' names has been retrieved.

Includes data message-parts:

  • char *name0
  • char *name1
  • ...
VuoControlReplyPublishedOutputPortNamesRetrieved 

The list of published output ports' names has been retrieved.

Includes data message-parts:

  • char *name0
  • char *name1
  • ...
VuoControlReplyPublishedInputPortTypesRetrieved 

The list of published input ports' types, as string representations, has been retrieved.

Includes data message-parts:

  • char *type0
  • char *type1
  • ...
VuoControlReplyPublishedOutputPortTypesRetrieved 

The list of published output ports' types, as string representations, has been retrieved.

Includes data message-parts:

  • char *type0
  • char *type1
  • ...
VuoControlReplyPublishedInputPortConnectedIdentifiersRetrieved 

The list of published input ports' connected unpublished ports has been retrieved.

Includes data message-parts:

  • char *identifier0
  • char *identifier1
  • ...
VuoControlReplyPublishedOutputPortConnectedIdentifiersRetrieved 

The list of published output ports' connected unpublished ports has been retrieved.

Includes data message-parts:

  • char *identifier0
  • char *identifier1
  • ...
VuoControlReplyPublishedInputPortGeneratedEvent 

An event has been generated and transmitted through the published input port.

Control Requests, sent by the Vuo Editor.

Enumerator
VuoControlRequestCompositionStop 

Request that the composition stop executing (without serialization).

VuoControlRequestCompositionPause 

Request that the composition pause execution (without serialization).

VuoControlRequestCompositionUnpause 

Request that the composition unpause execution.

VuoControlRequestCompositionHibernate 

Request that the composition serialize its state and stop executing.

VuoControlRequestPortValueModify 

Request that the input port be set to the given value (converted to the port's type).

Includes data message-parts:

  • char *portIdentifier;
  • char *valueAsString;
VuoControlRequestPortValueRetrieve 

Request that the output port's value be looked up and returned.

Includes data message-parts:

  • char *portIdentifier;
VuoControlRequestPublishedInputPortNamesRetrieve 

Request that the published input ports' names be looked up and returned.

VuoControlRequestPublishedOutputPortNamesRetrieve 

Request that the published output ports' names be looked up and returned.

VuoControlRequestPublishedInputPortTypesRetrieve 

Request that the published input ports' types be looked up and returned.

VuoControlRequestPublishedOutputPortTypesRetrieve 

Request that the published output ports' types be looked up and returned.

VuoControlRequestPublishedInputPortConnectedIdentifiersRetrieve 

Request that the published input port's connected unpublished ports be looked up and returned.

Includes data message-parts:

  • char *name
VuoControlRequestPublishedOutputPortConnectedIdentifiersRetrieve 

Request that the published output port's connected unpublished ports be looked up and returned.

Includes data message-parts:

  • char *name
VuoControlRequestPublishedInputPortGenerateEvent 

Request that an event be generated and transmitted through the published input port.

Includes data message-parts:

  • char *name

Types of published telemetry data.

Enumerator
VuoTelemetryStats 

General information about the composition process, published every half-second.

Includes data message-parts:

  • unsigned long utime;
  • unsigned long stime;
VuoTelemetryNodeExecutionStarted 

Published just prior to calling each node's nodeEvent/nodeInstanceEvent function.

Includes data message-parts:

  • char *nodeIdentifier;
VuoTelemetryNodeExecutionFinished 

Published just after each node's nodeEvent/nodeInstanceEvent function returns.

Includes data message-parts:

  • char *nodeIdentifier;
VuoTelemetryPortValuesChanged 

Published just after each node's nodeEvent/nodeInstanceEvent function returns, for nodes that have at least one output port that carries data.

Includes data message-parts:

  • char *portIdentifier0;
  • char *portValue0;
  • char *portIdentifier0;
  • char *portValue1;
  • ...
VuoTelemetryEdgeHit 

Published when an event is conducted along an edge.

Includes data message-parts:

  • char *edgeIdentifier;

Function Documentation

char* copyStringFromMessage ( zmq_msg_t *  message)

Copies the message data into a newly allocated string.

Assumes the message data includes a null terminator.