|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
Data Structures | |
| struct | RF_BLADESTOP_PARAMS |
| Parameters for stopping a blade. More... | |
Macros | |
| #define | RF_BLADESTOP_PARAMS_INIT { sizeof(RF_BLADESTOP_PARAMS), 0, FALSE, FALSE, } |
| Static/auto initializer for RF_BLADESTOP_PARAMS. More... | |
Typedefs | |
| typedef struct RF_BLADESTOP_PARAMS | RF_BLADESTOP_PARAMS |
| Parameters for stopping a blade. | |
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... | |
The functions for starting and stopping the RIP Farm are only available if the interface was started with RF_DFE_PORTS::startPort enabled.
The rf_send_rip_status_request() and rf_send_blade_status_request() functions may be used to query the RIP Farm status. They are only available if the interface was started with RF_DFE_PORTS::statusPort enabled.
| #define RF_BLADESTOP_PARAMS_INIT { sizeof(RF_BLADESTOP_PARAMS), 0, FALSE, FALSE, } |
Static/auto initializer for RF_BLADESTOP_PARAMS.
Blade stop parameters should be initialized using this value, and then individual fields modified as desired.
| HqBool rf_send_blade_stop | ( | RF_IFACE_CTXT * | iface_ctxt, |
| RF_BLADESTOP_PARAMS * | params | ||
| ) |
Send a Blade Stop message.
An immediate reply of an RF_BLADE_STOPPING message is expected.
| [in] | iface_ctxt | The context handle from rf_iface_start(). |
| [in] | params | The blade stop information. |
TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message. | HqBool rf_send_farm_start | ( | RF_IFACE_CTXT * | iface_ctxt | ) |
Send a Farm Start message.
An immediate reply of an RF_FARM_STARTING message is expected. When the RIP farm has been successfully started (or failed to start), an RF_FARM_STARTED message should be received.
If a global config JSON tree is provided to rf_iface_start() by setting the RF_IFACE_PARAMS::global_cfg_method and RF_IFACE_PARAMS::global_cfg_from fields, and that JSON tree has a SpawnBeforeFarmStart object with the sub-key Executable set to a string, rf_send_farm_start() will attempt to spawn that executable before sending the farm start message. This can be used to launch the Scalable RIP and start it.
| [in] | iface_ctxt | The context handle from rf_iface_start(). |
TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message. | HqBool rf_send_farm_stop | ( | RF_IFACE_CTXT * | iface_ctxt | ) |
Send a Farm Stop message.
An immediate reply of an RF_FARM_STOPPING message is expected. When the RIP farm has been successfully stopped (or failed to stop), an RF_FARM_STOPPED message should be received.
| [in] | iface_ctxt | The context handle from rf_iface_start(). |
TRUE if the message was successfully queued. Otherwise FALSE. A TRUE value doesn't necessarily mean the RIP farm received the message.