Changes between Version 12 and Version 13 of RemoteJobs

Timestamp:

Jul 25, 2011, 12:54:30 AM (13 years ago)

Author:

davea

Comment:

--

RemoteJobs

@@ -23 +23 @@
 
 == PHP interface ==
+
+The following functions are provided in the file
+[/trac/browser/trunk/boinc/html/inc/submit.inc submit.inc],
+which is independent of other BOINC code and can be used in the Portal web code.
 
 === boinc_estimate_batch() ===
@@ -165 +169 @@
 == HTTPS/XML interface ==
 
-The APIs are accessed by sending a POST request,
-using HTTPS, to PROJECT_URL/submit.php
+At a lower level, the APIs are accessed by sending a POST request,
+using HTTPS, to PROJECT_URL/submit.php.
+Bindings of these RPCs can be implemented in languages other than PHP.
 
 The inputs and outputs of each function are XML documents.
@@ -185 +190 @@
 {{{
 <job>
+   <rsc_fpops_est>X</rsc_fpops_est>
    [<command_line>C</command_line>]
-   [<input_file>URL or path</input_file>]
+   [<input_file>
+      <source>URL or path</source>
+      <name>physical_name</name>
+   </input_file>]
    ... other input files
 </job>
@@ -197 +206 @@
 {{{
 <batch>
-   <app>appname</app>
-   [<input_template>x</input_template>]
-   [<output_template>x</output_template>]
-   <job>...</job>
+   <app_name>appname</app_name>
+   <job>
+      ...
+   </job>
    ... more jobs
 </batch>
 }}}
 
-The names of the input and output template files may be specified;
-otherwise the defaults '''appname_in''' and '''appname_out''' are used.
-
 === Batch runtime estimation ===
 
@@ -216 +222 @@
    <authenticator>X</authenticator>
    <batch> ... </batch>
-   [<priority>N</priority>]
 </batch_estimate>
 }}}
-
-'''Priority''', if specified, is relative to other batches submitted by this user.
 
 Output:
@@ -236 +239 @@
    <authenticator>X</authenticator>
    <batch> ... </batch>
-   [<priority>N</priority>]
 </batch_submit>
 }}}
@@ -246 +248 @@
 
 === Querying batches ===
+
+Input:
+{{{
+<query_batches>
+   <authenticator>X</authenticator>
+</query_batches>
+}}}
+
+Output:
+{{{
+<batches>
+   <batch>
+      <id>N</id>
+      <completed>0|1</completed>
+      [<fraction_done>X</fraction_done>]
+      {<completed_time>X</completed_time>]
+   </batch>
+   ...
+</batches>
+}}}
+
 === Querying a batch ===
 
@@ -258 +281 @@
 Output:
 {{{
-<batch_status>
-   <fraction_done>X</fraction_done>
-   <jobs_completed>N</jobs_completed>
-   <remaining_time>X</remaining_time>
-</batch_status>
+<batch>
+   <job>
+      <id>N</id>
+      <canonical_resultid>N</canonical_resultid>
+      [<outfile>name</outfile>]
+      ...
+   </job>
+</batch>
 }}}
 
 === Aborting a batch ===
+
+Input:
+
+{{{
+<abort_batch>
+   <authenticator>X</authenticator>
+   <batch_id>N</batch_id>
+</query_batch>
+}}}
 
 == Implementation notes ==