• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>ssl_stream::ssl_stream</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="../boost__beast__ssl_stream.html" title="ssl_stream">
9<link rel="prev" href="executor_type.html" title="ssl_stream::executor_type">
10<link rel="next" href="get_executor.html" title="ssl_stream::get_executor">
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="executor_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__ssl_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="get_executor.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="beast.ref.boost__beast__ssl_stream.ssl_stream"></a><a class="link" href="ssl_stream.html" title="ssl_stream::ssl_stream">ssl_stream::ssl_stream</a>
28</h5></div></div></div>
29<p>
30          <a class="indexterm" name="idm46057527653904"></a>
31        </p>
32<p>
33          Construct a stream.
34        </p>
35<h6>
36<a name="beast.ref.boost__beast__ssl_stream.ssl_stream.h0"></a>
37          <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.ssl_stream.synopsis"></a></span><a class="link" href="ssl_stream.html#beast.ref.boost__beast__ssl_stream.ssl_stream.synopsis">Synopsis</a>
38        </h6>
39<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
40    <span class="keyword">class</span> <span class="identifier">Arg</span><span class="special">&gt;</span>
41<span class="identifier">ssl_stream</span><span class="special">(</span>
42    <span class="identifier">Arg</span><span class="special">&amp;&amp;</span> <span class="identifier">arg</span><span class="special">,</span>
43    <span class="identifier">net</span><span class="special">::</span><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">context</span><span class="special">&amp;</span> <span class="identifier">ctx</span><span class="special">);</span>
44</pre>
45<h6>
46<a name="beast.ref.boost__beast__ssl_stream.ssl_stream.h1"></a>
47          <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.ssl_stream.description"></a></span><a class="link" href="ssl_stream.html#beast.ref.boost__beast__ssl_stream.ssl_stream.description">Description</a>
48        </h6>
49<p>
50          This constructor creates a stream and initialises the underlying stream
51          object.
52        </p>
53<h6>
54<a name="beast.ref.boost__beast__ssl_stream.ssl_stream.h2"></a>
55          <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.ssl_stream.parameters"></a></span><a class="link" href="ssl_stream.html#beast.ref.boost__beast__ssl_stream.ssl_stream.parameters">Parameters</a>
56        </h6>
57<div class="informaltable"><table class="table">
58<colgroup>
59<col>
60<col>
61</colgroup>
62<thead><tr>
63<th>
64                  <p>
65                    Name
66                  </p>
67                </th>
68<th>
69                  <p>
70                    Description
71                  </p>
72                </th>
73</tr></thead>
74<tbody>
75<tr>
76<td>
77                  <p>
78                    <code class="computeroutput"><span class="identifier">arg</span></code>
79                  </p>
80                </td>
81<td>
82                  <p>
83                    The argument to be passed to initialise the underlying stream.
84                  </p>
85                </td>
86</tr>
87<tr>
88<td>
89                  <p>
90                    <code class="computeroutput"><span class="identifier">ctx</span></code>
91                  </p>
92                </td>
93<td>
94                  <p>
95                    The SSL context to be used for the stream.
96                  </p>
97                </td>
98</tr>
99</tbody>
100</table></div>
101</div>
102<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
103<td align="left"></td>
104<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
105      Falco<p>
106        Distributed under the Boost Software License, Version 1.0. (See accompanying
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      </p>
109</div></td>
110</tr></table>
111<hr>
112<div class="spirit-nav">
113<a accesskey="p" href="executor_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__ssl_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="get_executor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
114</div>
115</body>
116</html>
117