• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>rate_policy_access</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="../ref.html" title="This Page Intentionally Left Blank 2/2">
9<link rel="prev" href="boost__beast__websocket__permessage_deflate/memLevel.html" title="websocket::permessage_deflate::memLevel">
10<link rel="next" href="boost__beast__http__basic_file_body__reader.html" title="http::basic_file_body::reader">
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="boost__beast__websocket__permessage_deflate/memLevel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__http__basic_file_body__reader.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="beast.ref.boost__beast__rate_policy_access"></a><a class="link" href="boost__beast__rate_policy_access.html" title="rate_policy_access">rate_policy_access</a>
28</h4></div></div></div>
29<p>
30        Helper class to assist implementing a <span class="emphasis"><em>RatePolicy</em></span>.
31      </p>
32<h5>
33<a name="beast.ref.boost__beast__rate_policy_access.h0"></a>
34        <span class="phrase"><a name="beast.ref.boost__beast__rate_policy_access.synopsis"></a></span><a class="link" href="boost__beast__rate_policy_access.html#beast.ref.boost__beast__rate_policy_access.synopsis">Synopsis</a>
35      </h5>
36<p>
37        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/rate_policy.hpp" target="_top">boost/beast/core/rate_policy.hpp</a>&gt;</code>
38      </p>
39<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">rate_policy_access</span>
40</pre>
41<h5>
42<a name="beast.ref.boost__beast__rate_policy_access.h1"></a>
43        <span class="phrase"><a name="beast.ref.boost__beast__rate_policy_access.description"></a></span><a class="link" href="boost__beast__rate_policy_access.html#beast.ref.boost__beast__rate_policy_access.description">Description</a>
44      </h5>
45<p>
46        This class is used by the implementation to gain access to the private members
47        of a user-defined object meeting the requirements of <span class="emphasis"><em>RatePolicy</em></span>.
48        To use it, simply declare it as a friend in your class:
49      </p>
50<h5>
51<a name="beast.ref.boost__beast__rate_policy_access.h2"></a>
52        <span class="phrase"><a name="beast.ref.boost__beast__rate_policy_access.example"></a></span><a class="link" href="boost__beast__rate_policy_access.html#beast.ref.boost__beast__rate_policy_access.example">Example</a>
53      </h5>
54<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">custom_rate_policy</span>
55<span class="special">{</span>
56    <span class="keyword">friend</span> <span class="keyword">class</span> <span class="identifier">beast</span><span class="special">::</span><span class="identifier">rate_policy_access</span><span class="special">;</span>
57    <span class="special">...</span>
58</pre>
59<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
60            <span class="emphasis"><em>RatePolicy</em></span>
61          </li></ul></div>
62<h5>
63<a name="beast.ref.boost__beast__rate_policy_access.h3"></a>
64        <span class="phrase"><a name="beast.ref.boost__beast__rate_policy_access.see_also"></a></span><a class="link" href="boost__beast__rate_policy_access.html#beast.ref.boost__beast__rate_policy_access.see_also">See
65        Also</a>
66      </h5>
67<p>
68        <a class="link" href="boost__beast__basic_stream.html" title="basic_stream"><code class="computeroutput"><span class="identifier">beast</span><span class="special">::</span><span class="identifier">basic_stream</span></code></a>
69      </p>
70</div>
71<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
72<td align="left"></td>
73<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
74      Falco<p>
75        Distributed under the Boost Software License, Version 1.0. (See accompanying
76        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>)
77      </p>
78</div></td>
79</tr></table>
80<hr>
81<div class="spirit-nav">
82<a accesskey="p" href="boost__beast__websocket__permessage_deflate/memLevel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__http__basic_file_body__reader.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
83</div>
84</body>
85</html>
86