Harlequin RIP SDK
SW_SR_PARAMS Struct Reference

Parameters for configuring the Scalable RIP. More...

#include "swsrip.h"

Data Fields

size_t size
 
int32 num_rips
 
size_t mem_working_size
 
int32 page_chunk
 
const char * filename_format
 
int32 driveTypes
 
int32 suppressProgressTypes
 
int32 threads_per_rip
 
HqBool logfile_in_sw
 
const char * central_bc_tcpip
 
const char * config_directory
 
mps_arena_t arena
 
sw_tl_ref parent_tl
 
HqBool register_input_source
 
const char * writeable_sw_folder
 
HqBool write_mps_log
 
char ** probe_names
 

Detailed Description

Parameters for configuring the Scalable RIP.

Use the initializer SW_SR_PARAMS_INIT to initialize static or auto structures of this type.

Field Documentation

◆ arena

mps_arena_t SW_SR_PARAMS::arena

The memory arena.

◆ central_bc_tcpip

const char* SW_SR_PARAMS::central_bc_tcpip

Location of central blade controller.

◆ config_directory

const char* SW_SR_PARAMS::config_directory

Directory location of config file.

◆ driveTypes

int32 SW_SR_PARAMS::driveTypes

Drive types to automatically mount in the worker RIPs (Windows only). See -D option in HHR.

◆ filename_format

const char* SW_SR_PARAMS::filename_format

Output directory and filename pattern for generated output raster files from the worker RIPs. See -f option in HHR.

◆ logfile_in_sw

HqBool SW_SR_PARAMS::logfile_in_sw

Create a log file with monitor output in worker RIP writable SW folders. See -X option in HHR.

◆ mem_working_size

size_t SW_SR_PARAMS::mem_working_size

VM arena working size for all worker RIPs combined, in bytes. Zero indicates use RIP default.

◆ num_rips

int32 SW_SR_PARAMS::num_rips

Number of worker RIPs to be spawned by the controlling RIP. Value must be greater than zero.

◆ page_chunk

int32 SW_SR_PARAMS::page_chunk

Number of pages from a splittable job to be processed by each worker RIP. A zero value indicates that the whole job will be split by number of worker RIPs. Negative values are invalid.

◆ parent_tl

sw_tl_ref SW_SR_PARAMS::parent_tl

Parent timeline for all Scalable RIP timelines.

◆ probe_names

char** SW_SR_PARAMS::probe_names

Array of probe names for timing information, followed by NULL. See -P option in HHR timing builds.

◆ register_input_source

HqBool SW_SR_PARAMS::register_input_source

Register the Scalable RIP message interface as a persistent input source. The Scalable RIP will remain active until a farm stop message is sent using libripfarm, or a job is submitted with a RIP quit configuration or override.

◆ size

size_t SW_SR_PARAMS::size

Size of this structure. This must be set correctly so that parameters for new versions of the Scalable RIP will be set to sensible default values if linked with an older skin.

◆ suppressProgressTypes

int32 SW_SR_PARAMS::suppressProgressTypes

Suppress progress types. See -n option in HHR.

◆ threads_per_rip

int32 SW_SR_PARAMS::threads_per_rip

Number of threads for worker RIPs. See -p option in HHR.

◆ write_mps_log

HqBool SW_SR_PARAMS::write_mps_log

Write a memory usage log for each Farm RIP.

◆ writeable_sw_folder

const char* SW_SR_PARAMS::writeable_sw_folder

The location of the writeable SW folder when using a union file system on the SW folder, if set. See -W option in HHR. It will be NULL if the union file system isn't used, in which case one SW folder is used for both reading and writing files.


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