boinc/doc/protocol.html

100 lines
3.1 KiB
HTML

<h2>The BOINC client/server protocol</h2>
<p>
The core client communicates with scheduling servers using HTTP.
The form of the request is:
<pre>
&lt;scheduler_request>
&lt;platform>intel-linux&lt;/platform>
&lt;version_num>1&lt;/version_num>
... other elements
&lt;/scheduler_request>
</pre>
The "platform" and "version_num" elements identify the
version of the core client originating the request.
<p>
The form of the reply is:
<pre>
&lt;scheduler_reply>
[ &lt;message priority="low"> arbitrary text &lt;/message> ... ]
[ &lt;request_delay>3600&lt;/request_delay> ]
... other elements
&lt;/scheduler_reply>
</pre>
<p>
The "message" element provides message for the core client.
If the priority is "high", the core client should do what it can
to ensure the the participant sees the message
(e.g., display it in a modal dialog).
This should be reserved for situations where definitive action
is required, e.g. the user must download a new version of the
core client in order to continue participating in this project.
If the priority is "low" (default) the core client should
allow the participant to see the message, but not require it;
e.g., by writing the message to a log file.
<p>
A reply message can contain multiple message elements.
<p>
The optional "request_delay" tag instructs the client
to not issue another request until the indicated number
of seconds has elapsed.
<p>
The above portion of the protocol should be considered immutable.
This will allow any version of the core client to talk to
any version of the scheduling server,
and for the server, if needed,
to tell the core client that it's hopelessly out of date.
The remaining protocol may evolve over time.
<p>
Request elements include
<pre>
&lt;prefs_mod_time>0&lt;/prefs_mod_time>
&lt;authenticator>3f7b90793a0175ad0bda68684e8bd136&lt;/authenticator>
&lt;hostid>1&lt;/hostid>
&lt;work_req_seconds>1000&lt;/work_req_seconds>
&lt;host_info>
&lt;timezone>28800&lt;/timezone>
&lt;domain_name>localhost.localdomain&lt;/domain_name>
&lt;ip_addr>127.0.0.1&lt;/ip_addr>
&lt;conn_frac>0.000000&lt;/conn_frac>
&lt;on_frac>0.000000&lt;/on_frac>
&lt;p_ncpus>1&lt;/p_ncpus>
&lt;p_vendor>GenuineIntel&lt;/p_vendor>
&lt;p_model>Pentium&lt;/p_model>
&lt;p_fpops>0.000000&lt;/p_fpops>
&lt;p_iops>0.000000&lt;/p_iops>
&lt;p_membw>0.000000&lt;/p_membw>
&lt;os_name>Linux&lt;/os_name>
&lt;os_version>2.2.14-5.0&lt;/os_version>
&lt;m_nbytes>197427200.000000&lt;/m_nbytes>
&lt;m_cache>131072.000000&lt;/m_cache>
&lt;m_swap>178012160.000000&lt;/m_swap>
&lt;d_total>22108344320.000000&lt;/d_total>
&lt;d_free>18332545024.000000&lt;/d_free>
&lt;n_bwup>0.000000&lt;/n_bwup>
&lt;n_bwdown>0.000000&lt;/n_bwdown>
&lt;/host_info>
&lt;result>
&lt;name>uc_wu_0&lt;/name>
&lt;exit_status>0&lt;/exit_status>
&lt;cpu_time>0.020000&lt;/cpu_time>
&lt;output_file>
&lt;md5_cksum>3f7b90793a0175ad0bda68684e8bd136&lt;/md5_cksum>
&lt;file_name>uc_wu_0_0&lt;/file_name>
&lt;/output_file>
&lt;/result>
</pre>
<p>
Reply elements include
<pre>
</pre>