3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>websocket::reason_string</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__ping_data.html" title="websocket::ping_data">
10 <link rel="next" href="boost__beast__websocket__request_type.html" title="websocket::request_type">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="boost__beast__websocket__ping_data.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__websocket__request_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h4 class="title">
27 <a name="beast.ref.boost__beast__websocket__reason_string"></a><a class="link" href="boost__beast__websocket__reason_string.html" title="websocket::reason_string">websocket::reason_string</a>
28 </h4></div></div></div>
30 <a class="indexterm" name="idm45873474578496"></a>
31 The type representing the reason string in a close
35 <a name="beast.ref.boost__beast__websocket__reason_string.h0"></a>
36 <span class="phrase"><a name="beast.ref.boost__beast__websocket__reason_string.synopsis"></a></span><a class="link" href="boost__beast__websocket__reason_string.html#beast.ref.boost__beast__websocket__reason_string.synopsis">Synopsis</a>
39 Defined in header <code class="literal"><<a href="../../../../../../boost/beast/websocket/rfc6455.hpp" target="_top">boost/beast/websocket/rfc6455.hpp</a>></code>
41 <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">reason_string</span> <span class="special">=</span> <span class="identifier">static_string</span><span class="special"><</span> <span class="number">123</span><span class="special">,</span> <span class="keyword">char</span> <span class="special">>;</span>
44 <a name="beast.ref.boost__beast__websocket__reason_string.h1"></a>
45 <span class="phrase"><a name="beast.ref.boost__beast__websocket__reason_string.types"></a></span><a class="link" href="boost__beast__websocket__reason_string.html#beast.ref.boost__beast__websocket__reason_string.types">Types</a>
47 <div class="informaltable"><table class="table">
68 <a class="link" href="boost__beast__static_string/const_iterator.html" title="static_string::const_iterator"><span class="bold"><strong>const_iterator</strong></span></a>
77 <a class="link" href="boost__beast__static_string/const_pointer.html" title="static_string::const_pointer"><span class="bold"><strong>const_pointer</strong></span></a>
86 <a class="link" href="boost__beast__static_string/const_reference.html" title="static_string::const_reference"><span class="bold"><strong>const_reference</strong></span></a>
95 <a class="link" href="boost__beast__static_string/const_reverse_iterator.html" title="static_string::const_reverse_iterator"><span class="bold"><strong>const_reverse_iterator</strong></span></a>
104 <a class="link" href="boost__beast__static_string/difference_type.html" title="static_string::difference_type"><span class="bold"><strong>difference_type</strong></span></a>
113 <a class="link" href="boost__beast__static_string/iterator.html" title="static_string::iterator"><span class="bold"><strong>iterator</strong></span></a>
122 <a class="link" href="boost__beast__static_string/pointer.html" title="static_string::pointer"><span class="bold"><strong>pointer</strong></span></a>
131 <a class="link" href="boost__beast__static_string/reference.html" title="static_string::reference"><span class="bold"><strong>reference</strong></span></a>
140 <a class="link" href="boost__beast__static_string/reverse_iterator.html" title="static_string::reverse_iterator"><span class="bold"><strong>reverse_iterator</strong></span></a>
149 <a class="link" href="boost__beast__static_string/size_type.html" title="static_string::size_type"><span class="bold"><strong>size_type</strong></span></a>
158 <a class="link" href="boost__beast__static_string/string_view_type.html" title="static_string::string_view_type"><span class="bold"><strong>string_view_type</strong></span></a>
163 The type of string_view returned by the interface.
170 <a class="link" href="boost__beast__static_string/traits_type.html" title="static_string::traits_type"><span class="bold"><strong>traits_type</strong></span></a>
179 <a class="link" href="boost__beast__static_string/value_type.html" title="static_string::value_type"><span class="bold"><strong>value_type</strong></span></a>
188 <a name="beast.ref.boost__beast__websocket__reason_string.h2"></a>
189 <span class="phrase"><a name="beast.ref.boost__beast__websocket__reason_string.member_functions"></a></span><a class="link" href="boost__beast__websocket__reason_string.html#beast.ref.boost__beast__websocket__reason_string.member_functions">Member
192 <div class="informaltable"><table class="table">
213 <a class="link" href="boost__beast__static_string/append.html" title="static_string::append"><span class="bold"><strong>append</strong></span></a>
222 <a class="link" href="boost__beast__static_string/assign.html" title="static_string::assign"><span class="bold"><strong>assign</strong></span></a>
227 Assign count copies of ch.
230 Assign from another static_string
233 Assign count characterss starting at npos from other.
236 Assign the first count characters of s, including nulls.
239 Assign a null terminated string.
242 Assign from an iterator range of characters.
245 Assign from any object convertible to string_view_type.
252 <a class="link" href="boost__beast__static_string/at.html" title="static_string::at"><span class="bold"><strong>at</strong></span></a>
257 Access specified character with bounds checking.
264 <a class="link" href="boost__beast__static_string/back.html" title="static_string::back"><span class="bold"><strong>back</strong></span></a>
269 Accesses the last character.
276 <a class="link" href="boost__beast__static_string/begin.html" title="static_string::begin"><span class="bold"><strong>begin</strong></span></a>
281 Returns an iterator to the beginning.
288 <a class="link" href="boost__beast__static_string/c_str.html" title="static_string::c_str"><span class="bold"><strong>c_str</strong></span></a>
293 Returns a non-modifiable standard C character array version of
301 <a class="link" href="boost__beast__static_string/capacity.html" title="static_string::capacity"><span class="bold"><strong>capacity</strong></span></a>
306 Returns the number of characters that can be held in currently
314 <a class="link" href="boost__beast__static_string/cbegin.html" title="static_string::cbegin"><span class="bold"><strong>cbegin</strong></span></a>
319 Returns an iterator to the beginning.
326 <a class="link" href="boost__beast__static_string/cend.html" title="static_string::cend"><span class="bold"><strong>cend</strong></span></a>
331 Returns an iterator to the end.
338 <a class="link" href="boost__beast__static_string/clear.html" title="static_string::clear"><span class="bold"><strong>clear</strong></span></a>
350 <a class="link" href="boost__beast__static_string/compare.html" title="static_string::compare"><span class="bold"><strong>compare</strong></span></a>
359 <a class="link" href="boost__beast__static_string/copy.html" title="static_string::copy"><span class="bold"><strong>copy</strong></span></a>
364 Copy a substring (pos, pos+count) to character string pointed to
372 <a class="link" href="boost__beast__static_string/crbegin.html" title="static_string::crbegin"><span class="bold"><strong>crbegin</strong></span></a>
377 Returns a reverse iterator to the beginning.
384 <a class="link" href="boost__beast__static_string/crend.html" title="static_string::crend"><span class="bold"><strong>crend</strong></span></a>
389 Returns a reverse iterator to the end.
396 <a class="link" href="boost__beast__static_string/data.html" title="static_string::data"><span class="bold"><strong>data</strong></span></a>
401 Returns a pointer to the first character of a string.
408 <a class="link" href="boost__beast__static_string/empty.html" title="static_string::empty"><span class="bold"><strong>empty</strong></span></a>
413 Returns true if the string is empty.
420 <a class="link" href="boost__beast__static_string/end.html" title="static_string::end"><span class="bold"><strong>end</strong></span></a>
425 Returns an iterator to the end.
432 <a class="link" href="boost__beast__static_string/erase.html" title="static_string::erase"><span class="bold"><strong>erase</strong></span></a>
441 <a class="link" href="boost__beast__static_string/front.html" title="static_string::front"><span class="bold"><strong>front</strong></span></a>
446 Accesses the first character.
453 <a class="link" href="boost__beast__static_string/insert.html" title="static_string::insert"><span class="bold"><strong>insert</strong></span></a>
462 <a class="link" href="boost__beast__static_string/length.html" title="static_string::length"><span class="bold"><strong>length</strong></span></a>
467 Returns the number of characters, excluding the null terminator.
474 <a class="link" href="boost__beast__static_string/max_size.html" title="static_string::max_size"><span class="bold"><strong>max_size</strong></span></a>
479 Returns the maximum number of characters that can be stored, excluding
487 <a class="link" href="boost__beast__static_string/operator_string_view_type.html" title="static_string::operator string_view_type"><span class="bold"><strong>operator string_view_type</strong></span></a>
492 Convert a static string to a string_view_type
499 <a class="link" href="boost__beast__static_string/operator_plus__eq_.html" title="static_string::operator+="><span class="bold"><strong>operator+=</strong></span></a>
508 <a class="link" href="boost__beast__static_string/operator_eq_.html" title="static_string::operator="><span class="bold"><strong>operator=</strong></span></a>
516 Assign from null-terminated string.
519 Assign from single character.
522 Assign from initializer list.
525 Assign from string_view_type.
532 <a class="link" href="boost__beast__static_string/operator_lb__rb_.html" title="static_string::operator[]"><span class="bold"><strong>operator[]</strong></span></a>
537 Access specified character.
544 <a class="link" href="boost__beast__static_string/pop_back.html" title="static_string::pop_back"><span class="bold"><strong>pop_back</strong></span></a>
553 <a class="link" href="boost__beast__static_string/push_back.html" title="static_string::push_back"><span class="bold"><strong>push_back</strong></span></a>
562 <a class="link" href="boost__beast__static_string/rbegin.html" title="static_string::rbegin"><span class="bold"><strong>rbegin</strong></span></a>
567 Returns a reverse iterator to the beginning.
574 <a class="link" href="boost__beast__static_string/rend.html" title="static_string::rend"><span class="bold"><strong>rend</strong></span></a>
579 Returns a reverse iterator to the end.
586 <a class="link" href="boost__beast__static_string/reserve.html" title="static_string::reserve"><span class="bold"><strong>reserve</strong></span></a>
598 <a class="link" href="boost__beast__static_string/resize.html" title="static_string::resize"><span class="bold"><strong>resize</strong></span></a>
603 Changes the number of characters stored.
610 <a class="link" href="boost__beast__static_string/shrink_to_fit.html" title="static_string::shrink_to_fit"><span class="bold"><strong>shrink_to_fit</strong></span></a>
615 Reduces memory usage by freeing unused memory.
622 <a class="link" href="boost__beast__static_string/size.html" title="static_string::size"><span class="bold"><strong>size</strong></span></a>
627 Returns the number of characters, excluding the null terminator.
634 <a class="link" href="boost__beast__static_string/static_string.html" title="static_string::static_string"><span class="bold"><strong>static_string</strong></span></a>
639 Default constructor (empty string).
642 Construct with count copies of character ch.
645 Construct with a substring (pos, other.size()) of other.
648 Construct with a substring (pos, count) of other.
651 Construct with the first count characters of s, including nulls.
654 Construct from a null terminated string.
657 Construct from a range of characters.
663 Construct from an initializer list.
666 Construct from a string_view
669 Construct from any object convertible to string_view_type.
676 <a class="link" href="boost__beast__static_string/substr.html" title="static_string::substr"><span class="bold"><strong>substr</strong></span></a>
685 <a class="link" href="boost__beast__static_string/swap.html" title="static_string::swap"><span class="bold"><strong>swap</strong></span></a>
690 Exchange the contents of this string with another.
697 <a name="beast.ref.boost__beast__websocket__reason_string.h3"></a>
698 <span class="phrase"><a name="beast.ref.boost__beast__websocket__reason_string.data_members"></a></span><a class="link" href="boost__beast__websocket__reason_string.html#beast.ref.boost__beast__websocket__reason_string.data_members">Data
701 <div class="informaltable"><table class="table">
722 <a class="link" href="boost__beast__static_string/max_size_n.html" title="static_string::max_size_n"><span class="bold"><strong>max_size_n</strong></span></a>
727 Maximum size of the string excluding the null terminator.
734 <a class="link" href="boost__beast__static_string/npos.html" title="static_string::npos"><span class="bold"><strong>npos</strong></span></a>
746 These objects behave like <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span></code>
747 except that the storage is not dynamically allocated but rather fixed in
748 size. These strings offer performance advantages when a protocol imposes
749 a natural small upper limit on the size of a value.
752 <a name="beast.ref.boost__beast__websocket__reason_string.h4"></a>
753 <span class="phrase"><a name="beast.ref.boost__beast__websocket__reason_string.remarks"></a></span><a class="link" href="boost__beast__websocket__reason_string.html#beast.ref.boost__beast__websocket__reason_string.remarks">Remarks</a>
756 The stored string is always null-terminated.
759 <a name="beast.ref.boost__beast__websocket__reason_string.h5"></a>
760 <span class="phrase"><a name="beast.ref.boost__beast__websocket__reason_string.see_also"></a></span><a class="link" href="boost__beast__websocket__reason_string.html#beast.ref.boost__beast__websocket__reason_string.see_also">See Also</a>
763 <a class="link" href="boost__beast__to_static_string.html" title="to_static_string"><code class="computeroutput"><span class="identifier">to_static_string</span></code></a>
766 <a name="beast.ref.boost__beast__websocket__reason_string.h6"></a>
767 <span class="phrase"><a name="beast.ref.boost__beast__websocket__reason_string.description"></a></span><a class="link" href="boost__beast__websocket__reason_string.html#beast.ref.boost__beast__websocket__reason_string.description">Description</a>
770 Convenience header <code class="literal"><<a href="../../../../../../boost/beast/websocket.hpp" target="_top">boost/beast/websocket.hpp</a>></code>
773 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
774 <td align="left"></td>
775 <td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
777 Distributed under the Boost Software License, Version 1.0. (See accompanying
778 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>)
783 <div class="spirit-nav">
784 <a accesskey="p" href="boost__beast__websocket__ping_data.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__websocket__request_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>