Harlequin RIP SDK
HVD_monitor_params Struct Reference

Parameters for the HVD monitor. More...

#include "hvdevmon.h"

Data Fields

size_t size
 The size of this structure.
 
const char * cache_id
 
HVD_connect_verify_fnconnect_verify_fn
 
void * connect_verify_data
 Data for verifying the connection.
 
HqBool position_independent
 Is the client position independent?
 
HqBool allow_zero_elements
 Can the client handle zero size elements?
 
HqBool allow_early_output
 Can the client handle output in any order (when elements become ready)?
 
HqBool allow_async_output
 Can the client handle output asynchronously.
 
HVD_page_output_fnpage_output_fn
 Function to output a page.
 
HVD_cache_policy cache_policy
 Caching purging policy.
 
const char * cache_api_name
 
sw_memory_instancemem
 Memory allocation/deallocation functions.
 

Detailed Description

Parameters for the HVD monitor.

Field Documentation

◆ cache_api_name

const char* HVD_monitor_params::cache_api_name

The zero-terminated name of the HVD cache implementation. This should be a name of named RDR, registered in the RDR_NAMES_LIBHVD_CACHE_API namespace.

◆ cache_id

const char* HVD_monitor_params::cache_id

HVD cache ID this handler responds to. libHVD enables parameters to be passed to cache implementations, by encoding them in the /OptimizedPDFCacheId. If the cache ID contains the query mark '?', only the part of the cache ID before the query is used to match connection requests. The entire cache ID is passed to the cache's HVD_cache_fns::store_create() method, allowing the cache implementation to extract the parameters and specialize behavior.

◆ connect_verify_fn

HVD_connect_verify_fn* HVD_monitor_params::connect_verify_fn

A function to verify that an HVD connection is in a suitable context. If this is non-NULL, it is called during HVD_monitor_start() with the connect_verify_data parameter to verify that the output is set to use raster callbacks that are compatible with the HVD connection.

Parameters
[in]cache_idA zero-terminated string indicating the OptimizedPDFCacheID that this connection was for.
[in]dataThe data supplied to HVD_monitor_start() by the creator for the purposes of verifying the connection.
Return values
TRUEThe HVD connection should be established.
FALSEThe HVD connection should not be established.

This function exists so that the creator of an HVD monitor can verify that the RIP is configured suitably for use with HVD. HVD is configured using the /OptimizedPDFCacheID PDF parameter. This function can be used to prevent confusion or corruption if the RIP output is not configured in a way that is not suitable for with the HVD cache specified.


The documentation for this struct was generated from the following file: