From: Cole Robinson <crobinso@redhat.com>
Date: Sun, 24 Apr 2016 20:27:19 +0000 (-0400)
Subject: rpc: protocol: Clarify VIR_NET_ERROR usage with streams
X-Git-Tag: v1.3.5-rc1~448
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8958dde506bab3c854acd8b66d422406191bd3c9;p=thirdparty%2Flibvirt.git

rpc: protocol: Clarify VIR_NET_ERROR usage with streams

The described protocol semantics really only apply to server initiated
stream messages. Document the semantics for client messages.
---

diff --git a/src/rpc/virnetprotocol.x b/src/rpc/virnetprotocol.x
index 327a33475b..9ce33b0735 100644
--- a/src/rpc/virnetprotocol.x
+++ b/src/rpc/virnetprotocol.x
@@ -104,7 +104,9 @@ const VIR_NET_MESSAGE_NUM_FDS_MAX = 32;
  *  - type == VIR_NET_STREAM
  *     * VIR_NET_CONTINUE if more data is following
  *     * VIR_NET_OK if stream is complete
- *     * VIR_NET_ERROR if stream had an error
+ *     * VIR_NET_ERROR
+ *         server message: stream had an error
+ *         client message: client aborted the stream
  *
  * Payload varies according to type and status:
  *
@@ -125,7 +127,8 @@ const VIR_NET_MESSAGE_NUM_FDS_MAX = 32;
  *     * status == VIR_NET_CONTINUE
  *          byte[]       raw stream data
  *     * status == VIR_NET_ERROR
- *          remote_error error information
+ *          server message: remote_error error information
+ *          client message: <empty>
  *     * status == VIR_NET_OK
  *          <empty>
  *