1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::pong (1 of 2 overloads)</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="../pong.html" title="websocket::stream::pong"> 9<link rel="prev" href="../pong.html" title="websocket::stream::pong"> 10<link rel="next" href="overload2.html" title="websocket::stream::pong (2 of 2 overloads)"> 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="../pong.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../pong.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="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h6 class="title"> 27<a name="beast.ref.boost__beast__websocket__stream.pong.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::pong (1 of 2 overloads)">websocket::stream::pong 28 (1 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Send a websocket pong control frame. 32 </p> 33<h7><a name="beast.ref.boost__beast__websocket__stream.pong.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.pong.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.pong.overload1.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">void</span> 36<span class="identifier">pong</span><span class="special">(</span> 37 <span class="identifier">ping_data</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">payload</span><span class="special">);</span> 38</pre> 39<h7><a name="beast.ref.boost__beast__websocket__stream.pong.overload1.h1"></a> 40 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.pong.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.pong.overload1.description">Description</a> 41 </h7><p> 42 This function is used to send a <a href="https://tools.ietf.org/html/rfc6455#section-5.5.3" target="_top">pong 43 frame</a>, which is usually sent automatically in response to a ping 44 frame from the remote peer. The call blocks until one of the following 45 conditions is true: 46 </p> 47<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 48<li class="listitem"> 49 The pong frame is written. 50 </li> 51<li class="listitem"> 52 An error occurs. 53 </li> 54</ul></div> 55<p> 56 The algorithm, known as a <span class="emphasis"><em>composed operation</em></span>, is 57 implemented in terms of calls to the next layer's <code class="computeroutput"><span class="identifier">write_some</span></code> 58 function. WebSocket allows pong frames to be sent at any time, without 59 first receiving a ping. An unsolicited pong sent in this fashion may 60 indicate to the remote peer that the connection is still active. 61 </p> 62<h7><a name="beast.ref.boost__beast__websocket__stream.pong.overload1.h2"></a> 63 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.pong.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.pong.overload1.parameters">Parameters</a> 64 </h7><div class="informaltable"><table class="table"> 65<colgroup> 66<col> 67<col> 68</colgroup> 69<thead><tr> 70<th> 71 <p> 72 Name 73 </p> 74 </th> 75<th> 76 <p> 77 Description 78 </p> 79 </th> 80</tr></thead> 81<tbody><tr> 82<td> 83 <p> 84 <code class="computeroutput"><span class="identifier">payload</span></code> 85 </p> 86 </td> 87<td> 88 <p> 89 The payload of the pong message, which may be empty. 90 </p> 91 </td> 92</tr></tbody> 93</table></div> 94<h7><a name="beast.ref.boost__beast__websocket__stream.pong.overload1.h3"></a> 95 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.pong.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.pong.overload1.exceptions">Exceptions</a> 96 </h7><div class="informaltable"><table class="table"> 97<colgroup> 98<col> 99<col> 100</colgroup> 101<thead><tr> 102<th> 103 <p> 104 Type 105 </p> 106 </th> 107<th> 108 <p> 109 Thrown On 110 </p> 111 </th> 112</tr></thead> 113<tbody><tr> 114<td> 115 <p> 116 <code class="computeroutput"><span class="identifier">system_error</span></code> 117 </p> 118 </td> 119<td> 120 <p> 121 Thrown on failure. 122 </p> 123 </td> 124</tr></tbody> 125</table></div> 126</div> 127<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 128<td align="left"></td> 129<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 130 Falco<p> 131 Distributed under the Boost Software License, Version 1.0. (See accompanying 132 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>) 133 </p> 134</div></td> 135</tr></table> 136<hr> 137<div class="spirit-nav"> 138<a accesskey="p" href="../pong.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../pong.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="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 139</div> 140</body> 141</html> 142
