/boost_1_57_0/doc/html/boost_asio/reference/basic_stream_socket/async_write_some.html

http://github.com/MisterTea/HyperNEAT · HTML · 116 lines · 116 code · 0 blank · 0 comment · 0 complexity · 717918736439d4e3a2fb691886892e5c MD5 · raw file 

    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>basic_stream_socket::async_write_some</title>
    5. 

  5. <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
    7. 

  7. <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
    8. 

  8. <link rel="up" href="../basic_stream_socket.html" title="basic_stream_socket">
    9. 

  9. <link rel="prev" href="async_send/overload2.html" title="basic_stream_socket::async_send (2 of 2 overloads)">
    10. 

  10. <link rel="next" href="at_mark.html" title="basic_stream_socket::at_mark">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="async_send/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_socket.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="at_mark.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="section">
    26. 

  26. <div class="titlepage"><div><div><h4 class="title">
    27. 

  27. <a name="boost_asio.reference.basic_stream_socket.async_write_some"></a><a class="link" href="async_write_some.html" title="basic_stream_socket::async_write_some">basic_stream_socket::async_write_some</a>
    28. 

  28. </h4></div></div></div>
    29. 

  29. <p>
    30. 

  30.           <a class="indexterm" name="idp152042480"></a> 
    31. 

  31. Start an asynchronous write.
    32. 

  32.         </p>
    33. 

  33. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    34. 

  34.     <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">,</span>
    35. 

  35.     <span class="keyword">typename</span> <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a><span class="special">&gt;</span>
    36. 

  36. <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">async_write_some</span><span class="special">(</span>
    37. 

  37.     <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
    38. 

  38.     <span class="identifier">WriteHandler</span> <span class="identifier">handler</span><span class="special">);</span>
    39. 

  39. </pre>
    40. 

  40. <p>
    41. 

  41.           This function is used to asynchronously write data to the stream socket.
    42. 

  42.           The function call always returns immediately.
    43. 

  43.         </p>
    44. 

  44. <h6>
    45. 

  45. <a name="boost_asio.reference.basic_stream_socket.async_write_some.h0"></a>
    46. 

  46.           <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.basic_stream_socket.async_write_some.parameters">Parameters</a>
    47. 

  47.         </h6>
    48. 

  48. <div class="variablelist">
    49. 

  49. <p class="title"><b></b></p>
    50. 

  50. <dl class="variablelist">
    51. 

  51. <dt><span class="term">buffers</span></dt>
    52. 

  52. <dd><p>
    53. 

  53.                 One or more data buffers to be written to the socket. Although the
    54. 

  54.                 buffers object may be copied as necessary, ownership of the underlying
    55. 

  55.                 memory blocks is retained by the caller, which must guarantee that
    56. 

  56.                 they remain valid until the handler is called.
    57. 

  57.               </p></dd>
    58. 

  58. <dt><span class="term">handler</span></dt>
    59. 

  59. <dd>
    60. 

  60. <p>
    61. 

  61.                 The handler to be called when the write operation completes. Copies
    62. 

  62.                 will be made of the handler as required. The function signature of
    63. 

  63.                 the handler must be:
    64. 

  64. </p>
    65. 

  65. <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
    66. 

  66.   <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">error</span><span class="special">,</span> <span class="comment">// Result of operation.</span>
    67. 

  67.   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span>           <span class="comment">// Number of bytes written.</span>
    68. 

  68. <span class="special">);</span>
    69. 

  69. </pre>
    70. 

  70. <p>
    71. 

  71.                 Regardless of whether the asynchronous operation completes immediately
    72. 

  72.                 or not, the handler will not be invoked from within this function.
    73. 

  73.                 Invocation of the handler will be performed in a manner equivalent
    74. 

  74.                 to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>.
    75. 

  75.               </p>
    76. 

  76. </dd>
    77. 

  77. </dl>
    78. 

  78. </div>
    79. 

  79. <h6>
    80. 

  80. <a name="boost_asio.reference.basic_stream_socket.async_write_some.h1"></a>
    81. 

  81.           <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.basic_stream_socket.async_write_some.remarks">Remarks</a>
    82. 

  82.         </h6>
    83. 

  83. <p>
    84. 

  84.           The write operation may not transmit all of the data to the peer. Consider
    85. 

  85.           using the <a class="link" href="../async_write.html" title="async_write"><code class="computeroutput"><span class="identifier">async_write</span></code></a> function if you need
    86. 

  86.           to ensure that all data is written before the asynchronous operation completes.
    87. 

  87.         </p>
    88. 

  88. <h6>
    89. 

  89. <a name="boost_asio.reference.basic_stream_socket.async_write_some.h2"></a>
    90. 

  90.           <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_write_some.example"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.basic_stream_socket.async_write_some.example">Example</a>
    91. 

  91.         </h6>
    92. 

  92. <p>
    93. 

  93.           To write a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows:
    94. 

  94.         </p>
    95. 

  95. <pre class="programlisting"><span class="identifier">socket</span><span class="special">.</span><span class="identifier">async_write_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">),</span> <span class="identifier">handler</span><span class="special">);</span>
    96. 

  96. </pre>
    97. 

  97. <p>
    98. 

  98.           See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
    99. 

  99.           documentation for information on writing multiple buffers in one go, and
    100. 

  100.           how to use it with arrays, boost::array or std::vector.
    101. 

  101.         </p>
    102. 

  102. </div>
    103. 

  103. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    104. 

  104. <td align="left"></td>
    105. 

  105. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
    106. 

  106.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    107. 

  107.         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
    108. 

  108.       </p>
    109. 

  109. </div></td>
    110. 

  110. </tr></table>
    111. 

  111. <hr>
    112. 

  112. <div class="spirit-nav">
    113. 

  113. <a accesskey="p" href="async_send/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_socket.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="at_mark.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
    114. 

  114. </div>
    115. 

  115. </body>
    116. 

  116. </html>
    117.