Harlequin RIP SDK
Data Structures | Typedefs | Functions
Job message structures
RIP Farm: API and Library to split jobs across multiple RIPs » Interface for receiving messages from the RIP farm » Extract messages to a C structure

Data Structures

struct  RF_REPLY_JOB_STARTING
 The structure of a Job Starting message. This is sent in reply to rf_send_job_start(). More...
 
struct  RF_REPLY_JOB_CANCELLING
 The structure of a Job Cancelling message. This is sent in reply to rf_send_job_cancel().
More...
 
struct  RF_REPLY_JOB_PAUSING
 The structure of a Job Pausing message. This is sent in reply to rf_send_job_pause().
More...
 
struct  RF_REPLY_JOB_RESUMING
 The structure of a Job Resuming message. This is sent in reply to rf_send_job_resume().
More...
 

Typedefs

typedef struct RF_REPLY_JOB_STARTING RF_REPLY_JOB_STARTING
 The structure of a Job Starting message. This is sent in reply to rf_send_job_start().
 
typedef struct RF_REPLY_JOB_CANCELLING RF_REPLY_JOB_CANCELLING
 The structure of a Job Cancelling message. This is sent in reply to rf_send_job_cancel().

 
typedef struct RF_REPLY_JOB_PAUSING RF_REPLY_JOB_PAUSING
 The structure of a Job Pausing message. This is sent in reply to rf_send_job_pause().

 
typedef struct RF_REPLY_JOB_RESUMING RF_REPLY_JOB_RESUMING
 The structure of a Job Resuming message. This is sent in reply to rf_send_job_resume().

 

Functions

RF_REPLY_JOB_STARTING * rf_extract_job_starting (RF_FARM_REPLY *farm_reply)
 Extract farm_reply->payload into a RF_REPLY_JOB_STARTING structure. More...
 
void rf_free_job_starting (RF_REPLY_JOB_STARTING **p_job_starting)
 Free the C structure created by rf_extract_job_starting(). More...
 
RF_REPLY_JOB_CANCELLING * rf_extract_job_cancelling (RF_FARM_REPLY *farm_reply)
 Extract farm_reply->payload into a RF_REPLY_JOB_CANCELLING structure. More...
 
void rf_free_job_cancelling (RF_REPLY_JOB_CANCELLING **p_job_cancelling)
 Free the C structure created by rf_extract_job_cancelling(). More...
 
RF_REPLY_JOB_PAUSING * rf_extract_job_pausing (RF_FARM_REPLY *farm_reply)
 Extract farm_reply->payload into a RF_REPLY_JOB_PAUSING structure. More...
 
void rf_free_job_pausing (RF_REPLY_JOB_PAUSING **p_job_pausing)
 Free the C structure created by rf_extract_job_pausing(). More...
 
RF_REPLY_JOB_RESUMING * rf_extract_job_resuming (RF_FARM_REPLY *farm_reply)
 Extract farm_reply->payload into a RF_REPLY_JOB_RESUMING structure. More...
 
void rf_free_job_resuming (RF_REPLY_JOB_RESUMING **p_job_resuming)
 Free the C structure created by rf_extract_job_resuming(). More...
 

Detailed Description

Function Documentation

◆ rf_extract_job_cancelling()

RF_REPLY_JOB_CANCELLING* rf_extract_job_cancelling ( RF_FARM_REPLY *  farm_reply)

Extract farm_reply->payload into a RF_REPLY_JOB_CANCELLING structure.

Parameters
[in]farm_replyContains the message payload.
Returns
If successful, the C structure will be returned. Otherwise NULL. The returned structure should be freed using rf_free_job_cancelling() when no longer required.

◆ rf_extract_job_pausing()

RF_REPLY_JOB_PAUSING* rf_extract_job_pausing ( RF_FARM_REPLY *  farm_reply)

Extract farm_reply->payload into a RF_REPLY_JOB_PAUSING structure.

Parameters
[in]farm_replyContains the message payload.
Returns
If successful, the C structure will be returned. Otherwise NULL. The returned structure should be freed using rf_free_job_pausing() when no longer required.

◆ rf_extract_job_resuming()

RF_REPLY_JOB_RESUMING* rf_extract_job_resuming ( RF_FARM_REPLY *  farm_reply)

Extract farm_reply->payload into a RF_REPLY_JOB_RESUMING structure.

Parameters
[in]farm_replyContains 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_extract_job_starting()

RF_REPLY_JOB_STARTING* rf_extract_job_starting ( RF_FARM_REPLY *  farm_reply)

Extract farm_reply->payload into a RF_REPLY_JOB_STARTING structure.

Parameters
[in]farm_replyContains the message payload.
Returns
If successful, the C structure will be returned. Otherwise NULL. The returned structure should be freed using rf_free_job_starting() when no longer required.

◆ rf_free_job_cancelling()

void rf_free_job_cancelling ( RF_REPLY_JOB_CANCELLING **  p_job_cancelling)

Free the C structure created by rf_extract_job_cancelling().

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

◆ rf_free_job_pausing()

void rf_free_job_pausing ( RF_REPLY_JOB_PAUSING **  p_job_pausing)

Free the C structure created by rf_extract_job_pausing().

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

◆ rf_free_job_resuming()

void rf_free_job_resuming ( RF_REPLY_JOB_RESUMING **  p_job_resuming)

Free the C structure created by rf_extract_job_resuming().

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

◆ rf_free_job_starting()

void rf_free_job_starting ( RF_REPLY_JOB_STARTING **  p_job_starting)

Free the C structure created by rf_extract_job_starting().

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