Changes between Version 54 and Version 55 of BasicApi

Timestamp:

Jan 26, 2015, 1:15:19 PM (10 years ago)

Author:

davea

Comment:

--

BasicApi

@@ -7 +7 @@
 Unless otherwise specified, the functions return an integer error code;
 zero indicates success.
-To use the API include there header.
+To use the API include the header file:
 {{{
 #include "boinc_api.h"
-#include "filesys.h"
 }}}
 
 BOINC applications may have an associate graphics program,
 which can act as a screensaver.
-The API for these graphics apps is [GraphicsApi here].
-
-== Initialization and termination == #init
+The API for these graphics apps is [GraphicsApps here].
+
+== Initialization == #init
 
 Initialization must be done before calling other BOINC functions.
-
+For sequential (single-threaded) apps, call
 {{{
 boinc_init();
 }}}
 
-Multi-thread apps: do not create any threads or store the current PID
-before calling '''boinc_init()'''.
-
+=== Parallel apps ===
+
+If your uses multiple threads or processes for parallelism, initialize using
+{{{
+BOINC_OPTIONS options;
+
+boinc_options_defaults(options);
+options.multi_thread = true;    // if your app's main process uses multiple threads
+options.multi_process = true;   // if your app uses multiple processes
+
+boinc_init_options(&options);
+}}}
+Do this before creating any threads or processes, or storing the PID.
+
+=== GPU and coprocessor apps ===
+
+If your app uses GPUs or coprocessors, initialize using
+{{{
+BOINC_OPTIONS options;
+
+boinc_options_defaults(options);
+options.normal_thread_priority = true; 
+boinc_init_options(&options);
+}}}
+On Windows, this causes the application to run at normal thread priority,
+so that the GPU will run at full speed even if the CPUs are loaded.
+== Termination ==
 When the application has completed it must call