1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::ping (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="../ping.html" title="websocket::stream::ping"> 9<link rel="prev" href="../ping.html" title="websocket::stream::ping"> 10<link rel="next" href="overload2.html" title="websocket::stream::ping (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="../ping.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="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.ping.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::ping (1 of 2 overloads)">websocket::stream::ping 28 (1 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.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.ping.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.ping.overload1.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</pre> 39<h7><a name="beast.ref.boost__beast__websocket__stream.ping.overload1.h1"></a> 40 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.ping.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.ping.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.2" target="_top">ping 43 frame</a>, which usually elicits an automatic pong control frame 44 response from the peer. The call blocks until one of the following conditions 45 is true: 46 </p> 47<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 48<li class="listitem"> 49 The ping 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. 59 </p> 60<h7><a name="beast.ref.boost__beast__websocket__stream.ping.overload1.h2"></a> 61 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.ping.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.ping.overload1.parameters">Parameters</a> 62 </h7><div class="informaltable"><table class="table"> 63<colgroup> 64<col> 65<col> 66</colgroup> 67<thead><tr> 68<th> 69 <p> 70 Name 71 </p> 72 </th> 73<th> 74 <p> 75 Description 76 </p> 77 </th> 78</tr></thead> 79<tbody><tr> 80<td> 81 <p> 82 <code class="computeroutput"><span class="identifier">payload</span></code> 83 </p> 84 </td> 85<td> 86 <p> 87 The payload of the ping message, which may be empty. 88 </p> 89 </td> 90</tr></tbody> 91</table></div> 92<h7><a name="beast.ref.boost__beast__websocket__stream.ping.overload1.h3"></a> 93 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.ping.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.ping.overload1.exceptions">Exceptions</a> 94 </h7><div class="informaltable"><table class="table"> 95<colgroup> 96<col> 97<col> 98</colgroup> 99<thead><tr> 100<th> 101 <p> 102 Type 103 </p> 104 </th> 105<th> 106 <p> 107 Thrown On 108 </p> 109 </th> 110</tr></thead> 111<tbody><tr> 112<td> 113 <p> 114 <code class="computeroutput"><span class="identifier">system_error</span></code> 115 </p> 116 </td> 117<td> 118 <p> 119 Thrown on failure. 120 </p> 121 </td> 122</tr></tbody> 123</table></div> 124</div> 125<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 126<td align="left"></td> 127<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 128 Falco<p> 129 Distributed under the Boost Software License, Version 1.0. (See accompanying 130 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>) 131 </p> 132</div></td> 133</tr></table> 134<hr> 135<div class="spirit-nav"> 136<a accesskey="p" href="../ping.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="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 137</div> 138</body> 139</html> 140
