hvdscan.c File Reference

Harlequin VariData (external) cache, HVDSCAN. More...

#include "hhrsdk.h"
#include "skintest.h"
#include "debugpage.h"
#include "rmreport.h"
#include "hvdscan.h"
#include "rf_library.h"

Functions
static HVD_result	scan_hvd_output_page (HVD_page_output *page)
	Callback function for libHVD to output (report on) an HVD page. More...
HqBool	HVDSCAN_RegisterRemoteHandlers (void)
	Register the remote HVD cache instance. More...
static HVD_result	query_lock (HVD_cache *cache, void *store, const uint8 id[RR_ELEMENT_ID_LENGTH], HVD_cache_fns *api)
	Modified query lock. If this gets not pending result, it runs the element through the pending, add raster, and then lock states itself, so the client only ever sees locks succeeding.
static HVD_result	scan_element_query_lock (HVD_cache *cache, void *store, const uint8 id[RR_ELEMENT_ID_LENGTH])
	Modified query lock for local-memory scan cache.
static HVD_result	rfscan_element_query_lock (HVD_cache *cache, void *store, const uint8 id[RR_ELEMENT_ID_LENGTH])
	Modified query lock for RIP farm scan cache.
static void	scan_raster_release (HVD_cache *cache, void *store, const uint8 id[RR_ELEMENT_ID_LENGTH], void *hraster)
	Function to use as HVD_cache_fns::raster_release when using scan only caches.
static HVD_result	scan_raster_find (HVD_cache *cache, void *store, const uint8 elementId[RR_ELEMENT_ID_LENGTH], unsigned int index, const char *rasterId, void **pRaster)
	Function to use as HVD_cache_fns::raster_find when using scan only caches.
static HqBool	scan_recovery_filter (HVD_cache *cache, void *store, const uint8 id[RR_ELEMENT_ID_LENGTH], HVD_recovery_reason reason)
	Function to use as HVD_cache_fns::recovery_filter when using scan-only caches.
HqBool	HVDSCAN_RegisterRIPHandlers (void)
	Register the HVD cache implementation, HVD output, raster backend and event handlers. More...

Detailed Description

Harlequin VariData (external) cache, HVDSCAN.

This file implements an external HVD cache, and HVD remote cache output for use with the None raster backend. The HVD cache always indicates that raster data is present, so there are never any rasters generated. The HVD output functions report the elements that would have been generated and their positions.

Function Documentation

HVDSCAN_RegisterRemoteHandlers()

HqBool HVDSCAN_RegisterRemoteHandlers

(

void

)

Register the remote HVD cache instance.

Return values

TRUE	if successful;
FALSE	otherwise.

HVDSCAN_RegisterRIPHandlers()

HqBool HVDSCAN_RegisterRIPHandlers

(

void

)

Register the HVD cache implementation, HVD output, raster backend and event handlers.

Return values

TRUE	if successful;
FALSE	otherwise.

scan_hvd_output_page()

static HVD_result scan_hvd_output_page ( HVD_page_output *  page )

static

Callback function for libHVD to output (report on) an HVD page.

Parameters

[in]

page

The output page description from libHVD.

Return values

HVD_SUCCESS

The page was output successfully

Returns

One of the HVD_ERROR_* error codes, or any other return value greater than MON_CLASS_ERROR is an error UID. HVD_ERROR_* codes should be translated to monitor UID errors using HVD_result_translate(). The error subclass, PS error type, and UID for the error can be deconstructed using the macros in monevent.h.