Harlequin RIP SDK

Parameters for stopping a blade. More...

#include "rf_library.h"

Data Fields

size_t size
 Size of this structure.
 
int blade_id
 Blade ID to stop. More...
 
HqBool stop_controller
 Stop the blade controller as well as Farm RIPs. More...
 
HqBool force
 Force termination of Farm RIPs. More...
 

Detailed Description

Parameters for stopping a blade.

Field Documentation

◆ blade_id

int RF_BLADESTOP_PARAMS::blade_id

Blade ID to stop.

This should be a non-negative integer. Obtained via bladestatus.

◆ force

HqBool RF_BLADESTOP_PARAMS::force

Force termination of Farm RIPs.

If TRUE, will terminate all the farm RIPs on the specified blade immediately bypassing any orderly farm RIP exit code. Similar to a kill -9 on Linux. If FALSE, blade stop will wait until the farm RIPs on that blade have completed any work they are doing before being asked to exit cleanly. If any of the farm RIPs on the blade have a lot of work to complete when a blade stop is received, stopping of the blade can take some time as it waits for all of its farm RIPs to exit after completing their work. No new work will be scheduled to any of blades farm RIPs once a blade stop has been received.

◆ stop_controller

HqBool RF_BLADESTOP_PARAMS::stop_controller

Stop the blade controller as well as Farm RIPs.

If TRUE, the blade stop will also cause the blade controller to exit once all of its farm RIPs have exited whether the blade controller is persistent or not. If FALSE, the blade controller will remain running but only if it is a persistent blade controller.


The documentation for this struct was generated from the following file: