Scalable RIP controller API

The Scalable RIP controller API allows the application layer to start a Scalable RIP controller server loop or a blade controller server loop. More...

Files
file	swsrip.h
	Header file defining the Scalable RIP controller API.

Data Structures
struct	SW_SR_PARAMS
	Parameters for configuring the Scalable RIP. More...

Macros
#define	SW_SR_PARAMS_INIT
	Static and auto initializer for SW_SR_PARAMS structure.

Functions
HqBool	sw_sr_server_loop (const struct SW_SR_PARAMS *swsrparams, void *vprdr_api)
	Initialize and start a Scalable RIP controller server thread. More...
HqBool	sw_bc_server_loop (const struct SW_SR_PARAMS *swsrparams, void *vprdr_api)
	Enter a server loop to handle blade controller commands from a controlling process. More...

Detailed Description

The Scalable RIP controller API allows the application layer to start a Scalable RIP controller server loop or a blade controller server loop.

The Scalable RIP controller allows jobs to be submitted to the Scalable RIP. The Scalable RIP will split PDF jobs into page ranges and will use a number of licensed RIP instances to RIP those page ranges for parallel throughput. Non PDF jobs will be submitted to a single RIP for processing.

A blade controller manages a set of Farm RIPs on a host, communicating with a Scalable RIP controller to interpret and render pages from PDF jobs.

Function Documentation

sw_bc_server_loop()

HqBool sw_bc_server_loop	(	const struct SW_SR_PARAMS *	swsrparams,
		void *	vprdr_api
	)

Enter a server loop to handle blade controller commands from a controlling process.

This call must be made after initializing the RDR subsystem. RDR will normally be initialized as part of the SwLeSDKStart() call, so this call should be made after SwLeSDKStart().

Parameters

[in]	swsrparams	Params for configuring the Scalable RIP.
[in]	vprdr_api	A pointer to the process's RDR API implementation.

Return values

TRUE	The blade controller server loop was started successfully.
FALSE	The blade controller server loop did not start. The process should issue any appropriate warnings and abort.

sw_sr_server_loop()

HqBool sw_sr_server_loop	(	const struct SW_SR_PARAMS *	swsrparams,
		void *	vprdr_api
	)

Initialize and start a Scalable RIP controller server thread.

This call must be made after initializing the RDR, Events, and Timeline subsystems. These will normally be initialized as part of the SwLeSDKStart() call, so this call should be made after SwLeSDKStart().

The Scalable RIP controller server thread will shutdown when SwLeSDKEnd() is called. A timeline event handler is used to monitor the skin timeline (SWTLT_SKIN) to detect the shutdown initiated by SwLeSDKEnd().

Parameters

[in]	swsrparams	Params for configuring the Scalable RIP.
[in]	vprdr_api	A pointer to the process's RDR API implementation.

Return values

TRUE	The Scalable RIP controller server loop was started successfully.
FALSE	The Scalable RIP controller server loop did not start. The process should issue any appropriate warnings and abort.