hvdlib.h File Reference

Common definitions for HVD library. More...

Typedefs
typedef struct HVD_cache	HVD_cache
	An opaque typedef for the HVD cache instance.
typedef struct HVD_cache_fns	HVD_cache_fns
	Typedef for the HVD cache implementation functions.
typedef struct HVD_tracker	HVD_tracker
	An opaque typedef for the HVD tracker.
typedef HqnResult	HVD_result
	Type for return values from HVD functions. More...
typedef int	HVD_recovery_reason
	Type for the reason parameter to the HVD_cache_fns::recovery_filter method. The core RIP will only use non-negative values for calls to HVD_cache_size() and HVD_cache_recover(). Values are combined bitmasks from the HVD_recovery_reason_values enumeration.
typedef int	HVD_destroy_reason
	Type of variables containing HVD_destroy_reason_values.
typedef int	HVD_element_state
	Type of variables containing HVD_element_state_values.

Enumerations
enum	{   HVD_SUCCESS_ALREADY = -2 , HVD_SUCCESS_INCOMPLETE = -1 , HVD_SUCCESS = HQN_RESULT_SUCCESS , HVD_ERROR_INVALID_PARAMS ,   HVD_ERROR_API_MEMORY , HVD_ERROR_API_RDR , HVD_ERROR_API_PTHREADS , HVD_ERROR_API_EVENTS ,   HVD_ERROR_NO_MEMORY , HVD_ERROR_NO_PAGE , HVD_ERROR_NO_ELEMENT , HVD_ERROR_ELEMENT_MISMATCH ,   HVD_ERROR_ELEMENT_REFUSED , HVD_ERROR_EXCESS_RASTERS , HVD_ERROR_RASTER_REFUSED , HVD_ERROR_NOT_LOCKED ,   HVD_ERROR_NOT_PENDING , HVD_ERROR_ALREADY_PENDING , HVD_ERROR_UNDERFLOW_HITS , HVD_ERROR_INTERRUPTED ,   HVD_ERROR_ABORTED , HVD_ERROR_MUTEX_FAILED , HVD_ERROR_CACHE_FNS , HVD_ERROR_CACHE_FULL }
	Values of HVD_result. These values are organised so a generic test for success can be made as less than or equal to HVD_SUCCESS, a generic test for failure is greater than HVD_SUCCESS. More...
enum	HVD_recovery_reason_values {   HVD_RECOVER_ALL = -1 , HVD_RECOVER_MPS_ARENA = 1 , HVD_RECOVER_MALLOC_FREE = 2 , HVD_RECOVER_SHARED_MEMORY = 4 ,   HVD_RECOVER_DISK = 8 , HVD_COUNT_ALL = 0 }
	Values of the HVD_recovery_reason type parameter reason of HVD_cache_fns::recovery_filter, also used by HVD_cache_size() and HVD_cache_recover(). This parameter can be used to exclude elements from low-memory recovery, if they do not contribute to the type of memory requested. The values may be combined in a bitmask for calls to HVD_cache_size() and HVD_cache_recover(). More...
enum	HVD_destroy_reason_values {   HVD_DESTROY_NORMAL , HVD_DESTROY_PURGE , HVD_DESTROY_ERROR , HVD_DESTROY_JOB_END ,   HVD_DESTROY_RIP_END }
	Reasons for destroying libHVD objects. Values of the HVD_destroy_reason type. More...
enum	HVD_element_state_values {   HVD_ELEMENT_UNSET , HVD_ELEMENT_DEFINED , HVD_ELEMENT_PENDING , HVD_ELEMENT_READY ,   HVD_ELEMENT_ERROR }
	Values for HVD element states, stored in the HVD_element_state type. These are used in multiple cache implementations. More...

Detailed Description

Common definitions for HVD library.