sstuff: Document that Socket::readWithTimeout() does not handle partial reads

diff --git a/pdns/sstuff.hh b/pdns/sstuff.hh
index adecbe5ec917c252e69608744cca3407baba7817..208697cc2bb8e6dd501fba855082cec2414598ab 100644 (file)
--- a/pdns/sstuff.hh
+++ b/pdns/sstuff.hh
@@ -351,6 +351,11 @@ public:
     return static_cast<size_t>(res);
   }
 
+  /** Read a bock of data from the socket to a block of memory,
+  *   waiting at most 'timeout' seconds for the data to become
+  *   available. Be aware that this does _NOT_ handle partial reads
+  *   for you.
+  */
   ssize_t readWithTimeout(char* buffer, size_t n, int timeout)
   {
     int err = waitForRWData(d_socket, true, timeout, 0);