← Back to branch summary

~ubuntu-branches/ubuntu/lucid/boinc/lucid

« back to all changes in this revision

Viewing changes to doc/assimilate.php

  • Committer: Bazaar Package Importer
  • Author(s): Frank S. Thomas, Frank S. Thomas
  • Date: 2008-05-31 08:02:47 UTC
  • mfrom: (1.1.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20080531080247-4ce890lp2rc768cr
Tags: 6.2.7-1
http://bugs.debian.org/463823
[ Frank S. Thomas ]
* New upstream release.
  - BOINC Manager: Redraw disk usage charts immediately after connecting to
    a (different) client. (closes: 463823)
* debian/copyright:
  - Added the instructions from debian/README.Debian-source about how
    repackaged BOINC tarballs can be reproduced because DevRef now
    recommends to put this here instead of in the afore-mentioned file.
  - Updated for the new release.
* Removed the obsolete debian/README.Debian-source.
* For consistency upstream renamed the core client and the command tool
  ("boinc_client" to "boinc" and "boinc_cmd" to "boinccmd"). Done the same
  in all packages and created symlinks with the old names for the binaries
  and man pages. Also added an entry in debian/boinc-client.NEWS explaining
  this change.
* debian/rules: Do not list Makefile.ins in the clean target individually,
  just remove all that can be found.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/assimilate.php
1
 
<?php
2
 
require_once("docutil.php");
3
 
page_head("Result assimilation");
4
 
echo "
5
 
Projects must create one assimilator program per application.
6
 
This is done by linking the program <b>sched/assimilate.C</b>
7
 
with an application-specific function of the form
8
 
<pre>
9
 
int assimilate_handler(
10
 
    WORKUNIT& wu, vector&lt;RESULT>& results, RESULT& canononical_result
11
 
);
12
 
</pre>
13
 
 
14
 
This is called when either
15
 
<ul>
16
 
<li> The workunit has a nonzero
17
 
<a href=work.php>error mask</a>
18
 
(indicating, for example, too many error results).
19
 
In this case the handler might write a message to a log
20
 
or send an email to the application developer.
21
 
<li> The workunit has a canonical result.
22
 
In this case wu.canonical_resultid will be nonzero,
23
 
canonical_result will contain the canonical result.
24
 
Your handler might, for example, parse the canonical result's
25
 
output file and write its contents to a separate database.
26
 
</ul>
27
 
In both cases the 'results' vector will be populated with
28
 
all the workunit's results (including unsuccessful and unsent ones).
29
 
All files (both input and output) will generally be on disk.
30
 
<p>
31
 
It's possible that both conditions might hold.
32
 
<p>
33
 
If assimilate_handler() returns zero,
34
 
the workunit record will be marked as assimilated.
35
 
If assimilate_handler() returns nonzero,
36
 
the assimilator will log an error message and exit.
37
 
Typically the function should return nonzero for any error condition.
38
 
This way the system administrator can fix the problem before any completed
39
 
or erroneous workunits are mis-handled by BOINC.
40
 
<p>
41
 
You can use BOINC's
42
 
<a href=backend_util.php>back-end utility functions</a>
43
 
to get file pathnames and open files.
44
 
 
45
 
";
46
 
page_tail();
47
 
?>