Data Structures
struct	RF_JOB_STATUS_DETAILS
	The status of a job, as returned in the Job Status reply message. More...

struct	RF_REPLY_JOB_STATUS
	The structure of a Job Status reply message. This message is sent in response to a rf_send_job_status_request(), to inform the client about all of the jobs matched. More...

struct	RF_RIP_STATUS_PAGE_RANGE_DETAILS
	The status of a page range this RIP is processing. More...

struct	RF_RIP_STATUS_DETAILS
	The status of a RIP, as returned in the RIP Status reply message. This message is sent in response to a rf_send_rip_status_request(), to inform the client about all of the RIPs. More...

struct	RF_REPLY_RIP_STATUS
	The structure of a RIP Status reply message. This message is sent in response to a rf_send_rip_status_request(), to inform the client about all of the RIPs. More...

struct	RF_BLADE_STATUS_DETAILS
	The status of a Blade, as returned in the Blade Status reply message. This message is sent in response to a rf_send_blade_status_request(), to inform the client about all of the Blades. More...

struct	RF_REPLY_BLADE_STATUS
	The structure of a Blade Status reply message. This message is sent in response to a rf_send_blade_status_request(), to inform the client about all of the Blades. More...

struct	RF_REPLY_RASTER_STATUS
	The structure of a Raster Status reply message. This message is sent in response to a rf_send_raster_status_request(), to inform the client about all of the rasters for matching jobs and raster statuses. More...

Typedefs
typedef int	RF_JOB_STATE
	Type to pass RF_JOB_STATES across interfaces.

typedef struct RF_JOB_STATUS_DETAILS	RF_JOB_STATUS_DETAILS
	The status of a job, as returned in the Job Status reply message. More...

typedef struct RF_REPLY_JOB_STATUS	RF_REPLY_JOB_STATUS
	The structure of a Job Status reply message. This message is sent in response to a rf_send_job_status_request(), to inform the client about all of the jobs matched.

typedef int	RF_RIP_STATE
	Type to pass RF_RIP_STATES across interfaces.

typedef int	RF_PAGE_RANGE_STATE
	Type to pass RF_PAGE_RANGE_STATES across interfaces.

typedef struct RF_RIP_STATUS_PAGE_RANGE_DETAILS	RF_RIP_STATUS_PAGE_RANGE_DETAILS
	The status of a page range this RIP is processing.

typedef struct RF_RIP_STATUS_DETAILS	RF_RIP_STATUS_DETAILS
	The status of a RIP, as returned in the RIP Status reply message. This message is sent in response to a rf_send_rip_status_request(), to inform the client about all of the RIPs.

typedef struct RF_REPLY_RIP_STATUS	RF_REPLY_RIP_STATUS
	The structure of a RIP Status reply message. This message is sent in response to a rf_send_rip_status_request(), to inform the client about all of the RIPs.

typedef int	RF_BLADE_STATE
	Type to pass RF_BLADE_STATES across interfaces.

typedef struct RF_BLADE_STATUS_DETAILS	RF_BLADE_STATUS_DETAILS
	The status of a Blade, as returned in the Blade Status reply message. This message is sent in response to a rf_send_blade_status_request(), to inform the client about all of the Blades.

typedef struct RF_REPLY_BLADE_STATUS	RF_REPLY_BLADE_STATUS
	The structure of a Blade Status reply message. This message is sent in response to a rf_send_blade_status_request(), to inform the client about all of the Blades.

typedef struct RF_REPLY_RASTER_STATUS	RF_REPLY_RASTER_STATUS
	The structure of a Raster Status reply message. This message is sent in response to a rf_send_raster_status_request(), to inform the client about all of the rasters for matching jobs and raster statuses.

Enumerations
enum	RF_JOB_STATES { RF_JOB_STATE_STARTING = 0 , RF_JOB_STATE_WAITING = 1 , RF_JOB_STATE_ACTIVE = 2 , RF_JOB_STATE_PAUSING = 3 , RF_JOB_STATE_PAUSED = 4 , RF_JOB_STATE_RESUMING = 5 , RF_JOB_STATE_CANCELLING = 6 }
	Job states for RF_JOB_STATE, returned by the job controller. More...

enum	RF_RIP_STATES { RF_RIP_STATE_NOTRUNNING = 0 , RF_RIP_STATE_IDLE = 1 , RF_RIP_STATE_BUSY = 2 , RF_RIP_STATE_STOPPING = 3 }
	RIP states for RF_RIP_STATE, returned by the job controller. More...

enum	RF_PAGE_RANGE_STATES { RF_PAGE_RANGE_STATE_ACTIVE = 0 , RF_PAGE_RANGE_STATE_ABORTED = 1 , RF_PAGE_RANGE_STATE_FAILED = 2 }
	Page range states for RF_PAGE_RANGE_STATE, returned by the job controller. More...

enum	RF_BLADE_STATES { RF_BLADE_STATE_NOTRUNNING = 0 , RF_BLADE_STATE_WAITING = 1 , RF_BLADE_STATE_STARTING = 2 , RF_BLADE_STATE_ACTIVE = 3 , RF_BLADE_STATE_STOPPING = 4 , RF_BLADE_STATE_STOPPED = 5 }
	Blade states for RF_BLADE_STATE, returned by the farm controller. More...

Functions
RF_REPLY_JOB_STATUS *	rf_extract_job_status (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_JOB_STATUS structure. More...

void	rf_free_job_status (RF_REPLY_JOB_STATUS **p_job_status)
	Free the C structure created by rf_extract_job_status(). More...

RF_REPLY_RIP_STATUS *	rf_extract_rip_status (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_RIP_STATUS structure. More...

void	rf_free_rip_status (RF_REPLY_RIP_STATUS **p_rip_status)
	Free the C structure created by rf_extract_rip_status(). More...

RF_REPLY_BLADE_STATUS *	rf_extract_blade_status (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_BLADE_STATUS structure. More...

void	rf_free_blade_status (RF_REPLY_BLADE_STATUS **p_blade_status)
	Free the C structure created by rf_extract_blade_status(). More...

RF_REPLY_RASTER_STATUS *	rf_extract_raster_status (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_RASTER_STATUS structure. More...

void	rf_free_raster_status (RF_REPLY_RASTER_STATUS **p_raster_status)
	Free the C structure created by rf_extract_raster_status(). More...

Detailed Description

Typedef Documentation

◆ RF_JOB_STATUS_DETAILS

typedef struct RF_JOB_STATUS_DETAILS RF_JOB_STATUS_DETAILS

The status of a job, as returned in the Job Status reply message.

This message is sent in response to a rf_send_job_status_request(), to inform the client about all of the jobs matched.

Enumeration Type Documentation

◆ RF_BLADE_STATES

enum RF_BLADE_STATES

Blade states for RF_BLADE_STATE, returned by the farm controller.

Enumerator
RF_BLADE_STATE_NOTRUNNING	Blade has never been identified.
RF_BLADE_STATE_WAITING	Blade has been sent Blade Identified.
RF_BLADE_STATE_STARTING	Blade has been sent Blade Start.
RF_BLADE_STATE_ACTIVE	Blade Started has been received.
RF_BLADE_STATE_STOPPING	Sent Blade Stop, or Blade Identified error.
RF_BLADE_STATE_STOPPED	Blade Stopped has been received.

◆ RF_JOB_STATES

enum RF_JOB_STATES

Job states for RF_JOB_STATE, returned by the job controller.

Enumerator
RF_JOB_STATE_STARTING	Job submitted, but metadata has not yet been extracted.
RF_JOB_STATE_WAITING	Job metadata complete, but no page chunks scheduled yet.
RF_JOB_STATE_ACTIVE	Job is active, page chunks have been scheduled.
RF_JOB_STATE_PAUSING	Job will be paused when scheduled page chunks are completed.
RF_JOB_STATE_PAUSED	Job is paused. No page chunks will be scheduled while paused.
RF_JOB_STATE_RESUMING	Job is resuming. Page chunks will be scheduled in normal priority order when farm RIPs are available.
RF_JOB_STATE_CANCELLING	Job is being cancelled. No more page ranges will be scheduled.

◆ RF_PAGE_RANGE_STATES

enum RF_PAGE_RANGE_STATES

Page range states for RF_PAGE_RANGE_STATE, returned by the job controller.

Enumerator
RF_PAGE_RANGE_STATE_ACTIVE	Page range is being processed by this RIP.
RF_PAGE_RANGE_STATE_ABORTED	Page range has been requested to abort but waiting for RIP to acknowledge it has aborted the page range.
RF_PAGE_RANGE_STATE_FAILED	RIP has reported page range as having failed.

◆ RF_RIP_STATES

enum RF_RIP_STATES

RIP states for RF_RIP_STATE, returned by the job controller.

Enumerator
RF_RIP_STATE_NOTRUNNING	RIP is not running. Either restart limit has been exceeded or blade was stopped.
RF_RIP_STATE_IDLE	RIP is waiting for work.
RF_RIP_STATE_BUSY	RIP is busy processing a page range.
RF_RIP_STATE_STOPPING	RIP has been scheduled to stop.

Function Documentation

◆ rf_extract_blade_status()

RF_REPLY_BLADE_STATUS* rf_extract_blade_status ( RF_FARM_REPLY * farm_reply )

Extract farm_reply->payload into a RF_REPLY_BLADE_STATUS structure.

Parameters

[in] farm_reply Contains the message payload.

Returns: If successful, the C structure will be returned. Otherwise NULL. The returned structure should be freed using rf_free_blade_status() when no longer required.

◆ rf_extract_job_status()

RF_REPLY_JOB_STATUS* rf_extract_job_status ( RF_FARM_REPLY * farm_reply )

Extract farm_reply->payload into a RF_REPLY_JOB_STATUS structure.

Parameters

[in] farm_reply Contains the message payload.

Returns: If successful, the C structure will be returned. Otherwise NULL. The returned structure should be freed using rf_free_job_status() when no longer required.

◆ rf_extract_raster_status()

RF_REPLY_RASTER_STATUS* rf_extract_raster_status ( RF_FARM_REPLY * farm_reply )

Extract farm_reply->payload into a RF_REPLY_RASTER_STATUS structure.

Parameters

[in] farm_reply Contains the message payload.

Returns: If successful, the C structure will be returned. Otherwise NULL. The returned structure should be freed using rf_free_raster_status() when no longer required.

◆ rf_extract_rip_status()

RF_REPLY_RIP_STATUS* rf_extract_rip_status ( RF_FARM_REPLY * farm_reply )

Extract farm_reply->payload into a RF_REPLY_RIP_STATUS structure.

Parameters

[in] farm_reply Contains the message payload.

Returns: If successful, the C structure will be returned. Otherwise NULL. The returned structure should be freed using rf_free_rip_status() when no longer required.

◆ rf_free_blade_status()

void rf_free_blade_status ( RF_REPLY_BLADE_STATUS ** p_blade_status )

Free the C structure created by rf_extract_blade_status().

Parameters

[in,out] p_blade_status The structure to be freed. Safe against NULL *p_blade_status, which is always set to NULL on return.

◆ rf_free_job_status()

void rf_free_job_status ( RF_REPLY_JOB_STATUS ** p_job_status )

Free the C structure created by rf_extract_job_status().

Parameters

[in,out] p_job_status The structure to be freed. Safe against NULL *p_job_status, which is always set to NULL on return.

◆ rf_free_raster_status()

void rf_free_raster_status ( RF_REPLY_RASTER_STATUS ** p_raster_status )

Free the C structure created by rf_extract_raster_status().

Parameters

[in,out] p_raster_status The structure to be freed. Safe against NULL *p_raster_status, which is always set to NULL on return.

◆ rf_free_rip_status()

void rf_free_rip_status ( RF_REPLY_RIP_STATUS ** p_rip_status )

Free the C structure created by rf_extract_rip_status().

Parameters

[in,out] p_rip_status The structure to be freed. Safe against NULL *p_rip_status, which is always set to NULL on return.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ RF_JOB_STATUS_DETAILS

Enumeration Type Documentation

◆ RF_BLADE_STATES

◆ RF_JOB_STATES

◆ RF_PAGE_RANGE_STATES

◆ RF_RIP_STATES

Function Documentation

◆ rf_extract_blade_status()

◆ rf_extract_job_status()

◆ rf_extract_raster_status()

◆ rf_extract_rip_status()

◆ rf_free_blade_status()

◆ rf_free_job_status()

◆ rf_free_raster_status()

◆ rf_free_rip_status()