1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Simple WebSocket Client ��</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="../quick_start.html" title="Quick Look"> 9<link rel="prev" href="http_client.html" title="Simple HTTP Client ��"> 10<link rel="next" href="security_review_bishop_fox.html" title="Security Review (Bishop Fox) ��"> 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="http_client.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_start.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="security_review_bishop_fox.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="beast.quick_start.websocket_client"></a><a class="link" href="websocket_client.html" title="Simple WebSocket Client ��">Simple WebSocket 28 Client ��</a> 29</h3></div></div></div> 30<p> 31 Establish a WebSocket connection, send a message and receive the reply: 32 </p> 33<p> 34 File: <a href="../../../../example/websocket/client/sync/websocket_client_sync.cpp" target="_top">websocket_sync_client.cpp</a> 35 </p> 36<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">beast</span><span class="special">/</span><span class="identifier">core</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 37<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">beast</span><span class="special">/</span><span class="identifier">websocket</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 38<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">asio</span><span class="special">/</span><span class="identifier">connect</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 39<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">asio</span><span class="special">/</span><span class="identifier">ip</span><span class="special">/</span><span class="identifier">tcp</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 40<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">cstdlib</span><span class="special">></span> 41<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> 42<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">string</span><span class="special">></span> 43 44<span class="keyword">namespace</span> <span class="identifier">beast</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">beast</span><span class="special">;</span> <span class="comment">// from <boost/beast.hpp></span> 45<span class="keyword">namespace</span> <span class="identifier">http</span> <span class="special">=</span> <span class="identifier">beast</span><span class="special">::</span><span class="identifier">http</span><span class="special">;</span> <span class="comment">// from <boost/beast/http.hpp></span> 46<span class="keyword">namespace</span> <span class="identifier">websocket</span> <span class="special">=</span> <span class="identifier">beast</span><span class="special">::</span><span class="identifier">websocket</span><span class="special">;</span> <span class="comment">// from <boost/beast/websocket.hpp></span> 47<span class="keyword">namespace</span> <span class="identifier">net</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">;</span> <span class="comment">// from <boost/asio.hpp></span> 48<span class="keyword">using</span> <span class="identifier">tcp</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">;</span> <span class="comment">// from <boost/asio/ip/tcp.hpp></span> 49 50<span class="comment">// Sends a WebSocket message and prints the response</span> 51<span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">char</span><span class="special">**</span> <span class="identifier">argv</span><span class="special">)</span> 52<span class="special">{</span> 53 <span class="keyword">try</span> 54 <span class="special">{</span> 55 <span class="comment">// Check command line arguments.</span> 56 <span class="keyword">if</span><span class="special">(</span><span class="identifier">argc</span> <span class="special">!=</span> <span class="number">4</span><span class="special">)</span> 57 <span class="special">{</span> 58 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cerr</span> <span class="special"><<</span> 59 <span class="string">"Usage: websocket-client-sync <host> <port> <text>\n"</span> <span class="special"><<</span> 60 <span class="string">"Example:\n"</span> <span class="special"><<</span> 61 <span class="string">" websocket-client-sync echo.websocket.org 80 \"Hello, world!\"\n"</span><span class="special">;</span> 62 <span class="keyword">return</span> <span class="identifier">EXIT_FAILURE</span><span class="special">;</span> 63 <span class="special">}</span> 64 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">host</span> <span class="special">=</span> <span class="identifier">argv</span><span class="special">[</span><span class="number">1</span><span class="special">];</span> 65 <span class="keyword">auto</span> <span class="keyword">const</span> <span class="identifier">port</span> <span class="special">=</span> <span class="identifier">argv</span><span class="special">[</span><span class="number">2</span><span class="special">];</span> 66 <span class="keyword">auto</span> <span class="keyword">const</span> <span class="identifier">text</span> <span class="special">=</span> <span class="identifier">argv</span><span class="special">[</span><span class="number">3</span><span class="special">];</span> 67 68 <span class="comment">// The io_context is required for all I/O</span> 69 <span class="identifier">net</span><span class="special">::</span><span class="identifier">io_context</span> <span class="identifier">ioc</span><span class="special">;</span> 70 71 <span class="comment">// These objects perform our I/O</span> 72 <span class="identifier">tcp</span><span class="special">::</span><span class="identifier">resolver</span> <span class="identifier">resolver</span><span class="special">{</span><span class="identifier">ioc</span><span class="special">};</span> 73 <span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special"><</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">></span> <span class="identifier">ws</span><span class="special">{</span><span class="identifier">ioc</span><span class="special">};</span> 74 75 <span class="comment">// Look up the domain name</span> 76 <span class="keyword">auto</span> <span class="keyword">const</span> <span class="identifier">results</span> <span class="special">=</span> <span class="identifier">resolver</span><span class="special">.</span><span class="identifier">resolve</span><span class="special">(</span><span class="identifier">host</span><span class="special">,</span> <span class="identifier">port</span><span class="special">);</span> 77 78 <span class="comment">// Make the connection on the IP address we get from a lookup</span> 79 <span class="keyword">auto</span> <span class="identifier">ep</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">connect</span><span class="special">(</span><span class="identifier">ws</span><span class="special">.</span><span class="identifier">next_layer</span><span class="special">(),</span> <span class="identifier">results</span><span class="special">);</span> 80 81 <span class="comment">// Update the host_ string. This will provide the value of the</span> 82 <span class="comment">// Host HTTP header during the WebSocket handshake.</span> 83 <span class="comment">// See https://tools.ietf.org/html/rfc7230#section-5.4</span> 84 <span class="identifier">host</span> <span class="special">+=</span> <span class="char">':'</span> <span class="special">+</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">to_string</span><span class="special">(</span><span class="identifier">ep</span><span class="special">.</span><span class="identifier">port</span><span class="special">());</span> 85 86 <span class="comment">// Set a decorator to change the User-Agent of the handshake</span> 87 <span class="identifier">ws</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream_base</span><span class="special">::</span><span class="identifier">decorator</span><span class="special">(</span> 88 <span class="special">[](</span><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">request_type</span><span class="special">&</span> <span class="identifier">req</span><span class="special">)</span> 89 <span class="special">{</span> 90 <span class="identifier">req</span><span class="special">.</span><span class="identifier">set</span><span class="special">(</span><span class="identifier">http</span><span class="special">::</span><span class="identifier">field</span><span class="special">::</span><span class="identifier">user_agent</span><span class="special">,</span> 91 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">(</span><span class="identifier">BOOST_BEAST_VERSION_STRING</span><span class="special">)</span> <span class="special">+</span> 92 <span class="string">" websocket-client-coro"</span><span class="special">);</span> 93 <span class="special">}));</span> 94 95 <span class="comment">// Perform the websocket handshake</span> 96 <span class="identifier">ws</span><span class="special">.</span><span class="identifier">handshake</span><span class="special">(</span><span class="identifier">host</span><span class="special">,</span> <span class="string">"/"</span><span class="special">);</span> 97 98 <span class="comment">// Send the message</span> 99 <span class="identifier">ws</span><span class="special">.</span><span class="identifier">write</span><span class="special">(</span><span class="identifier">net</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">(</span><span class="identifier">text</span><span class="special">)));</span> 100 101 <span class="comment">// This buffer will hold the incoming message</span> 102 <span class="identifier">beast</span><span class="special">::</span><span class="identifier">flat_buffer</span> <span class="identifier">buffer</span><span class="special">;</span> 103 104 <span class="comment">// Read a message into our buffer</span> 105 <span class="identifier">ws</span><span class="special">.</span><span class="identifier">read</span><span class="special">(</span><span class="identifier">buffer</span><span class="special">);</span> 106 107 <span class="comment">// Close the WebSocket connection</span> 108 <span class="identifier">ws</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">close_code</span><span class="special">::</span><span class="identifier">normal</span><span class="special">);</span> 109 110 <span class="comment">// If we get here then the connection is closed gracefully</span> 111 112 <span class="comment">// The make_printable() function helps print a ConstBufferSequence</span> 113 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">beast</span><span class="special">::</span><span class="identifier">make_printable</span><span class="special">(</span><span class="identifier">buffer</span><span class="special">.</span><span class="identifier">data</span><span class="special">())</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> 114 <span class="special">}</span> 115 <span class="keyword">catch</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">exception</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">e</span><span class="special">)</span> 116 <span class="special">{</span> 117 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cerr</span> <span class="special"><<</span> <span class="string">"Error: "</span> <span class="special"><<</span> <span class="identifier">e</span><span class="special">.</span><span class="identifier">what</span><span class="special">()</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> 118 <span class="keyword">return</span> <span class="identifier">EXIT_FAILURE</span><span class="special">;</span> 119 <span class="special">}</span> 120 <span class="keyword">return</span> <span class="identifier">EXIT_SUCCESS</span><span class="special">;</span> 121<span class="special">}</span> 122</pre> 123</div> 124<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 125<td align="left"></td> 126<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 127 Falco<p> 128 Distributed under the Boost Software License, Version 1.0. (See accompanying 129 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>) 130 </p> 131</div></td> 132</tr></table> 133<hr> 134<div class="spirit-nav"> 135<a accesskey="p" href="http_client.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_start.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="security_review_bishop_fox.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 136</div> 137</body> 138</html> 139
