Job control messages

Data Structures
struct	RF_JOBSTART_PARAMS
	Parameters for starting a job. More...

Macros
#define	RF_JOBSTART_PARAMS_INIT   { sizeof(RF_JOBSTART_PARAMS), NULL, 0, 0, NULL, NULL, }
	Static/auto initializer for RF_JOBSTART_PARAMS. Job start parameters should be initialized using this value, and then individual fields modified as desired.

Typedefs
typedef struct RF_JOBSTART_PARAMS	RF_JOBSTART_PARAMS
	Parameters for starting a job.

Functions
HqBool	rf_send_job_start (RF_IFACE_CTXT *iface_ctxt, RF_JOBSTART_PARAMS *params)
	Send a Job Start message. More...
HqBool	rf_send_job_cancel (RF_IFACE_CTXT *iface_ctxt, int id)
	Send a Job Cancel message. More...
HqBool	rf_send_job_pause (RF_IFACE_CTXT *iface_ctxt, int id)
	Send a Job Pause message. More...
HqBool	rf_send_job_resume (RF_IFACE_CTXT *iface_ctxt, int id)
	Send a Job Resume message. More...

Detailed Description

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

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

Function Documentation

rf_send_job_cancel()

HqBool rf_send_job_cancel	(	RF_IFACE_CTXT *	iface_ctxt,
		int	id
	)

Send a Job Cancel message.

An immediate reply of an RF_JOB_CANCELLING message is expected. If no errors were reported, an RF_JOB_COMPLETED message should be received when each job specified has been completed.

Parameters

[in]	iface_ctxt	The context handle from rf_iface_start().
	id	The job ID to cancel. If this is zero, cancel all jobs.

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_job_pause()

HqBool rf_send_job_pause	(	RF_IFACE_CTXT *	iface_ctxt,
		int	id
	)

Send a Job Pause message.

An immediate reply of an RF_JOB_PAUSING message is expected. If no errors were reported, a notification message will be received for each job affected when the state of the job is changed. The notification will normally be RF_JOB_PAUSED, however it may also be RF_JOB_COMPLETED (if the job already had all page chunks scheduled, or was cancelled before it could be paused), it may also be RF_JOB_RESUMED and then RF_JOB_PAUSED if the job was already resuming from a previous pause. The final notification state observed should be used by the client to determine its view of the job's state.

Parameters

[in]	iface_ctxt	The context handle from rf_iface_start().
	id	The job ID to pause. If this is zero, pause all jobs.

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_job_resume()

HqBool rf_send_job_resume	(	RF_IFACE_CTXT *	iface_ctxt,
		int	id
	)

Send a Job Resume message.

An immediate reply of an RF_JOB_RESUMING message is expected. If no errors were reported, a notification message will be received for each job affected when the state of the job is changed. The notification will normally be RF_JOB_RESUMED, however it may also be RF_JOB_STARTED (if the job was paused before any pages were scheduled), RF_JOB_COMPLETED (if the job was cancelled before it could be resumed), it may also be RF_JOB_PAUSED and then RF_JOB_RESUMED if the job was in the process of pausing. The final notification state observed should be used by the client to determine its view of the job's state.

Parameters

[in]	iface_ctxt	The context handle from rf_iface_start().
	id	The job ID to resume. If this is zero, resume all paused jobs.

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_job_start()

HqBool rf_send_job_start	(	RF_IFACE_CTXT *	iface_ctxt,
		RF_JOBSTART_PARAMS *	params
	)

Send a Job Start message.

An immediate reply of an RF_JOB_STARTING message is expected. If there is no error reported in RF_REPLY_JOB_STARTING, an RF_JOB_STARTED message should be received when the job is scheduled and an RF_JOB_COMPLETED message should be received when the job has finished. If there is an error configuring the job, the RF_JOB_STARTED message may be omitted, and the RF_JOB_COMPLETED message will indicate the error.

Parameters

[in]	iface_ctxt	The context handle from rf_iface_start().
[in]	params	The job information.

Returns

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