Changes between Version 35 and Version 36 of GuiRpc

Timestamp:

Aug 15, 2013, 9:37:19 AM (11 years ago)

Author:

davea

Comment:

--

GuiRpc

@@ -1 +1 @@
 [[PageOutline]]
 
-= Controlling the core client via RPC =
-
-The BOINC core client provides a set of RPCs (remote procedure calls) for control and state interrogation.
-This enables the development of GUI (graphical user interface) programs separately from the core client.
+= Controlling the BOINC client via RPC =
+
+The BOINC core client provides a set of RPCs (remote procedure calls)
+for control and state interrogation.
+This enables the development of GUI (graphical user interface) programs.
 These RPCs send XML request and reply messages over a TCP connection.
-The XML formats are not documented, but can be deduced from the source code.
-
-BOINC provides a C++ interface to these RPCs, consisting of the GUI_RPC class.
-The interface is in [source:boinc/lib/gui_rpc_client.h lib/gui_rpc_client.h],
-and the program [source:boinc/client/boinc_cmd.cpp boinc_cmd.cpp] gives a usage example.
-All member functions return an integer error code.
-It should be fairly easy to generate client interfaces in languages other than C++.
+The XML formats are not documented, but can be inferred from the source code.
+
+The following bindings are available:
+
+ * BOINC has a C++ binding, consisting of the GUI_RPC class.
+  The interface is in [source:boinc/lib/gui_rpc_client.h lib/gui_rpc_client.h],
+  and the program [source:boinc/client/boinc_cmd.cpp boinc_cmd.cpp]
+  gives a usage example.
+  All member functions return an integer error code.
+ * BOINC has a Java binding in [source:boinc/android/BOINC/src/edu/berkeley/boinc/rpc/].
+ * A .Net binding is available at https://boincguirpc.codeplex.com/
+
+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.
 They can then do repeated RPCs over this connection.
 Each reply message ends with the character \003.
 
-To create an RPC connection, call
-
- `init(char* host)`::
- Establish RPC connection to the given host.
+The rest of this document describes the C++ interface.
+The functions listed are members of the '''RPC_CLIENT''' class.
+
+== Connecting ==
+
+To establish RPC connection to a host,
+create a `RPC_CLIENT` object and call
+{{{
+`init(char* host)`.
+}}}
 
 == Dealing with versions ==
 
 The GUI RPC protocol changes over time.
-If you're writing a GUI program that needs to communicate with older versions of the BOINC core client,
-here's what to do:
-
- * Create a `GUI_RPC` object and connect.
-  Call `exchange_versions()` to get the client version.
+If you're writing a GUI program that needs to communicate with older
+versions of the BOINC client:
+
+ * Call `exchange_versions()` to get the client version.
  * If `exchange_versions()` fails (it's not supported in pre-5.6 clients)
   do a `get_state()` RPC, and get the client version from `CC_STATE::version_info`.