libs/beast/doc/html/beast/ref/boost__beast__ssl_stream/ssl_stream.html

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