• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>test::stream::stream (3 of 5 overloads)</title>
5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.Beast">
8<link rel="up" href="../stream.html" title="test::stream::stream">
9<link rel="prev" href="overload2.html" title="test::stream::stream (2 of 5 overloads)">
10<link rel="next" href="overload4.html" title="test::stream::stream (4 of 5 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="overload2.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stream.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload4.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h6 class="title">
27<a name="beast.ref.boost__beast__test__stream.stream.overload3"></a><a class="link" href="overload3.html" title="test::stream::stream (3 of 5 overloads)">test::stream::stream
28          (3 of 5 overloads)</a>
29</h6></div></div></div>
30<p>
31            Construct a stream.
32          </p>
33<h7><a name="beast.ref.boost__beast__test__stream.stream.overload3.h0"></a>
34            <span class="phrase"><a name="beast.ref.boost__beast__test__stream.stream.overload3.synopsis"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__test__stream.stream.overload3.synopsis">Synopsis</a>
35          </h7><pre class="programlisting"><span class="identifier">stream</span><span class="special">(</span>
36    <span class="identifier">net</span><span class="special">::</span><span class="identifier">io_context</span><span class="special">&amp;</span> <span class="identifier">ioc</span><span class="special">,</span>
37    <span class="identifier">fail_count</span><span class="special">&amp;</span> <span class="identifier">fc</span><span class="special">);</span>
38</pre>
39<h7><a name="beast.ref.boost__beast__test__stream.stream.overload3.h1"></a>
40            <span class="phrase"><a name="beast.ref.boost__beast__test__stream.stream.overload3.description"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__test__stream.stream.overload3.description">Description</a>
41          </h7><p>
42            The stream will be created in a disconnected state.
43          </p>
44<h7><a name="beast.ref.boost__beast__test__stream.stream.overload3.h2"></a>
45            <span class="phrase"><a name="beast.ref.boost__beast__test__stream.stream.overload3.parameters"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__test__stream.stream.overload3.parameters">Parameters</a>
46          </h7><div class="informaltable"><table class="table">
47<colgroup>
48<col>
49<col>
50</colgroup>
51<thead><tr>
52<th>
53                    <p>
54                      Name
55                    </p>
56                  </th>
57<th>
58                    <p>
59                      Description
60                    </p>
61                  </th>
62</tr></thead>
63<tbody>
64<tr>
65<td>
66                    <p>
67                      <code class="computeroutput"><span class="identifier">ioc</span></code>
68                    </p>
69                  </td>
70<td>
71                    <p>
72                      The <code class="computeroutput"><span class="identifier">io_context</span></code>
73                      object that the stream will use to dispatch handlers for any
74                      asynchronous operations.
75                    </p>
76                  </td>
77</tr>
78<tr>
79<td>
80                    <p>
81                      <code class="computeroutput"><span class="identifier">fc</span></code>
82                    </p>
83                  </td>
84<td>
85                    <p>
86                      The <a class="link" href="../../boost__beast__test__fail_count.html" title="test::fail_count"><code class="computeroutput"><span class="identifier">fail_count</span></code></a> to associate
87                      with the stream. Each I/O operation performed on the stream
88                      will increment the fail count. When the fail count reaches
89                      its internal limit, a simulated failure error will be raised.
90                    </p>
91                  </td>
92</tr>
93</tbody>
94</table></div>
95</div>
96<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
97<td align="left"></td>
98<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
99      Falco<p>
100        Distributed under the Boost Software License, Version 1.0. (See accompanying
101        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>)
102      </p>
103</div></td>
104</tr></table>
105<hr>
106<div class="spirit-nav">
107<a accesskey="p" href="overload2.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stream.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload4.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
108</div>
109</body>
110</html>
111