3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>websocket::ping_data</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/server_no_context_takeover.html" title="websocket::permessage_deflate::server_no_context_takeover">
10 <link rel="next" href="boost__beast__websocket__reason_string.html" title="websocket::reason_string">
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__permessage_deflate/server_no_context_takeover.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__reason_string.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__ping_data"></a><a class="link" href="boost__beast__websocket__ping_data.html" title="websocket::ping_data">websocket::ping_data</a>
28 </h4></div></div></div>
30 <a class="indexterm" name="idm45873474800272"></a>
31 The type representing the payload of ping and pong messages.
34 <a name="beast.ref.boost__beast__websocket__ping_data.h0"></a>
35 <span class="phrase"><a name="beast.ref.boost__beast__websocket__ping_data.synopsis"></a></span><a class="link" href="boost__beast__websocket__ping_data.html#beast.ref.boost__beast__websocket__ping_data.synopsis">Synopsis</a>
38 Defined in header <code class="literal"><<a href="../../../../../../boost/beast/websocket/rfc6455.hpp" target="_top">boost/beast/websocket/rfc6455.hpp</a>></code>
40 <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">ping_data</span> <span class="special">=</span> <span class="identifier">static_string</span><span class="special"><</span> <span class="number">125</span><span class="special">,</span> <span class="keyword">char</span> <span class="special">>;</span>
43 <a name="beast.ref.boost__beast__websocket__ping_data.h1"></a>
44 <span class="phrase"><a name="beast.ref.boost__beast__websocket__ping_data.types"></a></span><a class="link" href="boost__beast__websocket__ping_data.html#beast.ref.boost__beast__websocket__ping_data.types">Types</a>
46 <div class="informaltable"><table class="table">
67 <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>
76 <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>
85 <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>
94 <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>
103 <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>
112 <a class="link" href="boost__beast__static_string/iterator.html" title="static_string::iterator"><span class="bold"><strong>iterator</strong></span></a>
121 <a class="link" href="boost__beast__static_string/pointer.html" title="static_string::pointer"><span class="bold"><strong>pointer</strong></span></a>
130 <a class="link" href="boost__beast__static_string/reference.html" title="static_string::reference"><span class="bold"><strong>reference</strong></span></a>
139 <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>
148 <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>
157 <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>
162 The type of string_view returned by the interface.
169 <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>
178 <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>
187 <a name="beast.ref.boost__beast__websocket__ping_data.h2"></a>
188 <span class="phrase"><a name="beast.ref.boost__beast__websocket__ping_data.member_functions"></a></span><a class="link" href="boost__beast__websocket__ping_data.html#beast.ref.boost__beast__websocket__ping_data.member_functions">Member
191 <div class="informaltable"><table class="table">
212 <a class="link" href="boost__beast__static_string/append.html" title="static_string::append"><span class="bold"><strong>append</strong></span></a>
221 <a class="link" href="boost__beast__static_string/assign.html" title="static_string::assign"><span class="bold"><strong>assign</strong></span></a>
226 Assign count copies of ch.
229 Assign from another static_string
232 Assign count characterss starting at npos from other.
235 Assign the first count characters of s, including nulls.
238 Assign a null terminated string.
241 Assign from an iterator range of characters.
244 Assign from any object convertible to string_view_type.
251 <a class="link" href="boost__beast__static_string/at.html" title="static_string::at"><span class="bold"><strong>at</strong></span></a>
256 Access specified character with bounds checking.
263 <a class="link" href="boost__beast__static_string/back.html" title="static_string::back"><span class="bold"><strong>back</strong></span></a>
268 Accesses the last character.
275 <a class="link" href="boost__beast__static_string/begin.html" title="static_string::begin"><span class="bold"><strong>begin</strong></span></a>
280 Returns an iterator to the beginning.
287 <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>
292 Returns a non-modifiable standard C character array version of
300 <a class="link" href="boost__beast__static_string/capacity.html" title="static_string::capacity"><span class="bold"><strong>capacity</strong></span></a>
305 Returns the number of characters that can be held in currently
313 <a class="link" href="boost__beast__static_string/cbegin.html" title="static_string::cbegin"><span class="bold"><strong>cbegin</strong></span></a>
318 Returns an iterator to the beginning.
325 <a class="link" href="boost__beast__static_string/cend.html" title="static_string::cend"><span class="bold"><strong>cend</strong></span></a>
330 Returns an iterator to the end.
337 <a class="link" href="boost__beast__static_string/clear.html" title="static_string::clear"><span class="bold"><strong>clear</strong></span></a>
349 <a class="link" href="boost__beast__static_string/compare.html" title="static_string::compare"><span class="bold"><strong>compare</strong></span></a>
358 <a class="link" href="boost__beast__static_string/copy.html" title="static_string::copy"><span class="bold"><strong>copy</strong></span></a>
363 Copy a substring (pos, pos+count) to character string pointed to
371 <a class="link" href="boost__beast__static_string/crbegin.html" title="static_string::crbegin"><span class="bold"><strong>crbegin</strong></span></a>
376 Returns a reverse iterator to the beginning.
383 <a class="link" href="boost__beast__static_string/crend.html" title="static_string::crend"><span class="bold"><strong>crend</strong></span></a>
388 Returns a reverse iterator to the end.
395 <a class="link" href="boost__beast__static_string/data.html" title="static_string::data"><span class="bold"><strong>data</strong></span></a>
400 Returns a pointer to the first character of a string.
407 <a class="link" href="boost__beast__static_string/empty.html" title="static_string::empty"><span class="bold"><strong>empty</strong></span></a>
412 Returns true if the string is empty.
419 <a class="link" href="boost__beast__static_string/end.html" title="static_string::end"><span class="bold"><strong>end</strong></span></a>
424 Returns an iterator to the end.
431 <a class="link" href="boost__beast__static_string/erase.html" title="static_string::erase"><span class="bold"><strong>erase</strong></span></a>
440 <a class="link" href="boost__beast__static_string/front.html" title="static_string::front"><span class="bold"><strong>front</strong></span></a>
445 Accesses the first character.
452 <a class="link" href="boost__beast__static_string/insert.html" title="static_string::insert"><span class="bold"><strong>insert</strong></span></a>
461 <a class="link" href="boost__beast__static_string/length.html" title="static_string::length"><span class="bold"><strong>length</strong></span></a>
466 Returns the number of characters, excluding the null terminator.
473 <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>
478 Returns the maximum number of characters that can be stored, excluding
486 <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>
491 Convert a static string to a string_view_type
498 <a class="link" href="boost__beast__static_string/operator_plus__eq_.html" title="static_string::operator+="><span class="bold"><strong>operator+=</strong></span></a>
507 <a class="link" href="boost__beast__static_string/operator_eq_.html" title="static_string::operator="><span class="bold"><strong>operator=</strong></span></a>
515 Assign from null-terminated string.
518 Assign from single character.
521 Assign from initializer list.
524 Assign from string_view_type.
531 <a class="link" href="boost__beast__static_string/operator_lb__rb_.html" title="static_string::operator[]"><span class="bold"><strong>operator[]</strong></span></a>
536 Access specified character.
543 <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>
552 <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>
561 <a class="link" href="boost__beast__static_string/rbegin.html" title="static_string::rbegin"><span class="bold"><strong>rbegin</strong></span></a>
566 Returns a reverse iterator to the beginning.
573 <a class="link" href="boost__beast__static_string/rend.html" title="static_string::rend"><span class="bold"><strong>rend</strong></span></a>
578 Returns a reverse iterator to the end.
585 <a class="link" href="boost__beast__static_string/reserve.html" title="static_string::reserve"><span class="bold"><strong>reserve</strong></span></a>
597 <a class="link" href="boost__beast__static_string/resize.html" title="static_string::resize"><span class="bold"><strong>resize</strong></span></a>
602 Changes the number of characters stored.
609 <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>
614 Reduces memory usage by freeing unused memory.
621 <a class="link" href="boost__beast__static_string/size.html" title="static_string::size"><span class="bold"><strong>size</strong></span></a>
626 Returns the number of characters, excluding the null terminator.
633 <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>
638 Default constructor (empty string).
641 Construct with count copies of character ch.
644 Construct with a substring (pos, other.size()) of other.
647 Construct with a substring (pos, count) of other.
650 Construct with the first count characters of s, including nulls.
653 Construct from a null terminated string.
656 Construct from a range of characters.
662 Construct from an initializer list.
665 Construct from a string_view
668 Construct from any object convertible to string_view_type.
675 <a class="link" href="boost__beast__static_string/substr.html" title="static_string::substr"><span class="bold"><strong>substr</strong></span></a>
684 <a class="link" href="boost__beast__static_string/swap.html" title="static_string::swap"><span class="bold"><strong>swap</strong></span></a>
689 Exchange the contents of this string with another.
696 <a name="beast.ref.boost__beast__websocket__ping_data.h3"></a>
697 <span class="phrase"><a name="beast.ref.boost__beast__websocket__ping_data.data_members"></a></span><a class="link" href="boost__beast__websocket__ping_data.html#beast.ref.boost__beast__websocket__ping_data.data_members">Data
700 <div class="informaltable"><table class="table">
721 <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>
726 Maximum size of the string excluding the null terminator.
733 <a class="link" href="boost__beast__static_string/npos.html" title="static_string::npos"><span class="bold"><strong>npos</strong></span></a>
745 These objects behave like <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span></code>
746 except that the storage is not dynamically allocated but rather fixed in
747 size. These strings offer performance advantages when a protocol imposes
748 a natural small upper limit on the size of a value.
751 <a name="beast.ref.boost__beast__websocket__ping_data.h4"></a>
752 <span class="phrase"><a name="beast.ref.boost__beast__websocket__ping_data.remarks"></a></span><a class="link" href="boost__beast__websocket__ping_data.html#beast.ref.boost__beast__websocket__ping_data.remarks">Remarks</a>
755 The stored string is always null-terminated.
758 <a name="beast.ref.boost__beast__websocket__ping_data.h5"></a>
759 <span class="phrase"><a name="beast.ref.boost__beast__websocket__ping_data.see_also"></a></span><a class="link" href="boost__beast__websocket__ping_data.html#beast.ref.boost__beast__websocket__ping_data.see_also">See Also</a>
762 <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>
765 <a name="beast.ref.boost__beast__websocket__ping_data.h6"></a>
766 <span class="phrase"><a name="beast.ref.boost__beast__websocket__ping_data.description"></a></span><a class="link" href="boost__beast__websocket__ping_data.html#beast.ref.boost__beast__websocket__ping_data.description">Description</a>
769 Convenience header <code class="literal"><<a href="../../../../../../boost/beast/websocket.hpp" target="_top">boost/beast/websocket.hpp</a>></code>
772 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
773 <td align="left"></td>
774 <td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
776 Distributed under the Boost Software License, Version 1.0. (See accompanying
777 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>)
782 <div class="spirit-nav">
783 <a accesskey="p" href="boost__beast__websocket__permessage_deflate/server_no_context_takeover.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__reason_string.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>