client: Let client_recv() not pass unparsed status,len to the caller.

[sysdb.git] / src / include / client / sock.h

diff --git a/src/include/client/sock.h b/src/include/client/sock.h
index 5980d085ab4546c7dffd5e76c988c836aa301d00..e33f4d769b01d2451ba6c019a7b0a885f4bfb3b5 100644 (file)
--- a/src/include/client/sock.h
+++ b/src/include/client/sock.h
@@ -99,10 +99,13 @@ sdb_client_send(sdb_client_t *client,
  * Receive data from the connection. All data is written to the specified
  * buffer. If specified, the returned status code is written to the memory
  * location pointed to by 'code'. In case of an error or an incomplete
- * command, the status code is set to UINT32_MAX.
+ * command, the status code is set to UINT32_MAX. The returned data does not
+ * include the status code and message len as received from the remote side
+ * but only the data associated with the message.
  *
  * Returns:
  *  - the number of bytes read
+ *    (may be zero if the message did not include any data)
  *  - a negative value on error
  */
 ssize_t