Data Structures
struct	RF_REPLY_FARM_STARTING
	The structure of a Farm Starting message. This is sent in reply to rf_send_farm_start(). More...

struct	RF_REPLY_FARM_STOPPING
	The structure of a Farm Stopping message. This is sent in reply to rf_send_farm_stop() or at any time should a fatal error occur within the RIP farm. More...

struct	RF_REPLY_BLADE_STOPPING
	The structure of a Blade Stopping message. This is sent in reply to rf_send_blade_stop(). More...

Typedefs
typedef struct RF_REPLY_FARM_STARTING	RF_REPLY_FARM_STARTING
	The structure of a Farm Starting message. This is sent in reply to rf_send_farm_start().

typedef struct RF_REPLY_FARM_STOPPING	RF_REPLY_FARM_STOPPING
	The structure of a Farm Stopping message. This is sent in reply to rf_send_farm_stop() or at any time should a fatal error occur within the RIP farm.

typedef struct RF_REPLY_BLADE_STOPPING	RF_REPLY_BLADE_STOPPING
	The structure of a Blade Stopping message. This is sent in reply to rf_send_blade_stop().

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

void	rf_free_farm_starting (RF_REPLY_FARM_STARTING **p_farm_starting)
	Free the C structure created by rf_extract_farm_starting(). More...

RF_REPLY_FARM_STOPPING *	rf_extract_farm_stopping (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_FARM_STOPPING structure. More...

void	rf_free_farm_stopping (RF_REPLY_FARM_STOPPING **p_farm_stopping)
	Free the C structure created by rf_extract_farm_stopping(). More...

RF_REPLY_BLADE_STOPPING *	rf_extract_blade_stopping (RF_FARM_REPLY *farm_reply)
	Extract `farm_reply->payload` into a RF_REPLY_BLADE_STOPPING structure. More...

void	rf_free_blade_stopping (RF_REPLY_BLADE_STOPPING **p_blade_stopping)
	Free the C structure created by rf_extract_blade_stopping(). More...

Detailed Description

Function Documentation

RF_REPLY_BLADE_STOPPING* rf_extract_blade_stopping ( RF_FARM_REPLY * farm_reply )

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

RF_REPLY_FARM_STARTING* rf_extract_farm_starting ( RF_FARM_REPLY * farm_reply )

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

RF_REPLY_FARM_STOPPING* rf_extract_farm_stopping ( RF_FARM_REPLY * farm_reply )

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

void rf_free_blade_stopping ( RF_REPLY_BLADE_STOPPING ** p_blade_stopping )

Free the C structure created by rf_extract_blade_stopping().

Parameters

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

void rf_free_farm_starting ( RF_REPLY_FARM_STARTING ** p_farm_starting )

Free the C structure created by rf_extract_farm_starting().

Parameters

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

void rf_free_farm_stopping ( RF_REPLY_FARM_STOPPING ** p_farm_stopping )

Free the C structure created by rf_extract_farm_stopping().

Parameters

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