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