Harlequin RIP SDK

The structure of a Rasters Progress message. More...

#include "rf_reply_msgs.h"

Data Fields

int job_id
 The job ID for which rasters are available.
 
int priority
 The priority of the job.

 
HqBool job_complete
 Is the job complete? More...
 
HqBool job_failed
 Did the job fail?
 
int pages_handled
 The number of pages that the DBE has indicated have been handled with rf_send_rasters_handled().
 
int pages_delivered
 The number of pages delivered to the DBE in RF_REPLY_RASTER_DELIVER messages, but not yet acknowledged as handled.
 
int pages_ready
 The number of pages ready to deliver to the DBE, but not yet requested with rf_send_raster_request().
 
int pages_unready
 The number of pages with a subset of the rasters ready, but not yet indicated as complete.
 

Detailed Description

The structure of a Rasters Progress message.

This notification is sent at a few significant points during raster handling for a job, for use by UIs to track progress. The significant points that this message is issued at include:

  • When the first raster(s) are sent to the raster manager
  • When the first raster(s) are available for delivery
  • When the first raster(s) are delivered to a DBE
  • When the first raster(s) are handled by the DBE
  • When the last raster(s) are available for delivery
  • When the last raster(s) are delivered to a DBE
  • When the last raster(s) are handled by the DBE

While a job is active, a UI may wish to poll using Raster Status for more detailed progress. This notification is only sent if the raster manager is enabled in the global RIP Farm configuration.

Field Documentation

◆ job_complete

HqBool RF_REPLY_RASTER_PROGRESS::job_complete

Is the job complete?

TRUE if the job is complete (i.e., there will be no more rasters made available), FALSE if the job is incomplete.


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