The RIP farm DFE Interface. More...

#include "rf_reply_msgs.h"
#include "rf_version.h"

Data Structures
struct	RF_BLADESTOP_PARAMS
	Parameters for stopping a blade. More...

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

struct	RF_DFE_PORTS
	A structure for the valid ports that may be used whilst running the application. More...

union	RF_GLOBAL_CFG_FROM
	Method and parameters to initialize the global configuration. More...

struct	RF_IFACE_PARAMS
	The parameters for rf_iface_start(). More...

Macros
#define	RF_BLADESTOP_PARAMS_INIT { sizeof(RF_BLADESTOP_PARAMS), 0, FALSE, FALSE, }
	Static/auto initializer for RF_BLADESTOP_PARAMS. More...

#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.

#define	RF_DFE_PORTS_INIT_TF(tf_) { sizeof(RF_DFE_PORTS), (tf_), (tf_), (tf_), (tf_), (tf_), }
	Static/auto initializer for RF_DFE_PORTS, to set the default for all ports to `TRUE` or `FALSE`.

#define	RF_DFE_PORTS_INIT RF_DFE_PORTS_INIT_TF(TRUE)
	Static/auto initializer for RF_DFE_PORTS, to set the default for all ports to `TRUE`.

#define	RF_GLOBAL_CFG_DEFAULT_FILE "ripfarm_global.json"
	Default name for global configuration file, if used.

#define	RF_GLOBAL_CFG_FROM_INIT { NULL }
	Static/auto initializer for the RF_GLOBAL_CFG_FROM union.

#define	RF_IFACE_PARAMS_INIT
	Static/auto initializer for RF_IFACE_PARAMS. Interface parameters should be initialized using this value, and then individual fields modified as desired.

Typedefs
typedef struct RF_IFACE_CTXT	RF_IFACE_CTXT
	An opaque type for a context received from rf_iface_start(). More...

typedef struct RF_BLADESTOP_PARAMS	RF_BLADESTOP_PARAMS
	Parameters for stopping a blade.

typedef struct RF_JOBSTART_PARAMS	RF_JOBSTART_PARAMS
	Parameters for starting a job.

typedef int	RF_RASTERS_STATE
	Type to pass RF_RASTERS_STATES across interfaces.

typedef struct RF_DFE_PORTS	RF_DFE_PORTS
	A structure for the valid ports that may be used whilst running the application.

typedef union RF_GLOBAL_CFG_FROM	RF_GLOBAL_CFG_FROM
	Method and parameters to initialize the global configuration.

typedef struct RF_IFACE_PARAMS	RF_IFACE_PARAMS
	The parameters for rf_iface_start().

Enumerations
enum	RF_RASTERS_STATES { RF_RASTERS_STATE_NONE = 0 , RF_RASTERS_STATE_DELIVERED = 1 , RF_RASTERS_STATE_READY = 2 , RF_RASTERS_STATE_UNREADY = 4 , RF_RASTERS_STATE_ALL = RF_RASTERS_STATE_DELIVERED\|RF_RASTERS_STATE_READY\|RF_RASTERS_STATE_UNREADY , RF_RASTERS_STATE_COUNTS = 8 }
	Page state type for RF_RASTERS_STATE, in raster status requests. These bits can be combined to request full details of the pages of different types. More...

enum	{ RF_PARSE_ERROR_MEMORY = -3 , RF_PARSE_ERROR_PORT = -2 , RF_PARSE_ERROR = -1 , RF_PARSE_SET_DEFAULTS = 0 , RF_PARSE_SET_ADDR = 1 , RF_PARSE_SET_PORT = 2 , RF_PARSE_SET_BOTH = 3 }
	Return values for rf_parse_address_and_port(). More...

enum	RF_GLOBAL_CFG_FROM_values { RF_GLOBAL_CFG_FROM_DEFAULTS = 0 , RF_GLOBAL_CFG_FROM_CBFC = 1 , RF_GLOBAL_CFG_FROM_CBFC_ABORT_ON_ERROR = 2 , RF_GLOBAL_CFG_FROM_DIRECTORY = 3 , RF_GLOBAL_CFG_FROM_JSON_STRING = 4 , RF_GLOBAL_CFG_FROM_JSON_OBJECT = 5 }
	Methods to initialize the global configuration. More...

Functions
HqBool	rf_send_farm_start (RF_IFACE_CTXT *iface_ctxt)
	Send a Farm Start message. More...

HqBool	rf_send_farm_stop (RF_IFACE_CTXT *iface_ctxt)
	Send a Farm Stop message. More...

HqBool	rf_send_blade_stop (RF_IFACE_CTXT iface_ctxt, RF_BLADESTOP_PARAMS params)
	Send a Blade Stop message. More...

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...

HqBool	rf_send_raster_connect (RF_IFACE_CTXT iface_ctxt, const char name)
	Send a request to connect a DBE to the RIP Farm. More...

HqBool	rf_send_raster_disconnect (RF_IFACE_CTXT *iface_ctxt, int connection_id)
	Send a disconnect notice for a DBE to the RIP Farm. More...

HqBool	rf_send_raster_request (RF_IFACE_CTXT *iface_ctxt, int connection_id, int job_id, int page_count)
	Request a number of undelivered rasters. More...

HqBool	rf_send_rasters_handled (RF_IFACE_CTXT *iface_ctxt, int connection_id, int job_id, int page_count)
	Indicate that a number of rasters have been handled. More...

HqBool	rf_send_job_status_request (RF_IFACE_CTXT *iface_ctxt, int job_id)
	Request a job status reply. More...

HqBool	rf_send_raster_status_request (RF_IFACE_CTXT *iface_ctxt, int job_id, RF_RASTERS_STATE page_state)
	Request a raster status reply. More...

HqBool	rf_send_rip_status_request (RF_IFACE_CTXT *iface_ctxt)
	Request a rip status reply. More...

HqBool	rf_send_blade_status_request (RF_IFACE_CTXT *iface_ctxt)
	Request a blade status reply. More...

int	rf_parse_address_and_port (const char addrandport, char phost, int pport)
	Parse incoming IP address/hostname and port combination into separate string for IP address/hostname and port. This accepts the traditional hostname:port syntax for host names, ipaddr:port for IPv4 address, and [ipaddr]:port syntax for IPv6 addresses. More...

RF_IFACE_CTXT *	rf_iface_start (RF_IFACE_PARAMS *params)
	Start the DFE Interface reactor. More...

void	rf_iface_stop (RF_IFACE_CTXT **p_iface_ctxt)
	Stop the DFE Interface reactor. More...

Detailed Description

The RIP farm DFE Interface.

This header file declares the functions for controlling the DFE Interface and sending messages to the RIP farm.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description