Data Structures
struct	RF_REPLY_FARM_STOPPED
	The structure of a Farm Stopped message. This is typically sent in reply to rf_send_farm_stop() but can also occur at any time if an error arises in the RIP farm. More...

struct	RF_FARM_STOP_REASON
	A reason to why farm stop has not happened yet. More...

struct	RF_REPLY_FARM_STOP_PROGRESS
	The structure of a Farm Stop Progress reply message. This notification is sent on a regular basis after a farm stop has been requested should the farm not stop in a timely fashion. The most likely reason for a farm stop not happening in a timely fashion is because: More...

struct	RF_REPLY_JOB_STARTED
	The structure of a Job Started message. This notification indicates that a job has been analysed, and that chunks have been scheduled on the RIP Farm. More...

struct	RF_REPLY_JOB_PAUSED
	The structure of a Job Paused message. This notification indicates that a job has paused, and no more chunks will be scheduled unless the job is resumed. More...

struct	RF_REPLY_JOB_RESUMED
	The structure of a Job Resumed message. This notification indicates that a job has resumed, and that chunks have been scheduled on the RIP Farm. More...

struct	RF_JOB_COMPLETED_METADATA
	Metadata collected while processing the job. More...

struct	RF_REPLY_JOB_COMPLETED
	The structure of a Job Completed message. This notification indicates that a job has finished interpreting and rendering. It does not indicate that the rasters created have been processed. More...

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

Macros
#define	RF_JOB_COMPLETED_METADATA_INIT { sizeof(RF_JOB_COMPLETED_METADATA), 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
	Static/auto initialiser for RF_JOB_COMPLETED_METADATA. Job completed meta data parameters should be initialised using this value, and then individual fields modified as desired.

Typedefs
typedef struct RF_REPLY_FARM_STOPPED	RF_REPLY_FARM_STOPPED
	The structure of a Farm Stopped message. This is typically sent in reply to rf_send_farm_stop() but can also occur at any time if an error arises in the RIP farm.

typedef int	RF_STOP_REASON
	Type to pass RF_STOP_REASONS across interfaces.

typedef struct RF_FARM_STOP_REASON	RF_FARM_STOP_REASON
	A reason to why farm stop has not happened yet.

typedef struct RF_REPLY_FARM_STOP_PROGRESS	RF_REPLY_FARM_STOP_PROGRESS
	The structure of a Farm Stop Progress reply message. This notification is sent on a regular basis after a farm stop has been requested should the farm not stop in a timely fashion. The most likely reason for a farm stop not happening in a timely fashion is because: More...

typedef struct RF_REPLY_JOB_STARTED	RF_REPLY_JOB_STARTED
	The structure of a Job Started message. This notification indicates that a job has been analysed, and that chunks have been scheduled on the RIP Farm.

typedef struct RF_REPLY_JOB_PAUSED	RF_REPLY_JOB_PAUSED
	The structure of a Job Paused message. This notification indicates that a job has paused, and no more chunks will be scheduled unless the job is resumed.

typedef struct RF_REPLY_JOB_RESUMED	RF_REPLY_JOB_RESUMED
	The structure of a Job Resumed message. This notification indicates that a job has resumed, and that chunks have been scheduled on the RIP Farm.

typedef struct RF_JOB_COMPLETED_METADATA	RF_JOB_COMPLETED_METADATA
	Metadata collected while processing the job.

typedef struct RF_REPLY_JOB_COMPLETED	RF_REPLY_JOB_COMPLETED
	The structure of a Job Completed message. This notification indicates that a job has finished interpreting and rendering. It does not indicate that the rasters created have been processed.

typedef struct RF_REPLY_RASTER_PROGRESS	RF_REPLY_RASTER_PROGRESS
	The structure of a Rasters Progress message. More...

Enumerations
enum	RF_STOP_REASONS { RF_STOP_REASON_RASTER_JOBS = 0 , RF_STOP_REASON_RASTER_PAGES_UNHANDLED = 1 , RF_STOP_REASON_BLADES = 2 }
	Values for RF_STOP_REASON. More...

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

void	rf_free_farm_stopped (RF_REPLY_FARM_STOPPED **p_farm_stopped)
	Free the C structure created by rf_extract_farm_stopped(). More...

RF_REPLY_FARM_STOP_PROGRESS *	rf_extract_farm_stop_progress (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_FARM_STOP_PROGRESS structure. More...

void	rf_free_farm_stop_progress (RF_REPLY_FARM_STOP_PROGRESS **p_farm_stop_progress)
	Free the C structure created by rf_extract_farm_stop_progress(). More...

RF_REPLY_JOB_STARTED *	rf_extract_job_started (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_JOB_STARTED structure. More...

void	rf_free_job_started (RF_REPLY_JOB_STARTED **p_job_started)
	Free the C structure created by rf_extract_job_started(). More...

RF_REPLY_JOB_PAUSED *	rf_extract_job_paused (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_JOB_PAUSED structure. More...

void	rf_free_job_paused (RF_REPLY_JOB_PAUSED **p_job_paused)
	Free the C structure created by rf_extract_job_paused(). More...

RF_REPLY_JOB_RESUMED *	rf_extract_job_resumed (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_JOB_RESUMED structure. More...

void	rf_free_job_resumed (RF_REPLY_JOB_RESUMED **p_job_resumed)
	Free the C structure created by rf_extract_job_resumed(). More...

RF_REPLY_JOB_COMPLETED *	rf_extract_job_completed (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_JOB_COMPLETED structure. More...

void	rf_free_job_completed (RF_REPLY_JOB_COMPLETED **p_job_completed)
	Free the C structure created by rf_extract_job_completed(). More...

RF_REPLY_RASTER_PROGRESS *	rf_extract_raster_progress (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_RASTER_PROGRESS structure. More...

void	rf_free_raster_progress (RF_REPLY_RASTER_PROGRESS **p_raster_progress)
	Free the C structure created by rf_extract_raster_progress(). More...

Detailed Description

Typedef Documentation

◆ RF_REPLY_FARM_STOP_PROGRESS

typedef struct RF_REPLY_FARM_STOP_PROGRESS RF_REPLY_FARM_STOP_PROGRESS

The structure of a Farm Stop Progress reply message. This notification is sent on a regular basis after a farm stop has been requested should the farm not stop in a timely fashion. The most likely reason for a farm stop not happening in a timely fashion is because:

The raster manager has unhandled pages which need handling before the farm will stop (RF_STOP_REASON_RASTER_JOBS and RF_STOP_REASON_RASTER_PAGES_UNHANDLED).
A satellite blade controller has not announced that it has stopped for some reason (crash, network failure etc.). Note, there will always be at least 1 blade if this notification is received (the central blade controller). If the raster manager has unhandled pages, you should not expect the central blade controller to have exited yet.

◆ RF_REPLY_RASTER_PROGRESS

typedef struct RF_REPLY_RASTER_PROGRESS RF_REPLY_RASTER_PROGRESS

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.

Enumeration Type Documentation

◆ RF_STOP_REASONS

enum RF_STOP_REASONS

Values for RF_STOP_REASON.

Enumerator
RF_STOP_REASON_RASTER_JOBS	There are jobs in the raster manager which have pages ready and are waiting to be handled before the farm stop can complete. The count is the number of jobs.
RF_STOP_REASON_RASTER_PAGES_UNHANDLED	There are ready but unhandled pages in the raster manager. The count is the number of unhandled pages across all jobs.
RF_STOP_REASON_BLADES	There are blade controllers which have yet to announce that they have stopped. The count is the number of blades and will be at least 1 if either the count for RF_STOP_REASON_RASTER_JOBS or RF_STOP_REASON_RASTER_PAGES_UNHANDLED are greater than 0.

Function Documentation