Raster management message structures

Data Structures
struct	RF_REPLY_RASTER_CONNECTED
	The structure of a Raster Connected message. This is sent in reply to rf_send_raster_connect(). More...
struct	RF_REPLY_RASTER_DISCONNECTED
	The structure of a Raster Disconnected message. This is sent in reply to rf_send_raster_disconnect(). More...
struct	RF_REPLY_RASTER_DELIVER
	The structure of a Raster Deliver message. This is sent in reply to rf_send_raster_request(). More...
struct	RF_REPLY_RASTERS_AVAILABLE
	The structure of a Rasters Available notification message. More...

Typedefs
typedef struct RF_REPLY_RASTER_CONNECTED	RF_REPLY_RASTER_CONNECTED
	The structure of a Raster Connected message. This is sent in reply to rf_send_raster_connect().
typedef struct RF_REPLY_RASTER_DISCONNECTED	RF_REPLY_RASTER_DISCONNECTED
	The structure of a Raster Disconnected message. This is sent in reply to rf_send_raster_disconnect().
typedef struct RF_REPLY_RASTER_DELIVER	RF_REPLY_RASTER_DELIVER
	The structure of a Raster Deliver message. This is sent in reply to rf_send_raster_request().
typedef struct RF_REPLY_RASTERS_AVAILABLE	RF_REPLY_RASTERS_AVAILABLE
	The structure of a Rasters Available notification message. More...

Functions
RF_REPLY_RASTER_CONNECTED *	rf_extract_raster_connected (RF_FARM_REPLY *farm_reply)
	Extract farm_reply->payload into a RF_REPLY_RASTER_CONNECTED structure. More...
void	rf_free_raster_connected (RF_REPLY_RASTER_CONNECTED **p_raster_connected)
RF_REPLY_RASTER_DISCONNECTED *	rf_extract_raster_disconnected (RF_FARM_REPLY *farm_reply)
	Extract farm_reply->payload into a RF_REPLY_RASTER_DISCONNECTED structure. More...
void	rf_free_raster_disconnected (RF_REPLY_RASTER_DISCONNECTED **p_raster_disconnected)
	Free the C structure created by rf_extract_raster_disconnected(). More...
RF_REPLY_RASTER_DELIVER *	rf_extract_raster_deliver (RF_FARM_REPLY *farm_reply)
	Extract farm_reply->payload into a RF_REPLY_RASTER_DELIVER structure. More...
void	rf_free_raster_deliver (RF_REPLY_RASTER_DELIVER **p_raster_deliver)
	Free the C structure created by rf_extract_raster_deliver(). More...
RF_REPLY_RASTERS_AVAILABLE *	rf_extract_rasters_available (RF_FARM_REPLY *farm_reply)
	Extract farm_reply->payload into a RF_REPLY_RASTERS_AVAILABLE structure. More...
void	rf_free_rasters_available (RF_REPLY_RASTERS_AVAILABLE **p_rasters_available)
	Free the C structure created by rf_extract_rasters_available(). More...

Detailed Description

Typedef Documentation

RF_REPLY_RASTERS_AVAILABLE

typedef struct RF_REPLY_RASTERS_AVAILABLE RF_REPLY_RASTERS_AVAILABLE

The structure of a Rasters Available notification message.

This notification indicates that all of the rasters for a range of pages are available for delivery from the RIP Farm. This notification will be sent whenever pages are made ready by the raster output handlers, and there is no outstanding Raster Request. There will also be a notification when the job is complete. This notification is only sent if the raster manager is enabled in the global RIP Farm configuration.

Function Documentation

rf_extract_raster_connected()

RF_REPLY_RASTER_CONNECTED* rf_extract_raster_connected

(

RF_FARM_REPLY *

farm_reply

)

Extract farm_reply->payload into a RF_REPLY_RASTER_CONNECTED 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_connected() when no longer required.

rf_extract_raster_deliver()

RF_REPLY_RASTER_DELIVER* rf_extract_raster_deliver

(

RF_FARM_REPLY *

farm_reply

)

Extract farm_reply->payload into a RF_REPLY_RASTER_DELIVER 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_deliver() when no longer required.

rf_extract_raster_disconnected()

RF_REPLY_RASTER_DISCONNECTED* rf_extract_raster_disconnected

(

RF_FARM_REPLY *

farm_reply

)

Extract farm_reply->payload into a RF_REPLY_RASTER_DISCONNECTED 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_disconnected() when no longer required.

rf_extract_rasters_available()

RF_REPLY_RASTERS_AVAILABLE* rf_extract_rasters_available

(

RF_FARM_REPLY *

farm_reply

)

Extract farm_reply->payload into a RF_REPLY_RASTERS_AVAILABLE 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_rasters_available() when no longer required.

rf_free_raster_connected()

void rf_free_raster_connected

(

RF_REPLY_RASTER_CONNECTED **

p_raster_connected

)

Free the C structure created by rf_extract_raster_connected().

Parameters

[in,out]

p_raster_connected

The structure to be freed. Safe against NULL *p_raster_connected, which is always set to NULL on return.

rf_free_raster_deliver()

void rf_free_raster_deliver

(

RF_REPLY_RASTER_DELIVER **

p_raster_deliver

)

Free the C structure created by rf_extract_raster_deliver().

Parameters

[in,out]

p_raster_deliver

The structure to be freed. Safe against NULL *p_raster_deliver, which is always set to NULL on return.

rf_free_raster_disconnected()

void rf_free_raster_disconnected

(

RF_REPLY_RASTER_DISCONNECTED **

p_raster_disconnected

)

Free the C structure created by rf_extract_raster_disconnected().

Parameters

[in,out]

p_raster_disconnected

The structure to be freed. Safe against NULL *p_raster_disconnected, which is always set to NULL on return.

rf_free_rasters_available()

void rf_free_rasters_available

(

RF_REPLY_RASTERS_AVAILABLE **

p_rasters_available

)

Free the C structure created by rf_extract_rasters_available().

Parameters

[in,out]

p_rasters_available

The structure to be freed. Safe against NULL a *p_rasters_available, which is always set to NULL on return.