From: Daniel P. Berrange <berrange@redhat.com>
Date: Fri, 19 Jan 2018 17:24:03 +0000 (+0000)
Subject: rpc: clarify "void *" values passed to client callbacks
X-Git-Tag: v4.1.0-rc1~254
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2c76fa91d31edb7e9ee7f5478dca557e6717784b;p=thirdparty%2Flibvirt.git

rpc: clarify "void *" values passed to client callbacks

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
---

diff --git a/src/rpc/virnetserverclient.h b/src/rpc/virnetserverclient.h
index 0fa8745191..14ace9e522 100644
--- a/src/rpc/virnetserverclient.h
+++ b/src/rpc/virnetserverclient.h
@@ -41,11 +41,20 @@ typedef int (*virNetServerClientFilterFunc)(virNetServerClientPtr client,
                                             virNetMessagePtr msg,
                                             void *opaque);
 
+/*
+ * @data: value allocated by virNetServerClintPrivNew(PostExecRestart) callback
+ */
 typedef virJSONValuePtr (*virNetServerClientPrivPreExecRestart)(virNetServerClientPtr client,
                                                                 void *data);
+/*
+ * @opaque: value of @privOpaque from virNetServerClientNewPostExecRestart
+ */
 typedef void *(*virNetServerClientPrivNewPostExecRestart)(virNetServerClientPtr client,
                                                           virJSONValuePtr object,
                                                           void *opaque);
+/*
+ * @opaque: value of @privOpaque from virNetServerClientNew
+ */
 typedef void *(*virNetServerClientPrivNew)(virNetServerClientPtr client,
                                            void *opaque);