wiki:HTMLGfx

Version 1 (modified by romw, 6 years ago) (diff)

In progress

TOC?

Introduction

HTML and JavaScript? have become the predominate rendering technologies on the web. Used for everything from web browsing to mobile phone applications. HTMLGfx attempts to bring HTML rendering technologies into the BOINC graphics and screensaver environment.

By providing precompiled binaries the barrier to entry is greatly reduced allowing projects to deploy customized graphics for their applications. All projects would need to supply is the HTML/CSS/JavaScript required to display something about what is going on with the currently executing job.

In theory, volunteers could even get in on the act and create graphics for whatever applications suit their interests and share them with the community. It is conceivable that projects may even hold yearly competitions to include a volunteers graphics bundle to be deployed with the project's application.

Currently HTMLGfx is only supported on Windows at this time.

References: Making graphics applications for BOINC

System Overview

HTMLGfx leverages existing operating system dependent libraries for rendering HTML. By leveraging the operating systems HTML renderer HTMLGfx will be able to support whatever the latest technologies the operating systems browser supports.

Design Considerations

Assumptions and Dependencies

General Constraints

Goals and Guidelines

Development Methods

Detailed System Design

Configuration File

The graphics description file has the logical name of boinc_graphics.xml (its physical name should include a version number and other info). It has following structure:

<boinc_graphics>
    [ <default_url>filename</default_url> ]
    [ <running_url>filename</running_url> ]
    [ <suspended_url>filename</suspended_url> ]
    [ <network_suspended_url>filename</network_suspended_url> ]
    [ <exiting_url>filename</exiting_url> ]
</boinc_graphics>

Optional elements:

default_url
running_url
suspended_url
network_suspended_url
exiting_url

Graphics Status File

The graphics status file has the name of boinc_graphics_status.xml.

It is read once a second and is generally managed via the worker application via the boinc_write_graphics_status() BOINC API.

It has following structure:

<graphics_status>
    <updated_time>%f</updated_time>
    <cpu_time>%f</cpu_time>
    <elapsed_time>%f</elapsed_time>
    <fraction_done>%f</fraction_done>
    <boinc_status>
        <no_heartbeat>%d</no_heartbeat>
        <suspended>%d</suspended>
        <quit_request>%d</quit_request>
        <reread_init_data_file>%d</reread_init_data_file>
        <abort_request>%d</abort_request>
        <network_suspended>%d</network_suspended>
    </boinc_status>
</graphics_status>

Optional elements:

default_url
running_url
suspended_url
network_suspended_url
exiting_url

JavaScript Extension