Raster management messages

Functions
HqBool	rf_send_raster_connect (RF_IFACE_CTXT *iface_ctxt, const char *name)
	Send a request to connect a DBE to the RIP Farm. More...
HqBool	rf_send_raster_disconnect (RF_IFACE_CTXT *iface_ctxt, int connection_id)
	Send a disconnect notice for a DBE to the RIP Farm. More...
HqBool	rf_send_raster_request (RF_IFACE_CTXT *iface_ctxt, int connection_id, int job_id, int page_count)
	Request a number of undelivered rasters. More...
HqBool	rf_send_rasters_handled (RF_IFACE_CTXT *iface_ctxt, int connection_id, int job_id, int page_count)
	Indicate that a number of rasters have been handled. More...

Detailed Description

The functions for managing output are only available if the interface was started with RF_DFE_PORTS::rasterPort enabled.

The rf_send_raster_status_request() function may be used to query raster output status. It is only available if the interface was started with RF_DFE_PORTS::statusPort enabled.

Function Documentation

rf_send_raster_connect()

HqBool rf_send_raster_connect	(	RF_IFACE_CTXT *	iface_ctxt,
		const char *	name
	)

Send a request to connect a DBE to the RIP Farm.

An immediate RF_RASTER_CONNECTED reply is expected. This message will contain details of the connection that must be used for subsequent Raster Request and Rasters Handled messages.

Parameters

[in]	iface_ctxt	The context handle from rf_iface_start().
[in]	name	An optional UTF-8 string used when reporting this connection name in status messages.

Returns

TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message.

rf_send_raster_disconnect()

HqBool rf_send_raster_disconnect	(	RF_IFACE_CTXT *	iface_ctxt,
		int	connection_id
	)

Send a disconnect notice for a DBE to the RIP Farm.

An immediate RF_RASTER_DISCONNECTED reply is expected. This message should be sent by a DBE before quitting. It allows the RIP Farm to determine how to handle remaining pages from jobs that the DBE was handling.

Parameters

[in]	iface_ctxt	The context handle from rf_iface_start().
[in]	connection_id	The connection ID as returned by the Raster Connected message.

Returns

TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message.

rf_send_raster_request()

HqBool rf_send_raster_request	(	RF_IFACE_CTXT *	iface_ctxt,
		int	connection_id,
		int	job_id,
		int	page_count
	)

Request a number of undelivered rasters.

Request rasters for a number of pages which have not already been delivered. When all of the rasters for the requested number of pages are ready, or the job completes successfully, an RF_RASTER_DELIVER reply will be sent to the caller. If the job completed unsuccessfully before the requested number of pages were ready, the RF_REPLY_RASTER_DELIVER reply will include an error, and the number of pages may be fewer than requested. The client may then repeat the Raster Request to be informed about remaining pages (including incomplete pages), or it may send a Rasters Handled message to the RIP Farm.

Parameters

[in]	iface_ctxt	The context handle from rf_iface_start().
[in]	connection_id	The connection ID used by the DBE. The connection ID must match for all requests for a job.
[in]	job_id	The job identifier for which pages are requested.
[in]	page_count	The number of previously undelivered pages requested. If this is zero, all of the pages in the job are to be delivered at once.

Returns

TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message.

rf_send_rasters_handled()

HqBool rf_send_rasters_handled	(	RF_IFACE_CTXT *	iface_ctxt,
		int	connection_id,
		int	job_id,
		int	page_count
	)

Indicate that a number of rasters have been handled.

This call indicates that the client has assumed all responsibility for the rasters for a number of pages. The client must ultimately issue this call for all pages in a job, or the raster manager will store unusable raster information until the RIP Farm is shutdown.

No reply is expected to this message.

Parameters

[in]	iface_ctxt	The context handle from rf_iface_start().
[in]	connection_id	The connection ID used by the DBE. The connection ID must match for all requests for a job.
[in]	job_id	The job identifier for which pages are handled.
[in]	page_count	The number of previously delivered pages indicated as handled. If this is zero, all of the pages in the job have been handled.

Returns

TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message.