Vuo  2.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
VuoRuntimePersistentState Class Reference

Description

Runtime state preserved across live-coding reloads.

Definition at line 28 of file VuoRuntimePersistentState.hh.

Public Member Functions

 VuoRuntimePersistentState (const char *workingDirectory)
 Constructor. More...
 
 ~VuoRuntimePersistentState (void)
 Destructor. More...
 
char * getWorkingDirectory (void)
 Returns the directory that nodes should use to resolve relative paths. More...
 
unsigned long getNextEventId (void)
 Returns a unique event ID. More...
 
bool isStopRequested (void)
 Returns true if something in the composition (nodes/libraries/runtime) has requested the composition to stop. More...
 
void setStopRequested (bool isStopRequested)
 Sets a flag indicating that something in the composition (nodes/libraries/runtime) has requested the composition to stop. More...
 
void addFiniCallback (VuoCompositionFiniCallback fini)
 Registers a callback to be invoked when the composition is shutting down, after all nodes have been fini'ed. More...
 
void callFiniCallbacks (void)
 Calls all fini callbacks that have been registered. More...
 
dispatch_group_t getTriggerWorkersScheduled (void)
 Returns the dispatch group that tracks trigger workers that have been scheduled but have not yet launched an event into the composition. More...
 

Static Public Member Functions

static string getCurrentWorkingDirectory (void)
 Returns the current working directory of the process. More...
 

Public Attributes

VuoRuntimeStateruntimeState
 Reference to the parent VuoRuntimeState. More...
 
VuoCompositionDiffcompositionDiff
 Objects preserved across live-coding reloads. More...
 
VuoNodeRegistrynodeRegistry
 Objects preserved across live-coding reloads. More...
 
VuoRuntimeCommunicatorcommunicator
 Objects preserved across live-coding reloads. More...
 
VuoThreadManagerthreadManager
 Objects preserved across live-coding reloads. More...
 

Constructor & Destructor Documentation

◆ VuoRuntimePersistentState()

VuoRuntimePersistentState::VuoRuntimePersistentState ( const char *  workingDirectory)

Constructor.

Definition at line 21 of file VuoRuntimePersistentState.cc.

◆ ~VuoRuntimePersistentState()

VuoRuntimePersistentState::~VuoRuntimePersistentState ( void  )

Destructor.

Definition at line 42 of file VuoRuntimePersistentState.cc.

Member Function Documentation

◆ addFiniCallback()

void VuoRuntimePersistentState::addFiniCallback ( VuoCompositionFiniCallback  fini)

Registers a callback to be invoked when the composition is shutting down, after all nodes have been fini'ed.

Definition at line 99 of file VuoRuntimePersistentState.cc.

◆ callFiniCallbacks()

void VuoRuntimePersistentState::callFiniCallbacks ( void  )

Calls all fini callbacks that have been registered.

Definition at line 109 of file VuoRuntimePersistentState.cc.

◆ getCurrentWorkingDirectory()

string VuoRuntimePersistentState::getCurrentWorkingDirectory ( void  )
static

Returns the current working directory of the process.

Definition at line 56 of file VuoRuntimePersistentState.cc.

◆ getNextEventId()

unsigned long VuoRuntimePersistentState::getNextEventId ( void  )

Returns a unique event ID.

Definition at line 75 of file VuoRuntimePersistentState.cc.

◆ getTriggerWorkersScheduled()

dispatch_group_t VuoRuntimePersistentState::getTriggerWorkersScheduled ( void  )

Returns the dispatch group that tracks trigger workers that have been scheduled but have not yet launched an event into the composition.

Definition at line 126 of file VuoRuntimePersistentState.cc.

◆ getWorkingDirectory()

char * VuoRuntimePersistentState::getWorkingDirectory ( void  )

Returns the directory that nodes should use to resolve relative paths.

Definition at line 67 of file VuoRuntimePersistentState.cc.

◆ isStopRequested()

bool VuoRuntimePersistentState::isStopRequested ( void  )

Returns true if something in the composition (nodes/libraries/runtime) has requested the composition to stop.

Definition at line 83 of file VuoRuntimePersistentState.cc.

◆ setStopRequested()

void VuoRuntimePersistentState::setStopRequested ( bool  isStopRequested)

Sets a flag indicating that something in the composition (nodes/libraries/runtime) has requested the composition to stop.

Definition at line 91 of file VuoRuntimePersistentState.cc.

Member Data Documentation

◆ communicator

VuoRuntimeCommunicator* VuoRuntimePersistentState::communicator

Objects preserved across live-coding reloads.

Definition at line 49 of file VuoRuntimePersistentState.hh.

◆ compositionDiff

VuoCompositionDiff* VuoRuntimePersistentState::compositionDiff

Objects preserved across live-coding reloads.

Definition at line 47 of file VuoRuntimePersistentState.hh.

◆ nodeRegistry

VuoNodeRegistry* VuoRuntimePersistentState::nodeRegistry

Objects preserved across live-coding reloads.

Definition at line 48 of file VuoRuntimePersistentState.hh.

◆ runtimeState

VuoRuntimeState* VuoRuntimePersistentState::runtimeState

Reference to the parent VuoRuntimeState.

Definition at line 53 of file VuoRuntimePersistentState.hh.

◆ threadManager

VuoThreadManager* VuoRuntimePersistentState::threadManager

Objects preserved across live-coding reloads.

Definition at line 50 of file VuoRuntimePersistentState.hh.


The documentation for this class was generated from the following files: