diff vamp-client/CapnpRRClient.h @ 187:ad6025dc0b04

Documentation

--- a/vamp-client/CapnpRRClient.h	Mon Feb 06 16:44:33 2017 +0000
+++ b/vamp-client/CapnpRRClient.h	Wed Feb 08 10:09:51 2017 +0000
@@ -66,6 +66,16 @@
  * such as a subprocess pipe arrangement. Only one request can be
  * handled at a time. This class is thread-safe if and only if it is
  * constructed with a thread-safe SynchronousTransport implementation.
+ *
+ * This class takes Vamp-like structures (Plugin and the classes in
+ * vamp-support) and uses them to communicate with a Piper server
+ * using the Cap'n Proto serialisation of the Piper API. The transport
+ * layer (and thus the nature of the server) is defined by the
+ * SynchronousTransport passed to the constructor.
+ *
+ * This class implements both the Loader interface (which constructs
+ * PluginStub objects) and the PluginClient (which accepts PluginStubs
+ * and maps them into Piper handles).
  */
 class CapnpRRClient : public PluginClient,
                       public Loader