Update of /cvsroot/boost/boost/libs/asio/doc
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv2294/libs/asio/doc
Modified Files:
quickref.xml reference.qbk
Log Message:
Improve documentation for completion condition objects.
Index: quickref.xml
===================================================================
RCS file: /cvsroot/boost/boost/libs/asio/doc/quickref.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- quickref.xml 16 May 2007 14:35:08 -0000 1.4
+++ quickref.xml 31 Jul 2007 11:39:30 -0000 1.5
@@ -95,6 +95,8 @@
<listitem><link
linkend="boost_asio.reference.ip__host_name">ip::host_name</link></listitem>
<listitem><link
linkend="boost_asio.reference.read">read</link></listitem>
<listitem><link
linkend="boost_asio.reference.read_until">read_until</link></listitem>
+ <listitem><link
linkend="boost_asio.reference.transfer_all">transfer_all</link></listitem>
+ <listitem><link
linkend="boost_asio.reference.transfer_at_least">transfer_at_least</link></listitem>
<listitem><link
linkend="boost_asio.reference.use_service">use_service</link></listitem>
<listitem><link
linkend="boost_asio.reference.write">write</link></listitem>
</itemizedlist>
Index: reference.qbk
===================================================================
RCS file: /cvsroot/boost/boost/libs/asio/doc/reference.qbk,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- reference.qbk 20 May 2007 01:04:11 -0000 1.14
+++ reference.qbk 31 Jul 2007 11:39:30 -0000 1.15
@@ -38432,6 +38432,31 @@
unspecified transfer_all();
+This function is used to create an object, of unspecified type, that meets
CompletionCondition requirements.
+
+
+[heading Example]
+
+Reading until a buffer is full:
+
+ boost::array<char, 128> buf;
+ boost::system::error_code ec;
+ std::size_t n = boost::asio::read(
+ sock, boost::asio::buffer(buf),
+ boost::asio::transfer_all(), ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
+ else
+ {
+ // n == 128
+ }
+
+
+
+
+
[endsect]
@@ -38445,6 +38470,31 @@
std::size_t minimum);
+This function is used to create an object, of unspecified type, that meets
CompletionCondition requirements.
+
+
+[heading Example]
+
+Reading until a buffer is full or contains at least 64 bytes:
+
+ boost::array<char, 128> buf;
+ boost::system::error_code ec;
+ std::size_t n = boost::asio::read(
+ sock, boost::asio::buffer(buf),
+ boost::asio::transfer_at_least(64), ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
+ else
+ {
+ // n >= 64 && n <= 128
+ }
+
+
+
+
+
[endsect]
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
