Changes between Version 39 and Version 40 of RemoteJobs

Timestamp:

Oct 22, 2013, 4:32:58 PM (11 years ago)

Author:

davea

Comment:

--

RemoteJobs

@@ -270 +270 @@
 === query_batches() ===
 
-Query the status of a set of batches.
-{{{
-extern int query_batches(
-    const char* project_url,
-    const char* authenticator,
-    vector<string> &batch_names,
-    QUERY_BATCH_REPLY& reply,
-    string& error_msg
-);
-
-struct QUERY_BATCH_JOB {
-    string job_name;
-    string status;              // DONE, ERROR, or IN_PROGRESS
-    QUERY_BATCH_JOB(){}
-};
-
-struct QUERY_BATCH_REPLY {
-    vector<int> batch_sizes;    // how many jobs in each of the queried batches
-    vector<QUERY_BATCH_JOB> jobs;   // the jobs, sequentially
+Query the status of this user's batches.
+
+{{{
+int query_batches(
+    const char* project_url,
+    const char* authenticator,
+    vector<BATCH_STATUS>& batches,
+    string& error_msg
+);
+
+struct BATCH_STATUS {
+    int id;
+    char name[256];             // name of batch
+    char app_name[256];
+    int state;                  // see lib/common_defs.h
+    int njobs;                  // how many jobs in batch
+    int nerror_jobs;            // how many jobs errored out
+    double fraction_done;       // how much of batch is done (0..1)
+    double create_time;         // when batch was created
+    double expire_time;         // when it will expire
+    double est_completion_time;     // estimated completion time
+    double completion_time;     // if completed, actual completion time
+    double credit_estimate;     // original estimate for credit
+    double credit_canonical;    // if completed, granted credit
+
+    int parse(XML_PARSER&);
+    void print();
+};
+}}}
+
+=== query_batch() ===
+
+Return the detailed status of jobs in a given batch (can specify by either ID or name).
+
+{{{
+extern int query_batch(
+    const char* project_url,
+    const char* authenticator,
+    int batch_id,
+    const char batch_name[256],
+    vector<JOB_STATE>& jobs,
+    string& error_msg
+);
+
+struct JOB_STATE {
+    int id;
+    char name[256];
+    int canonical_instance_id;      // it job completed successfully,
+                                    // the ID of the canonical instance
+    int n_outfiles;                 // number of output files
 };
 
@@ -374 +405 @@
 }}}
 
+=== query_batch_set() ===
+
+Return the status of the jobs in a given set of batches.
+This is used by the Condor interface; it's probably not useful outside of that.
+{{{
+extern int query_batch_set(
+    const char* project_url,
+    const char* authenticator,
+    vector<string> &batch_names,
+    QUERY_BATCH_REPLY& reply,
+    string& error_msg
+);
+
+struct JOB_STATUS {
+    string job_name;
+    string status;              // DONE, ERROR, or IN_PROGRESS
+};
+
+struct QUERY_BATCH_SET_REPLY {
+    vector<int> batch_sizes;    // how many jobs in each of the queried batches
+    vector<JOB_STATUS> jobs;   // the jobs, sequentially
+};
+
+}}}
 
 == HTTP/XML interface ==
@@ -392 +447 @@
 However, you will have to modify it heavily for your particular
 applications and web site.
+