Mercurial > hg > piper-cpp

diff vamp-client/CapnpRRClient.h @ 100:bbb99f94e225

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Serialisation, comments
author Chris Cannam <c.cannam@qmul.ac.uk>
date Fri, 14 Oct 2016 12:46:38 +0100
parents 427c4c725085
children 8c449824e08d
line wrap: on
line diff
--- a/vamp-client/CapnpRRClient.h	Fri Oct 14 12:46:16 2016 +0100
+++ b/vamp-client/CapnpRRClient.h	Fri Oct 14 12:46:38 2016 +0100
@@ -15,6 +15,14 @@
 namespace piper_vamp {
 namespace client {
 
+/**
+ * Client for a request-response Piper server, i.e. using the
+ * RpcRequest/RpcResponse structures with a single process call rather
+ * than having individual RPC methods, with a synchronous transport
+ * 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.
+ */
 class CapnpRRClient : public PluginClient,
 		      public Loader
 {