fab_req_session
fam_session* fab_req_session(fab_req* request)
This function retrieves the session identifier associated with this background task.
| fab_req* |
task request object passed in for this background task |
| fam_session* |
pointer to session identifier |
fab_req_task_name
const char* fab_req_task_name(fab_req* request)
This function returns the background task name.
| fab_req* |
task object passed into the function |
| const char* |
task name |
fab_req_set_task_failure
void fab_req_set_task_failure(fab_req* request,
const char* error_msg)
This function sets an error message. When the background task function returns, if the error message is set, the fabric will broadcast the error message to the log monitor. Additionally, if the error message is set, this initiates a small delay before the background task is again executed. The length of the delay is specified by the background task's retryDelay in the Task Module Definition XML.
| fab_req* |
task object passed into the function |
| const char* |
error message |