cctools
Data Fields
work_queue_task Struct Reference

A task description. More...

#include <work_queue.h>

Data Fields

char * tag
 An optional user-defined logical name for the task. More...
 
char * command_line
 The program(s) to execute, as a shell command line. More...
 
int worker_selection_algorithm
 How to choose worker to run the task. More...
 
char * output
 The standard output of the task. More...
 
struct listinput_files
 The files to transfer to the worker and place in the executing directory. More...
 
struct listoutput_files
 The output files (other than the standard output stream) created by the program expected to be retrieved from the task. More...
 
char * preferred_host
 The hostname where the task should preferrentially be run. More...
 
int taskid
 A unique task id number. More...
 
int status
 Current status of the task. More...
 
int return_status
 The exit code of the command line. More...
 
int result
 The result of the task (successful, failed return_status, missing input file, missing output file). More...
 
char * host
 The name of the host on which it ran. More...
 
timestamp_t submit_time
 The time the task was submitted. More...
 
timestamp_t transfer_start_time
 The time at which it started to transfer input files. More...
 
timestamp_t start_time
 The time representing the start of the task. More...
 
timestamp_t finish_time
 The time representing the end of the task. More...
 
timestamp_t computation_time
 Elapsed time between start_time and the beginning of the transfer of output files. More...
 
INT64_T total_bytes_transferred
 Number of bytes transferred since task has last started transferring input data. More...
 
timestamp_t total_transfer_time
 Time comsumed in microseconds for transferring total_bytes_transferred. More...
 

Detailed Description

A task description.

This structure should only be created with work_queue_task_create and delete with work_queue_task_delete. You may examine (but not modify) this structure once a task has completed.

Field Documentation

char* work_queue_task::tag

An optional user-defined logical name for the task.

char* work_queue_task::command_line

The program(s) to execute, as a shell command line.

int work_queue_task::worker_selection_algorithm

How to choose worker to run the task.

char* work_queue_task::output

The standard output of the task.

struct list* work_queue_task::input_files

The files to transfer to the worker and place in the executing directory.

struct list* work_queue_task::output_files

The output files (other than the standard output stream) created by the program expected to be retrieved from the task.

char* work_queue_task::preferred_host

The hostname where the task should preferrentially be run.

int work_queue_task::taskid

A unique task id number.

int work_queue_task::status

Current status of the task.

int work_queue_task::return_status

The exit code of the command line.

int work_queue_task::result

The result of the task (successful, failed return_status, missing input file, missing output file).

char* work_queue_task::host

The name of the host on which it ran.

timestamp_t work_queue_task::submit_time

The time the task was submitted.

timestamp_t work_queue_task::transfer_start_time

The time at which it started to transfer input files.

timestamp_t work_queue_task::start_time

The time representing the start of the task.

Recorded as the timestamp immediately after all its input files were transferred.

timestamp_t work_queue_task::finish_time

The time representing the end of the task.

Recorded as the timestamp immediately after all its output files were received.

timestamp_t work_queue_task::computation_time

Elapsed time between start_time and the beginning of the transfer of output files.

INT64_T work_queue_task::total_bytes_transferred

Number of bytes transferred since task has last started transferring input data.

timestamp_t work_queue_task::total_transfer_time

Time comsumed in microseconds for transferring total_bytes_transferred.


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