Changes between Version 48 and Version 49 of BasicApi


Ignore:
Timestamp:
Dec 28, 2014, 10:21:12 AM (10 years ago)
Author:
romw
Comment:

Add graphic status apis

Legend:

Unmodified
Added
Removed
Modified
  • BasicApi

    v48 v49  
    293293   In this case "is_notice" would be true,
    294294   because the user can update VirtualBox.
     295
     296== Graphics Status ==
     297
     298Used by worker applications to inform graphics applications of various pieces of
     299runtime state information.
     300
     301Worker applications call:
     302{{{
     303#!c++
     304int boinc_write_graphics_status(
     305    double cpu_time, double elapsed_time, double fraction_done
     306);
     307}}}
     308
     309Graphics applications call:
     310{{{
     311#!c++
     312int boinc_parse_graphics_status(
     313    double* update_time, double* cpu_time, double* elapsed_time, double* fraction_done, BOINC_STATUS* status
     314);
     315}}}
     316
     317=== Graphics Status File ===
     318
     319The graphics status file has the name of '''boinc_graphics_status.xml'''.
     320
     321It has following structure:
     322{{{
     323<graphics_status>
     324    <updated_time>X</updated_time>
     325    <cpu_time>X</cpu_time>
     326    <elapsed_time>X</elapsed_time>
     327    <fraction_done>X</fraction_done>
     328    <boinc_status>
     329        <no_heartbeat>0|1</no_heartbeat>
     330        <suspended>0|1</suspended>
     331        <quit_request>0|1</quit_request>
     332        <reread_init_data_file>0|1</reread_init_data_file>
     333        <abort_request>0|1</abort_request>
     334        <network_suspended>0|1</network_suspended>
     335    </boinc_status>
     336</graphics_status>
     337}}}
     338Required elements:
     339 '''updated_time'''::
     340    UNIX time of the last time this file was updated.
     341 '''cpu_time'''::
     342    Amount of CPU time this task has consumed, in seconds.
     343 '''elapsed_time'''::
     344    Amount of wall clock time this task has consumed, in seconds.
     345 '''fraction_done'''::
     346    What percentage of the overall task is complete, values between 0..1.
     347 '''no_heartbeat'''::
     348    Whether or not the task has received a heartbeat as of the last update.
     349 '''suspended'''::
     350    Whether or not the task is suspended.
     351 '''quit_request'''::
     352    Whether or not the task has been requested to exit.
     353 '''reread_init_data_file'''::
     354    Whether or not the task should reread all initialization data.
     355 '''abort_request'''::
     356    Whether or not the task has been requested to abort.
     357 '''network_suspended'''::
     358    Whether or not the task has been told the network has been suspended.