1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::ping (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="../ping.html" title="websocket::stream::ping"> 9<link rel="prev" href="overload1.html" title="websocket::stream::ping (1 of 2 overloads)"> 10<link rel="next" href="../async_ping.html" title="websocket::stream::async_ping"> 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="../ping.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_ping.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.ping.overload2"></a><a class="link" href="overload2.html" title="websocket::stream::ping (2 of 2 overloads)">websocket::stream::ping 28 (2 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Send a websocket ping control frame. 32 </p> 33<h7><a name="beast.ref.boost__beast__websocket__stream.ping.overload2.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.ping.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.ping.overload2.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">void</span> 36<span class="identifier">ping</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.ping.overload2.h1"></a> 41 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.ping.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.ping.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.2" target="_top">ping 44 frame</a>, which usually elicits an automatic pong control frame 45 response from the peer. The call blocks until one of the following conditions 46 is true: 47 </p> 48<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 49<li class="listitem"> 50 The ping 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. 60 </p> 61<h7><a name="beast.ref.boost__beast__websocket__stream.ping.overload2.h2"></a> 62 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.ping.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.ping.overload2.parameters">Parameters</a> 63 </h7><div class="informaltable"><table class="table"> 64<colgroup> 65<col> 66<col> 67</colgroup> 68<thead><tr> 69<th> 70 <p> 71 Name 72 </p> 73 </th> 74<th> 75 <p> 76 Description 77 </p> 78 </th> 79</tr></thead> 80<tbody> 81<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 ping message, which may be empty. 90 </p> 91 </td> 92</tr> 93<tr> 94<td> 95 <p> 96 <code class="computeroutput"><span class="identifier">ec</span></code> 97 </p> 98 </td> 99<td> 100 <p> 101 Set to indicate what error occurred, if any. 102 </p> 103 </td> 104</tr> 105</tbody> 106</table></div> 107</div> 108<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 109<td align="left"></td> 110<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 111 Falco<p> 112 Distributed under the Boost Software License, Version 1.0. (See accompanying 113 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>) 114 </p> 115</div></td> 116</tr></table> 117<hr> 118<div class="spirit-nav"> 119<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ping.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_ping.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 120</div> 121</body> 122</html> 123
