2004-06-09 19:09:16 +00:00
|
|
|
<?php
|
2004-02-09 05:11:05 +00:00
|
|
|
require_once("docutil.php");
|
|
|
|
|
page_head("Framework for separate GUIs");
|
|
|
|
|
echo "
|
|
|
|
|
<p>
|
2004-02-28 19:11:40 +00:00
|
|
|
The BOINC core client provides a set of RPCs
|
|
|
|
|
(remote procedure calls) for control and state interrogation.
|
|
|
|
|
This will enable the development of GUI (graphical user interface)
|
|
|
|
|
programs separately from the core client.
|
|
|
|
|
This will make it easier to develop new GUIs,
|
2004-02-09 05:11:05 +00:00
|
|
|
and will eliminate security issues related
|
|
|
|
|
to having GUI code in the core client.
|
|
|
|
|
<p>
|
2004-06-17 17:00:14 +00:00
|
|
|
GUI programs connect to the core client by opening a TCP socket at port 31416.
|
2004-02-09 05:11:05 +00:00
|
|
|
They can then do repeated RPCs over this connection.
|
2004-06-17 17:00:14 +00:00
|
|
|
Each reply message ends with the character '\\003.
|
2004-02-09 05:11:05 +00:00
|
|
|
<p>
|
2004-02-28 19:11:40 +00:00
|
|
|
The current RPCs are available:
|
|
|
|
|
";
|
|
|
|
|
list_start();
|
2004-03-21 00:10:15 +00:00
|
|
|
list_heading("Request message format", "Function");
|
2004-02-28 19:11:40 +00:00
|
|
|
list_item(
|
|
|
|
|
html_text("<get_state/>"),
|
|
|
|
|
"Get the state of the core client.
|
2004-03-21 00:10:15 +00:00
|
|
|
The reply message has the same format as the client_state.xml file."
|
2004-02-28 19:11:40 +00:00
|
|
|
);
|
2004-06-17 17:00:14 +00:00
|
|
|
list_item(
|
|
|
|
|
html_text(
|
|
|
|
|
"<get_messages>
|
|
|
|
|
<nmessages>N</nmessages>
|
|
|
|
|
<seqno>M</seqno>
|
|
|
|
|
</get_messages>"),
|
|
|
|
|
"Returns a list of (user-level) messages.
|
|
|
|
|
Each message has a sequence number (1, 2, ...),
|
|
|
|
|
a priority (1=informational, 2=error)
|
|
|
|
|
and a timestamp.
|
|
|
|
|
The RPC requests the N most recent messages
|
|
|
|
|
with sequence numbers greater than M.
|
|
|
|
|
They are returned in order of decreasing sequence number.
|
|
|
|
|
The reply has the form ".html_text(
|
|
|
|
|
"<msgs>
|
|
|
|
|
<msg>
|
|
|
|
|
<pri>x</pri>
|
|
|
|
|
<seqno>x</seqno>
|
|
|
|
|
<body>
|
|
|
|
|
x
|
|
|
|
|
</body>
|
|
|
|
|
<time>x</time>
|
|
|
|
|
</msg>
|
|
|
|
|
...
|
|
|
|
|
</msgs>")
|
|
|
|
|
);
|
|
|
|
|
|
2004-02-28 19:11:40 +00:00
|
|
|
list_item(
|
|
|
|
|
html_text(
|
|
|
|
|
"<result_show_graphics>
|
2004-03-17 01:26:44 +00:00
|
|
|
<project_url>X</project_url>
|
|
|
|
|
<result_name>X</result_name>
|
|
|
|
|
</result_show_graphics>
|
2004-02-28 19:11:40 +00:00
|
|
|
"),
|
|
|
|
|
"Request that the application processing the given result
|
|
|
|
|
create a graphics window"
|
|
|
|
|
);
|
|
|
|
|
list_item(
|
|
|
|
|
html_text(
|
|
|
|
|
"<project_reset>
|
2004-03-17 01:26:44 +00:00
|
|
|
<project_url>X</project_url>
|
|
|
|
|
</project_reset>"
|
2004-02-28 19:11:40 +00:00
|
|
|
),
|
|
|
|
|
"Reset the given project"
|
|
|
|
|
);
|
|
|
|
|
list_item(
|
|
|
|
|
html_text(
|
|
|
|
|
"<project_update>
|
2004-03-17 01:26:44 +00:00
|
|
|
<project_url>X</project_url>
|
|
|
|
|
</project_update>"
|
2004-02-28 19:11:40 +00:00
|
|
|
),
|
|
|
|
|
"Update the given project"
|
|
|
|
|
);
|
|
|
|
|
list_item(
|
|
|
|
|
html_text(
|
|
|
|
|
"<project_detach>
|
2004-03-17 01:26:44 +00:00
|
|
|
<project_url>X</project_url>
|
|
|
|
|
</project_detach>"
|
2004-02-28 19:11:40 +00:00
|
|
|
),
|
|
|
|
|
"Detach from the given project"
|
|
|
|
|
);
|
|
|
|
|
list_item(
|
|
|
|
|
html_text(
|
|
|
|
|
"<project_attach>
|
2004-03-17 01:26:44 +00:00
|
|
|
<project_url>X</project_url>
|
|
|
|
|
<authenticator>X</authenticator>
|
|
|
|
|
</project_attach>"
|
2004-02-28 19:11:40 +00:00
|
|
|
),
|
|
|
|
|
"Attach to the given project"
|
|
|
|
|
);
|
|
|
|
|
list_item(
|
|
|
|
|
html_text("<run_benchmarks/>"),
|
|
|
|
|
"Run benchmarks"
|
|
|
|
|
);
|
|
|
|
|
list_item(
|
|
|
|
|
html_text(
|
|
|
|
|
"<set_proxy_settings>
|
2004-03-17 01:26:44 +00:00
|
|
|
<proxy_server_name>X</proxy_server_name>
|
|
|
|
|
<proxy_server_port>X</proxy_server_port>
|
|
|
|
|
</set_proxy_settings>"
|
2004-02-28 19:11:40 +00:00
|
|
|
),
|
|
|
|
|
"Set proxy settings"
|
|
|
|
|
);
|
|
|
|
|
list_end();
|
|
|
|
|
echo "
|
2004-02-09 05:11:05 +00:00
|
|
|
<p>
|
|
|
|
|
The BOINC source code distribution includes files
|
|
|
|
|
<code>gui_rpc_client.C</code> and <code>gui_rpc_client.h</code>
|
|
|
|
|
in the client directory.
|
|
|
|
|
These define a class <code>GUI_RPC</code>
|
|
|
|
|
that manages the establishment of the RPC pipe,
|
|
|
|
|
and that parses the returned XML into a data structure
|
|
|
|
|
from which the GUI can be generated.
|
2004-03-02 03:46:04 +00:00
|
|
|
The project <code>gui_test.C</code> shows how to use this mechanism.
|
2004-02-09 05:11:05 +00:00
|
|
|
";
|
|
|
|
|
page_tail();
|
|
|
|
|
?>
|
