hvdpageoutput.h File Reference

HVD page output structure define. More...

#include "std.h"
#include "rrevents.h"
#include "timelineapi.h"
#include "hvdlib.h"

Data Structures
struct	HVD_element_output
	Element information structure for the page output callback function. The lifetime of this structure is the page output function call: any data that the backend wishes to store for a longer duration must be copied. More...
struct	HVD_page_output
	Page information for the page output callback function. More...

Typedefs
typedef void()	HVD_page_completion_fn(void *data, HVD_result status)
	Function type for page output completion callback. A function of this type is passed to HVD_tracker_page_ready(), and must be called to notify the caller when the page has been output, or when an error occurs that will prevent the page from being output. More...
typedef HqBool()	HVD_interrupt_poll_fn(void)
	Function type for interrupt polls. This is called when waiting for the rasters for all elements of a page to be delivered to the cache. It may also be called by the output function, if it takes a long time. More...
typedef struct HVD_element_output	HVD_element_output
	Element information structure for the page output callback function. The lifetime of this structure is the page output function call: any data that the backend wishes to store for a longer duration must be copied.
typedef struct HVD_page_output	HVD_page_output
	Page information for the page output callback function. More...

Detailed Description

HVD page output structure define.

This structure is used by libHVD output, and also by the Scalable RIP libripfarm for remote HVD output.

Typedef Documentation

HVD_interrupt_poll_fn

typedef HqBool() HVD_interrupt_poll_fn(void)

Function type for interrupt polls. This is called when waiting for the rasters for all elements of a page to be delivered to the cache. It may also be called by the output function, if it takes a long time.

Return values

TRUE	Stop waiting for page rasters or outputting the page.
FALSE	Continue waiting for page rasters or outputting the page.

HVD_page_completion_fn

typedef void() HVD_page_completion_fn(void *data, HVD_result status)

Function type for page output completion callback. A function of this type is passed to HVD_tracker_page_ready(), and must be called to notify the caller when the page has been output, or when an error occurs that will prevent the page from being output.

Parameters

[in]	data	The opaque page completion data passed to HVD_tracker_page_ready().
[in]	status	The status of the HVD_tracker_page_ready() output request. This will be: HVD_SUCCESS The page was output successfully. HVD_SUCCESS_ALREADY The page was already output. This may happen if the HVD_tracker_params::allow_early_output field was TRUE when the tracker was created, the elements for the page were already cached, and the page was already output. The SWEVT_RR_PAGE_COMPLETE event will not be issued in this case. HVD_ERROR_NO_PAGE The page index is not valid for the tracker. HVD_ERROR_NO_MEMORY The page output could not be performed because of memory exhaustion. HVD_ERROR_NO_ELEMENT An element of the page could not be located in the cache. HVD_ERROR_ABORTED Waiting for elements of the page was aborted by calling HVD_tracker_abort_job(). HVD_ERROR_INTERRUPTED Waiting for elements or the output was interrupted. Any other result value greater than MON_CLASS_ERROR is an error UID. The subclass, PS error type, and UID for the error can be deconstructed using the macros in monevent.h.

HVD_page_output

typedef struct HVD_page_output HVD_page_output

Page information for the page output callback function.

The page output callback function is called when all of the rasters for all elements of a page are ready and present in the cache. The lifetime of this structure is the page output function call: any data that the backend wishes to store for a longer duration must be copied. The callee can modify the data in this structure and the elements and rasterData sub-structures, but any changes will not be reflected in the HVD cache or tracker after the page output function call finishes (for example, the callee may wish to sort rasters within a separation into a particular order).