PageRenderTime 40ms CodeModel.GetById 17ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/html/boost_asio/reference/basic_socket_streambuf/shutdown/overload1.html

https://bitbucket.org/vaporoid/boost
HTML | 94 lines | 94 code | 0 blank | 0 comment | 0 complexity | 73837bb99dbc27b2c1144c3c192772d7 MD5 | raw file
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>basic_socket_streambuf::shutdown (1 of 2 overloads)</title>
  5. <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
  7. <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
  8. <link rel="up" href="../shutdown.html" title="basic_socket_streambuf::shutdown">
  9. <link rel="prev" href="../shutdown.html" title="basic_socket_streambuf::shutdown">
  10. <link rel="next" href="overload2.html" title="basic_socket_streambuf::shutdown (2 of 2 overloads)">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="../shutdown.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h5 class="title">
  27. <a name="boost_asio.reference.basic_socket_streambuf.shutdown.overload1"></a><a class="link" href="overload1.html" title="basic_socket_streambuf::shutdown (1 of 2 overloads)">basic_socket_streambuf::shutdown
  28. (1 of 2 overloads)</a>
  29. </h5></div></div></div>
  30. <p>
  31. <span class="emphasis"><em>Inherited from basic_socket.</em></span>
  32. </p>
  33. <p>
  34. Disable sends or receives on the socket.
  35. </p>
  36. <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">shutdown</span><span class="special">(</span>
  37. <span class="identifier">shutdown_type</span> <span class="identifier">what</span><span class="special">);</span>
  38. </pre>
  39. <p>
  40. This function is used to disable send operations, receive operations,
  41. or both.
  42. </p>
  43. <h6>
  44. <a name="boost_asio.reference.basic_socket_streambuf.shutdown.overload1.h0"></a>
  45. <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.shutdown.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket_streambuf.shutdown.overload1.parameters">Parameters</a>
  46. </h6>
  47. <div class="variablelist">
  48. <p class="title"><b></b></p>
  49. <dl class="variablelist">
  50. <dt><span class="term">what</span></dt>
  51. <dd><p>
  52. Determines what types of operation will no longer be allowed.
  53. </p></dd>
  54. </dl>
  55. </div>
  56. <h6>
  57. <a name="boost_asio.reference.basic_socket_streambuf.shutdown.overload1.h1"></a>
  58. <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.shutdown.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket_streambuf.shutdown.overload1.exceptions">Exceptions</a>
  59. </h6>
  60. <div class="variablelist">
  61. <p class="title"><b></b></p>
  62. <dl class="variablelist">
  63. <dt><span class="term">boost::system::system_error</span></dt>
  64. <dd><p>
  65. Thrown on failure.
  66. </p></dd>
  67. </dl>
  68. </div>
  69. <h6>
  70. <a name="boost_asio.reference.basic_socket_streambuf.shutdown.overload1.h2"></a>
  71. <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.shutdown.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket_streambuf.shutdown.overload1.example">Example</a>
  72. </h6>
  73. <p>
  74. Shutting down the send side of the socket:
  75. </p>
  76. <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
  77. <span class="special">...</span>
  78. <span class="identifier">socket</span><span class="special">.</span><span class="identifier">shutdown</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">::</span><span class="identifier">shutdown_send</span><span class="special">);</span>
  79. </pre>
  80. </div>
  81. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  82. <td align="left"></td>
  83. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2013 Christopher M. Kohlhoff<p>
  84. Distributed under the Boost Software License, Version 1.0. (See accompanying
  85. 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>)
  86. </p>
  87. </div></td>
  88. </tr></table>
  89. <hr>
  90. <div class="spirit-nav">
  91. <a accesskey="p" href="../shutdown.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  92. </div>
  93. </body>
  94. </html>