Changes between Version 25 and Version 26 of HTMLGfx

Timestamp:

Jan 21, 2015, 9:29:15 PM (9 years ago)

Author:

romw

Comment:

--

HTMLGfx

@@ -39 +39 @@
 Top level goals are:
  * Projects should only need to create HTML/CSS/!JavaScript to have a fully functional graphics application.
- * Use native platforms predominate HTML rendering technology.
-
-=== Development Methods ===
-Use whatever framework/tools are required to build a customized browser-based application.
-
-On Windows:
- * Use Visual Studio
- * Use Active Template Library
+ * Projects should be able to use their favorite browser to debug their graphics application.
 
 == Detailed System Design ==
 
-=== CHTMLBrowserWnd ===
+=== HTML Window ===
 This component is responsible for creating the main frame window used for hosting the web browser 
-control via CHTMLBrowserHost.
-
-As part of the normal operations of the window, it should update the URL the web browser control is
-displaying as state changes are detected.  It should also publish updated information to the !JavaScript
-interface.
+control as well as creating the web browser control itself.
+
+As part of the normal operations of the window, it should update which URL the web browser control is
+displaying as state changes are detected.
 
 It supports whatever requirements are described for BOINC graphics applications.
@@ -62 +54 @@
 Reference: [GraphicsApi#Graphicsapps Making graphics applications for BOINC]
 
-=== CHTMLBrowserHost ===
-This component hosts the web browser control and exposes whatever interfaces/callbacks the control
-requires for logging and display purposes.  As part of its creation process it creates/exposes 
-the !JavaScript interface for CHTMLBrowserWnd to use.
-
-=== CHTMLBrowserHostUI ===
-This component acts as the !JavaScript interoperability component.  It should only support single 
-threaded access.
+=== HTTP Server ===
+This component serves up content from the slot directory running the application.  It should only be
+bound to the loopback adapter and should not provide a default document nor a directory listing
+when queried.  It should only serve up files that are contained within the slot directory structure.
+
+=== HTTP Server RPCs ===
+
+==== Embedded Static Content ====
+The following files are embedded within the executable:
+|| Namespace              || Contents ||
+|| /api/static/index.html || [http://boinc.berkeley.edu/gitweb/?p=boinc-v2.git;a=blob;f=samples/gfx_html/templates/index.html;hb=master index.html] ||
+|| /api/static/boinc.png  || [http://boinc.berkeley.edu/gitweb/?p=boinc-v2.git;a=blob;f=samples/gfx_html/templates/boinc.png;hb=master boinc.png] ||
+|| /api/static/boinc.js   || [http://boinc.berkeley.edu/gitweb/?p=boinc-v2.git;a=blob;f=samples/gfx_html/templates/boinc.js;hb=master boinc.js] ||
+
+==== Retrieve init_data.xml ====
+Returns the contents of the init_data.xml file.
+
+|| Namespace:  || /api/getInitData ||
+|| Parameters: || None ||
+|| Returns:    || XmlDocument ||
+
+==== Retrieve graphics_status.xml ====
+Returns the contents of the graphics_status.xml file and in addition the Vboxwrapper WebAPI and Remote 
+Desktop port information.
+
+|| Namespace:  || /api/getGraphicsStatus ||
+|| Parameters: || None ||
+|| Returns:    || XmlDocument ||
+
+==== Reset reread_init_data_file flag ====
+Resets the internal flag notifying the HTML application it needs to read the init_data.xml file.  This
+flag is published as part of the /api/getGraphicsStatus API.
+
+|| Namespace:  || /api/resetReadFlag ||
+|| Parameters: || None ||
+|| Returns:    || XmlDocument ||
+
+==== Calling RPCs ====
+Here is some prototype code for calling the described RPCs:
+{{{
+function createRequest {
+    var xmlHttp = null;
+    var XMLHttpFactories = [
+        function () { return new XMLHttpRequest() },
+        function () { return new ActiveXObject('Msxml2.XMLHTTP') },
+        function () { return new ActiveXObject('Msxml3.XMLHTTP') },
+        function () { return new ActiveXObject('Microsoft.XMLHTTP') }
+    ];
+
+    for (var i = 0; i < XMLHttpFactories.length; i++) {
+        try {
+            xmlHttp = XMLHttpFactories[i]();
+        } catch (e) {
+            continue;
+        }
+        break;
+    }
+    return xmlHttp;
+}
+
+function sendRequest(url) {
+    var req = createRequest();
+    var response = null;
+    req.open('GET', url, false);
+    req.send();
+    response = req.responseXML;
+    req = null;
+    return response;
+}
+
+var xmlDocument = sendRequest('/api/getInitData');
+
+}}}
 
 === State URL Selection Process ===
@@ -118 +175 @@
     document to display before the task exits in 5 seconds or less.
 
-'''NOTE:''' Any file specified in the configuration file and any related support files
-will need to have the <copy_file/> directive included in the versions.xml file 
-describing the application version.
-
 === Graphics Status File ===
 It is read once a second and is generally managed via the worker applications via