Changes between Version 10 and Version 11 of OptionsApi

Timestamp:

Jan 26, 2015, 1:22:21 PM (10 years ago)

Author:

davea

Comment:

--

OptionsApi

@@ -1 @@
-= Runtime system options =
+= APIs for wrappers =
 
-You can customize the behavior of the BOINC runtime system
-by using '''boinc_init_options()''' instead of '''boinc_init()'''.
-For example:
+Wrappers (wrapper, vboxwrapper, wrappture) use the following
+API to control the behavior of the BOINC runtime system.
 
 {{{
@@ -9 +8 @@
 
 boinc_options_defaults(options);
-options.multi_thread = true;    // include this if your app's main process uses multiple threads
-options.multi_process = true;   // include this if your app uses multiple processes
-
+options.main_program = true;
+... set options
 boinc_init_options(&options);
 }}}
-
-Do not create any threads or store the current PID
-before calling '''boinc_init_options()'''.
-The following options are available:
 
 {{{
 struct BOINC_OPTIONS {
     int normal_thread_priority;
+    int multi_thread;
+    int multi_process;
     int main_program;
     int check_heartbeat;
@@ -27 +23 @@
     int handle send_status_msgs;
     int direct_process_action;
-    int multi_thread;
-    int multi_process;
 };
 }}}
 
-The options are:
- '''normal_thread_priority'''::
-       If set, the application will run at normal thread priority (Windows).
-       This is recommended for CUDA applications, so that the GPU will run at full speed even if the CPUs are loaded.
-       Default is false.
- '''multi_thread''':: Set this if your application uses multiple threads (e.g., OpenMP or pthreads).
- '''multi_process''':: Set this if your application creates sub-processes (e.g., MPI).
+The first three options are described [BasicApi#init here].
 
 The remaining options determine what runtime system functions will be performed by this program.
-This is primarily for the use of [CompoundApps compound applications].
-In developing a compound application you must decide whether these functions
+In developing a wrapper application you must decide whether these functions
 are to be performed by the main or worker program.
 Each flag must be set in either the main or worker programs, but not both.
@@ -49 +36 @@
       Set this in the main program.
  '''check_heartbeat'''::
-    If set, the program monitors 'heartbeat' messages from the core client.
+    If set, the program monitors 'heartbeat' messages from the client.
     If the heartbeat stops, the result depends on the direct_process_action flag (see below).
  '''handle_process_control'''::