Streaming

Functions
vx_status	vxStartGraphStreaming (vx_graph graph)
vx_status	vxStopGraphStreaming (vx_graph graph)

Detailed Description

This section lists the APIs required for graph streaming.

Function Documentation

vx_status vxStartGraphStreaming

(

vx_graph

graph

)

Start streaming mode of graph execution.

In streaming mode of graph execution, once a application starts graph execution further intervention of the application is not needed to re-schedule a graph; i.e. a graph re-schedules itself and executes continuously until streaming mode of execution is stopped.

When this API is called, the framework schedules the graph via vxScheduleGraph and returns. This graph gets re-scheduled continuously until vxStopGraphStreaming is called by the user or any of the graph nodes return error during execution.

The graph MUST be verified via vxVerifyGraph before calling this API. Also user application MUST ensure no previous executions of the graph are scheduled before calling this API.

After streaming mode of a graph has been started, the following APIs should not be used on that graph by an application: vxScheduleGraph, vxWaitScheduleGraphDone, and vxIsScheduleGraphAllowed.

vxWaitGraph can be used as before to wait for all pending graph executions to complete.

Parameters

graph

[in] Reference to the graph to start streaming mode of execution.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	No errors; any other value indicates failure.
VX_ERROR_INVALID_REFERENCE	graph is not a valid vx_graph reference.

vx_status vxStopGraphStreaming

(

vx_graph

graph

)

Stop streaming mode of graph execution.

This function blocks until graph execution is gracefully stopped at a logical boundary, for example, when all internally scheduled graph executions are completed.

Parameters

graph

[in] Reference to the graph to stop streaming mode of execution.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	No errors; any other value indicates failure.
VX_FAILURE	Graph is not started in streaming execution mode.
VX_ERROR_INVALID_REFERENCE	graph is not a valid reference.