|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
Typedefs | |
| typedef int | RF_RASTERS_STATE |
| Type to pass RF_RASTERS_STATES across interfaces. | |
Enumerations | |
| enum | RF_RASTERS_STATES { RF_RASTERS_STATE_NONE = 0 , RF_RASTERS_STATE_DELIVERED = 1 , RF_RASTERS_STATE_READY = 2 , RF_RASTERS_STATE_UNREADY = 4 , RF_RASTERS_STATE_ALL = RF_RASTERS_STATE_DELIVERED|RF_RASTERS_STATE_READY|RF_RASTERS_STATE_UNREADY , RF_RASTERS_STATE_COUNTS = 8 } |
| Page state type for RF_RASTERS_STATE, in raster status requests. These bits can be combined to request full details of the pages of different types. More... | |
Functions | |
| HqBool | rf_send_job_status_request (RF_IFACE_CTXT *iface_ctxt, int job_id) |
| Request a job status reply. More... | |
| HqBool | rf_send_raster_status_request (RF_IFACE_CTXT *iface_ctxt, int job_id, RF_RASTERS_STATE page_state) |
| Request a raster status reply. More... | |
| HqBool | rf_send_rip_status_request (RF_IFACE_CTXT *iface_ctxt) |
| Request a rip status reply. More... | |
| HqBool | rf_send_blade_status_request (RF_IFACE_CTXT *iface_ctxt) |
| Request a blade status reply. More... | |
The status request functions are only available if the interface was started with RF_DFE_PORTS::statusPort enabled.
| enum RF_RASTERS_STATES |
Page state type for RF_RASTERS_STATE, in raster status requests. These bits can be combined to request full details of the pages of different types.
| Enumerator | |
|---|---|
| RF_RASTERS_STATE_NONE | Combine with RF_RASTERS_STATE_COUNTS if you just need a total raster count. |
| RF_RASTERS_STATE_DELIVERED | Include pages that are delivered, but not handled. |
| RF_RASTERS_STATE_READY | Include pages that are ready, but not delivered. |
| RF_RASTERS_STATE_UNREADY | Include pages that are not ready. |
| RF_RASTERS_STATE_ALL | Include pages in all states. |
| RF_RASTERS_STATE_COUNTS | Include counts of pages in all raster states (including handled), even if no other page details are reported. All page counts will be correct if page details are reported in any requested state, this flag allows determination of counts without delivering page details. |
| HqBool rf_send_blade_status_request | ( | RF_IFACE_CTXT * | iface_ctxt | ) |
Request a blade status reply.
An immediate RF_BLADE_STATUS reply is expected. This message will contain details of the status for all farm blades.
| [in] | iface_ctxt | The context handle from rf_iface_start(). |
TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message. | HqBool rf_send_job_status_request | ( | RF_IFACE_CTXT * | iface_ctxt, |
| int | job_id | ||
| ) |
Request a job status reply.
An immediate RF_JOB_STATUS reply is expected. This message will contain details of the requested jobs.
| [in] | iface_ctxt | The context handle from rf_iface_start(). |
| [in] | job_id | The job identifier for which status is requested. If this is zero, then status of all jobs is requested. |
TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message. | HqBool rf_send_raster_status_request | ( | RF_IFACE_CTXT * | iface_ctxt, |
| int | job_id, | ||
| RF_RASTERS_STATE | page_state | ||
| ) |
Request a raster status reply.
An immediate RF_RASTER_STATUS reply is expected. This message will contain details of the requested rasters for a number of pages which have not already been handled.
| [in] | iface_ctxt | The context handle from rf_iface_start(). |
| [in] | job_id | The job identifier for which raster status is requested. If this is zero, then raster status of all jobs is requested. |
| [in] | page_state | The page states for which rasters will be returned in the status reply. This should be one or a combination of: RF_RASTERS_STATE_DELIVERED, RF_RASTERS_STATE_READY, RF_RASTERS_STATE_UNREADY, or RF_RASTERS_STATE_ALL, and RF_RASTERS_STATE_COUNTS. |
TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message. | HqBool rf_send_rip_status_request | ( | RF_IFACE_CTXT * | iface_ctxt | ) |
Request a rip status reply.
An immediate RF_RIP_STATUS reply is expected. This message will contain details of the status for all farm RIPs.
| [in] | iface_ctxt | The context handle from rf_iface_start(). |
TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message.