[Boost-commit] svn:boost r74952 - trunk/boost/asio

Subject: [Boost-commit] svn:boost r74952 - trunk/boost/asio
From: chris_at_[hidden]
Date: 2011-10-15 19:46:50

Author: chris_kohlhoff
Date: 2011-10-15 19:46:49 EDT (Sat, 15 Oct 2011)
New Revision: 74952
URL: http://svn.boost.org/trac/boost/changeset/74952

Log:
Clarify that the read operation ends when the buffer is full. Refs #5999

Text files modified: 
   trunk/boost/asio/read.hpp |    12 ++++++++++++                            
   1 files changed, 12 insertions(+), 0 deletions(-)

Modified: trunk/boost/asio/read.hpp
==============================================================================
--- trunk/boost/asio/read.hpp	(original)
+++ trunk/boost/asio/read.hpp	2011-10-15 19:46:49 EDT (Sat, 15 Oct 2011)
@@ -214,6 +214,8 @@
  * This function is used to read a certain number of bytes of data from a
  * stream. The call will block until one of the following conditions is true:
  *
+ * @li The supplied buffer is full (that is, it has reached maximum size).
+ *
  * @li An error occurred.
  *
  * This operation is implemented in terms of zero or more calls to the stream's
@@ -241,6 +243,8 @@
  * This function is used to read a certain number of bytes of data from a
  * stream. The call will block until one of the following conditions is true:
  *
+ * @li The supplied buffer is full (that is, it has reached maximum size).
+ *
  * @li An error occurred.
  *
  * This operation is implemented in terms of zero or more calls to the stream's
@@ -269,6 +273,8 @@
  * This function is used to read a certain number of bytes of data from a
  * stream. The call will block until one of the following conditions is true:
  *
+ * @li The supplied buffer is full (that is, it has reached maximum size).
+ *
  * @li The completion_condition function object returns 0.
  *
  * This operation is implemented in terms of zero or more calls to the stream's
@@ -307,6 +313,8 @@
  * This function is used to read a certain number of bytes of data from a
  * stream. The call will block until one of the following conditions is true:
  *
+ * @li The supplied buffer is full (that is, it has reached maximum size).
+ *
  * @li The completion_condition function object returns 0.
  *
  * This operation is implemented in terms of zero or more calls to the stream's
@@ -496,6 +504,8 @@
  * asynchronous operation will continue until one of the following conditions is
  * true:
  *
+ * @li The supplied buffer is full (that is, it has reached maximum size).
+ *
  * @li An error occurred.
  *
  * This operation is implemented in terms of zero or more calls to the stream's
@@ -546,6 +556,8 @@
  * asynchronous operation will continue until one of the following conditions is
  * true:
  *
+ * @li The supplied buffer is full (that is, it has reached maximum size).
+ *
  * @li The completion_condition function object returns 0.
  *
  * This operation is implemented in terms of zero or more calls to the stream's