VuoRuntimeContext.c File Reference

Description

VuoRuntimeContext implementation.

Copyright

Copyright © 2012–2017 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see http://vuo.org/license.

Functions
struct PortContext *	vuoCreatePortContext (void *data, bool isTrigger, const char *triggerQueueName)
	Creates a port context, initializing its fields to default values.
struct NodeContext *	vuoCreateNodeContext (bool hasInstanceData, bool isComposition, size_t outputEventCount)
	Creates a node context, initializing its fields to default values.
void	vuoFreePortContext (struct PortContext *portContext)
	Frees the port context and its fields.
void	vuoFreeNodeContext (struct NodeContext *nodeContext)
	Frees the port context and its fields.
void	vuoSetPortContextEvent (struct PortContext *portContext, bool event)
	Sets the port context's event field.
void	vuoSetPortContextData (struct PortContext *portContext, void *data)
	Sets the port context's data field.
void	vuoSetPortContextTriggerFunction (struct PortContext *portContext, void *triggerFunction)
	Sets the port context's triggerFunction field.
bool	vuoGetPortContextEvent (struct PortContext *portContext)
	Gets the port context's event field.
void *	vuoGetPortContextData (struct PortContext *portContext)
	Gets the port context's data field.
dispatch_queue_t	vuoGetPortContextTriggerQueue (struct PortContext *portContext)
	Gets the port context's triggerQueue field.
dispatch_semaphore_t	vuoGetPortContextTriggerSemaphore (struct PortContext *portContext)
	Gets the port context's triggerSemaphore field.
void *	vuoGetPortContextTriggerFunction (struct PortContext *portContext)
	Gets the port context's triggerFunction field.
void	vuoRetainPortContextData (struct PortContext *portContext)
	Prevents the port context's data field from being freed by vuoFreePortContext().
void	vuoSetNodeContextPortContexts (struct NodeContext *nodeContext, struct PortContext **portContexts, unsigned long portContextCount)
	Sets the node context's portContexts and portContextCount fields.
void	vuoSetNodeContextInstanceData (struct NodeContext *nodeContext, void *instanceData)
	Sets the node context's instanceData field, freeing the previous value.
void	vuoSetNodeContextClaimingEventId (struct NodeContext *nodeContext, unsigned long claimingEventId)
	Sets the node context's claimingEventId field.
void	vuoSetNodeContextExecutingEventId (struct NodeContext *nodeContext, unsigned long executingEventId)
	Sets the node context's executingEventId field.
void	vuoSetNodeContextOutputEvent (struct NodeContext *nodeContext, size_t index, bool event)
	Sets the array element at the given index of the node context's outputEvents field.
struct PortContext *	vuoGetNodeContextPortContext (struct NodeContext *nodeContext, size_t index)
	Gets the array element at the given index of the node context's portContexts field.
void *	vuoGetNodeContextInstanceData (struct NodeContext *nodeContext)
	Gets the node context's instanceData field.
dispatch_semaphore_t	vuoGetNodeContextSemaphore (struct NodeContext *nodeContext)
	Gets the node context's semaphore field.
unsigned long	vuoGetNodeContextClaimingEventId (struct NodeContext *nodeContext)
	Gets the node context's claimingEventId field.
dispatch_group_t	vuoGetNodeContextExecutingGroup (struct NodeContext *nodeContext)
	Gets the node context's executingGroup field.
unsigned long	vuoGetNodeContextExecutingEventId (struct NodeContext *nodeContext)
	Gets the node context's executingEventId field.
bool	vuoGetNodeContextOutputEvent (struct NodeContext *nodeContext, size_t index)
	Gets the array element at the given index of the node context's outputEvents field.
void	vuoResetNodeContextEvents (struct NodeContext *nodeContext)
	Sets the event field to false for all of the port contexts in this node context.

Function Documentation

struct NodeContext* vuoCreateNodeContext ( bool  hasInstanceData, bool  isComposition, size_t  outputEventCount  )

read

Creates a node context, initializing its fields to default values.

struct PortContext* vuoCreatePortContext ( void *  data, bool  isTrigger, const char *  triggerQueueName  )

read

Creates a port context, initializing its fields to default values.

void vuoFreeNodeContext

(

struct NodeContext *

nodeContext

)

Frees the port context and its fields.

void vuoFreePortContext

(

struct PortContext *

portContext

)

Frees the port context and its fields.

unsigned long vuoGetNodeContextClaimingEventId

(

struct NodeContext *

nodeContext

)

Gets the node context's claimingEventId field.

unsigned long vuoGetNodeContextExecutingEventId

(

struct NodeContext *

nodeContext

)

Gets the node context's executingEventId field.

dispatch_group_t vuoGetNodeContextExecutingGroup

(

struct NodeContext *

nodeContext

)

Gets the node context's executingGroup field.

void* vuoGetNodeContextInstanceData

(

struct NodeContext *

nodeContext

)

Gets the node context's instanceData field.

bool vuoGetNodeContextOutputEvent	(	struct NodeContext *	nodeContext,
		size_t	index
	)

Gets the array element at the given index of the node context's outputEvents field.

struct PortContext* vuoGetNodeContextPortContext ( struct NodeContext *  nodeContext, size_t  index  )

read

Gets the array element at the given index of the node context's portContexts field.

dispatch_semaphore_t vuoGetNodeContextSemaphore

(

struct NodeContext *

nodeContext

)

Gets the node context's semaphore field.

void* vuoGetPortContextData

(

struct PortContext *

portContext

)

Gets the port context's data field.

bool vuoGetPortContextEvent

(

struct PortContext *

portContext

)

Gets the port context's event field.

void* vuoGetPortContextTriggerFunction

(

struct PortContext *

portContext

)

Gets the port context's triggerFunction field.

dispatch_queue_t vuoGetPortContextTriggerQueue

(

struct PortContext *

portContext

)

Gets the port context's triggerQueue field.

dispatch_semaphore_t vuoGetPortContextTriggerSemaphore

(

struct PortContext *

portContext

)

Gets the port context's triggerSemaphore field.

void vuoResetNodeContextEvents

(

struct NodeContext *

nodeContext

)

Sets the event field to false for all of the port contexts in this node context.

void vuoRetainPortContextData

(

struct PortContext *

portContext

)

Prevents the port context's data field from being freed by vuoFreePortContext().

void vuoSetNodeContextClaimingEventId	(	struct NodeContext *	nodeContext,
		unsigned long	claimingEventId
	)

Sets the node context's claimingEventId field.

void vuoSetNodeContextExecutingEventId	(	struct NodeContext *	nodeContext,
		unsigned long	executingEventId
	)

Sets the node context's executingEventId field.

void vuoSetNodeContextInstanceData	(	struct NodeContext *	nodeContext,
		void *	instanceData
	)

Sets the node context's instanceData field, freeing the previous value.

void vuoSetNodeContextOutputEvent	(	struct NodeContext *	nodeContext,
		size_t	index,
		bool	event
	)

Sets the array element at the given index of the node context's outputEvents field.

void vuoSetNodeContextPortContexts	(	struct NodeContext *	nodeContext,
		struct PortContext **	portContexts,
		unsigned long	portContextCount
	)

Sets the node context's portContexts and portContextCount fields.

void vuoSetPortContextData	(	struct PortContext *	portContext,
		void *	data
	)

Sets the port context's data field.

void vuoSetPortContextEvent	(	struct PortContext *	portContext,
		bool	event
	)

Sets the port context's event field.

void vuoSetPortContextTriggerFunction	(	struct PortContext *	portContext,
		void *	triggerFunction
	)

Sets the port context's triggerFunction field.