fab_req_session
fam_session* fab_req_session(fab_req* request)
This function retrieves the session identifier associated with this task request.
| Parameters |
| fab_req* |
task request object passed into the function |
| Return Value |
| fam_session* |
pointer to session identifier |
fab_req_username
const char* fab_req_username(fab_req* request)
This function returns the user name.
| Parameters |
| fab_req* |
task request object passed into the function |
| Return Value |
| const char* |
user name |
fab_req_task_name
const char* fab_req_task_name(fab_req* request)
This function returns the task name associated with this task request.
| Parameters |
| fab_req* |
task request object passed into the function |
| Return Value |
| const char* |
task name |
fab_req_process_flow_name
const char* fab_req_process_flow_name(fab_req* request)
This function retrieves the top-level process flow name associated with this task. If this task is being called by a sub-process flow, this will return the name of the main process flow. Use getCurrentProcessFlowName to get the name of the calling sub-process flow.
| Parameters |
| fab_req* |
task request object passed into the function |
| Return Value |
| const char* |
process flow name |
fab_req_current_process_flow_name
const char* fab_req_current_process_flow_name(fab_req* request)
This function retrieves the current process flow name associated with this task. If the task is being called by a sub-process flow, then this will be the name of the sub-process flow. If this is not a sub-process flow, then the name will be the top-level process flow name.
| Parameters |
| fab_req* |
task request object passed into the function |
| Return Value |
| const char* |
process flow name |
fab_req_set_result
void fab_req_set_result(fab_req* request,
const char* result)
This function sets the task result value for the request.
| Parameters |
| fab_req* |
task request object passed into the function |
| const char* |
task result value |
fab_req_result
const char* fab_req_result(fab_req* request)
This function retrieves the task result value for the request.
| Parameters |
| fab_req* |
task request object passed into the function |
| Return Value |
| const char* |
task result value |
fab_req_set_task_timeout
void fab_req_set_task_timeout(fab_req* request,
int seconds)
This function sets the maximum amount of time, in seconds, the worker may take to process the task.
This timeout value allows task code to override the timeout originally specified in the process flow. For example, the default timeout for the task called from the process flow may be to allow five seconds for this task to execute before the process flow will timeout and give up on the task. This timeout value allows the task code to specify a new timeout this this instance of the task during the execution of this request, based on execution-time information.
| Parameters |
| fab_req* |
task request object passed into the function |
| int |
maximum amount of time, in seconds, the worker may take to process the task |
fab_req_task_timeout
int fab_req_task_timeout(fab_req* request)
This function returns the maximum amount of time in seconds the worker may take to process the task.
This timeout value allows task code to override the timeout originally specified in the process flow. For example, the default timeout for the task called from the process flow may be to allow five seconds for this task to execute before the process flow will timeout and give up on the task. This timeout value allows the task code to specify a new timeout this this instance of the task during the execution of this request, based on execution-time information.
| Parameters |
| fab_req* |
task request object passed into the function |
| Return Value |
| int |
maximum amount of time, in seconds, the worker may take to process the task |
