Changes between Version 2 and Version 3 of Prefs2

Timestamp:

Sep 8, 2019, 5:50:38 PM (5 years ago)

Author:

davea

Comment:

--

Prefs2

@@ -4 +4 @@
 
 "Dynamic" parameters limit BOINC activity
-and change in response to various factors.
+and change in response to various factors external to BOINC.
 Examples include limits on #CPUs, RAM usage, network usage, etc.
 
@@ -10 +10 @@
 
 The "prefs dictionary" is a name -> value map,
-containing values that can affect dynamic prefs.
+containing values that can affect dynamic params.
 Examples:
 
@@ -20 +20 @@
 
 These values are updated by the client.
-
-External programs can add items to the dictionary,
+In addition, external programs can add items to the dictionary,
 and update their values, via GUI RPCs.
 Hence the prefs system is extensible without modifying the client.
@@ -37 +36 @@
  * "greater than": the value of the item is greater than a number X.
  * "nonzero": the value of the item is nonzero (i.e. Boolean true)
- * "time range": the value of the item (a time value) lies in a set of day/week intervals.
+ * "time range": the value of the item (usually "time") lies in a set of day/week intervals.
 
 A term can also have a "negate" flag, which if set reverses its sense.
@@ -45 +44 @@
 <term>
    <item>item-name</item>
-   <type>x</type>     // 0 = greater than, 1 = nonzero, 2 = time range
+   <type>x</type>                  // 0 = greater than, 1 = nonzero, 2 = time range
    [<negate/>]
-   [<thresh>x</thresh>]         // if greater than
-   [time range]                 // if time range
+   [<thresh>x</thresh>]            // if greater than
+   [<time_range>...</time_range>]  // if time range
 </term>
 }}}
@@ -58 +57 @@
    [
    <day>
-      <day_of_week>x</day_of_week>
+      <day_of_week>x</day_of_week>    // 0 .. 6
       <start_hour>x</start_hour>
       <end_hour>y</end_hour>
@@ -76 +75 @@
 </condition>
 }}}
+
+If the set if empty, the condition is always true.
 
 == Clauses ==
@@ -105 +106 @@
 If the condition is true, we overwrite X with C's dynamic parameters.
 At the conclusion, X is the dynamic parameters to be enforced by the client.
+
+== Example ==
+
+The following says to use all the CPUs and 90% of the RAM if
+there has been no user input in 3 minutes,
+and to use 50% of the CPUs and 50% of the RAM otherwise:
+{{{
+<computing_prefs>
+   <clause>
+      <condition></condition>
+      <dynamic_params>
+         <max_ncpus_pct>50</max_ncpus_pct>
+         <ram_max_used_frac>.5</ram_max_used_frac>
+      </dynamic_params>
+   </clause>
+   <clause>
+      <condition>
+         <term>
+            <type>gt</type>
+            <item>idle_time</time>
+            <value>180</value>
+         </term>
+      </condition>
+      <dynamic_params>
+         <max_ncpus_pct>100</max_ncpus_pct>
+         <ram_max_used_frac>.9</ram_max_used_frac>
+      </dynamic_params>
+   </clause>
+</computing_prefs>
+}}}