Changes between Version 37 and Version 38 of GuiRpc

Timestamp:

Aug 16, 2013, 1:04:23 PM (11 years ago)

Author:

davea

Comment:

--

GuiRpc

@@ -3 +3 @@
 = Controlling the BOINC client via RPC =
 
-The BOINC core client provides a set of RPCs (remote procedure calls)
+The BOINC client provides a set of RPCs (remote procedure calls)
 for control and state interrogation.
 This enables the development of GUI (graphical user interface) programs.
@@ -18 +18 @@
  * BOINC has a Java binding in [source:boinc-v2/android/BOINC/src/edu/berkeley/boinc/rpc/].
  * A .Net binding is available at https://boincguirpc.codeplex.com/
+ * A Python binding is available at https://github.com/MestreLion/boinc-indicator
 
 It should be easy to generate bindings in other languages.
-GUI programs connect to the core client by opening a TCP socket at port 31416.
+GUI programs connect to the client by opening a TCP socket at port 31416.
 They can then do repeated RPCs over this connection.
 Each reply message ends with the character \003.
@@ -64 +65 @@
 == RPC list ==
 The following functions require authorization for remote clients, but not for local clients.
-Note: for core client versions 5.5.12 and earlier,
+Note: for client versions 5.5.12 and earlier,
 all functions except `get_state()`,
 `get_results()`, `get_screensaver_mode()`,
@@ -76 +77 @@
 
  `exchange_versions(VERSION_INFO&)`::
- Exchange version info with the core client.
- The core client's version info is returned.
+ Exchange version info with the client.
+ The client's version info is returned.
 
  `get_activity_state(ACTIVITY_STATE&)`::
@@ -136 +137 @@
 
  `get_newer_versions(string&)`::
- Get a string describing newer versions of the core client, if any.
+ Get a string describing newer versions of the client, if any.
 
  `get_notices(int seqno, NOTICES& notices)`::
@@ -169 +170 @@
 
  `get_state(CC_STATE&)`::
-  Get the core client's 'static' state, i.e. its projects, apps, app_versions, workunits and results.
+  Get the client's 'static' state, i.e. its projects, apps, app_versions, workunits and results.
   This call is relatively slow and should only be done initially, and when needed later (see below).
 
@@ -176 +177 @@
 
  `network_status(int&)`::
- Find whether the core client has, needs, or is done with a physical network connection.
+ Find whether the client has, needs, or is done with a physical network connection.
  Deprecated - for 5.5.13 and later, use [#function-cc_status cc_status()] instead.
 
  `set_screensaver_mode``(bool enabled, ``double blank_time, ``DISPLAY_INFO&)`::
- If `enabled` is `true`, the core client should try to get an application to provide screensaver graphics.
+ If `enabled` is `true`, the client should try to get an application to provide screensaver graphics.
  Blank screen after `blank_time` seconds.
 
@@ -193 +194 @@
  Do an Account Manager RPC to the given URL, passing the given name/password.
  If `use_config_file` is true, then the existing URL, username, and password are used
- and the core client updates the project information from the account manager.
+ and the client updates the project information from the account manager.
  If the RPC is successful,
  save the account info on disk (it can be retrieved later using [#function-acct_mgr_info acct_mgr_info()]).
@@ -211 +212 @@
 
  `network_available()`::
- Tells the core client that a network connection is available,
+ Tells the client that a network connection is available,
  and that it should do as much network activity as it can.
 
@@ -223 +224 @@
 
  `quit()`::
- Tell the core client to exit.
+ Tell the client to exit.
 
  `read_global_prefs_override()`::
- Tells the core client to reread the [PrefsOverride global_prefs_override.xml] file,
+ Tells the client to reread the [PrefsOverride global_prefs_override.xml] file,
  modifying the global preferences according to its contents.