Changes between Version 48 and Version 49 of BasicApi

Timestamp:

Dec 28, 2014, 10:21:12 AM (10 years ago)

Author:

romw

Comment:

Add graphic status apis

BasicApi

@@ -293 +293 @@
    In this case "is_notice" would be true,
    because the user can update VirtualBox.
+
+== Graphics Status ==
+
+Used by worker applications to inform graphics applications of various pieces of 
+runtime state information.
+
+Worker applications call:
+{{{
+#!c++
+int boinc_write_graphics_status(
+    double cpu_time, double elapsed_time, double fraction_done
+);
+}}}
+
+Graphics applications call:
+{{{
+#!c++
+int boinc_parse_graphics_status(
+    double* update_time, double* cpu_time, double* elapsed_time, double* fraction_done, BOINC_STATUS* status
+);
+}}}
+
+=== Graphics Status File ===
+
+The graphics status file has the name of '''boinc_graphics_status.xml'''.
+
+It has following structure:
+{{{
+<graphics_status>
+    <updated_time>X</updated_time>
+    <cpu_time>X</cpu_time>
+    <elapsed_time>X</elapsed_time>
+    <fraction_done>X</fraction_done>
+    <boinc_status>
+        <no_heartbeat>0|1</no_heartbeat>
+        <suspended>0|1</suspended>
+        <quit_request>0|1</quit_request>
+        <reread_init_data_file>0|1</reread_init_data_file>
+        <abort_request>0|1</abort_request>
+        <network_suspended>0|1</network_suspended>
+    </boinc_status>
+</graphics_status>
+}}}
+Required elements:
+ '''updated_time'''::
+    UNIX time of the last time this file was updated.
+ '''cpu_time''':: 
+    Amount of CPU time this task has consumed, in seconds.
+ '''elapsed_time'''::
+    Amount of wall clock time this task has consumed, in seconds.
+ '''fraction_done''':: 
+    What percentage of the overall task is complete, values between 0..1.
+ '''no_heartbeat''':: 
+    Whether or not the task has received a heartbeat as of the last update.
+ '''suspended''':: 
+    Whether or not the task is suspended.
+ '''quit_request''':: 
+    Whether or not the task has been requested to exit.
+ '''reread_init_data_file''':: 
+    Whether or not the task should reread all initialization data.
+ '''abort_request''':: 
+    Whether or not the task has been requested to abort.
+ '''network_suspended''':: 
+    Whether or not the task has been told the network has been suspended.