Changes between Version 44 and Version 45 of BasicApi

Timestamp:

May 28, 2014, 10:44:00 AM (10 years ago)

Author:

davea

Comment:

--

BasicApi

@@ -264 +264 @@
 == Temporary exit ==
 
-If a GPU application fails to allocate GPU RAM, it may be a temporary problem
-(non-BOINC programs have GPU RAM allocated).
-In this case they should call
-
-{{{
-#!c++
-int boinc_temporary_exit(int delay, const char* reason=NULL);
-}}}
-
-This will exit the application, and will tell the BOINC client to restart it
+If an application is unable to run because of a transient condition,
+it should call
+
+{{{
+#!c++
+int boinc_temporary_exit(int delay, const char* reason=NULL, bool is_notice=false);
+}}}
+
+This will exit the application and tell the BOINC client to restart it
 again in at least '''delay''' seconds.
 (This works with 6.10.25+ client;
 on other clients, it will potentially restart immediately).
 '''Reason''', if supplied, is shown to the user as the explanation for the deferral.
+If '''is_notice''' is true, it's shown as a notice
+(this should be used only for conditions that the user can fix).
+
+Examples:
+ * A GPU application fails to allocate GPU RAM because non-BOINC programs have GPU RAM allocated.
+ * The Vboxwrapper sees that an incompatible version of VirtualBox is installed.
+   In this case "is_notice" would be true,
+   because the user can update VirtualBox.