<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="icon" href="https://avatars0.githubusercontent.com/u/58360786?s=200&v=4" title="Kayrx">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.10.2/dist/katex.min.css" integrity="sha384-yFRtMMDnQtDRO8rLpMIKrtPCD5jdktao2TV19YiZYWMDkUR5GQZR/NOVTdquEx1j" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/katex-copytex@latest/dist/katex-copytex.min.css">
<script src="https://cdn.jsdelivr.net/npm/katex-copytex@latest/dist/katex-copytex.min.js"></script>
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/Microsoft/vscode/extensions/markdown-language-features/media/markdown.css">
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/Microsoft/vscode/extensions/markdown-language-features/media/highlight.css">
<link rel="stylesheet" type="text/css" href="https://kayrx.xyz/home.css" />
<title>Kayrx / websocket</title>
</head>
<body class="vscode-light">
<div id="page" class="page-section-doc">
<div id="mnav">
<div id="lnav">
<div id="left">
<a id="front" href="/"><img src="/kayrx.png"/></a>
<span id="dlnav">
<a class="tail" href="/kayrx/" >Kayrx</a>
<a class="tail" href="/yarx" >Yarx</a>
<a class="tail" href="/blog" >Blog</a>
</span>
</div>
<label ><a href="#" id="menu">M</a></label>
</div>
<div id="rnav">
<li > <a href="https://spectrum.chat/kayrx" target="_black" style="color:green; font-weight: bold;" >群聊</a></li>
<li ><a href="/community" >社区</a></li>
<li > <a href="/funding">赞助</a></li>
</div>
</div>
<div id="content">
<div class="container"><div class="doc-page doc-section-protocol-websocket">
<div class="doc-nav">
<details id="pc" open>
<summary id="dir"><strong>目录指南</strong></summary>
<details open>
<summary id="title"><strong>介绍</strong></summary>
<a class="doc-section-link-introduction-index" href="/kayrx/introduction/index.html">欢迎</a>
<a class="doc-section-link-introduction-whatis" href="/kayrx/introduction/whatis.html">何为Actix</a>
<a class="doc-section-link-introduction-install" href="/kayrx/introduction/install.html">安装</a>
</details>
<details open>
<summary id="title"><strong>基本</strong></summary>
<a class="doc-section-link-basic-start" href="/kayrx/basic/start.html">入门</a>
<a class="doc-section-link-basic-app" href="/kayrx/basic/app.html">应用</a>
<a class="doc-section-link-basic-server" href="/kayrx/basic/server.html">服务器</a>
<a class="doc-section-link-basic-handler" href="/kayrx/basic/handler.html">处理器</a>
<a class="doc-section-link-basic-extractor" href="/kayrx/basic/extractor.html">提取器</a>
</details>
<details open>
<summary id="title"><strong>高级</strong></summary>
<a class="doc-section-link-advance-error" href="/kayrx/advance/error.html">错误</a>
<a class="doc-section-link-advance-url-dispatch" href="/kayrx/advance/url-dispatch.html">路由分发</a>
<a class="doc-section-link-advance-request" href="/kayrx/advance/request.html">请求</a>
<a class="doc-section-link-advance-response" href="/kayrx/advance/response.html">响应</a>
<a class="doc-section-link-advance-test" href="/kayrx/advance/test.html">测试</a>
<a class="doc-section-link-advance-middleware" href="/kayrx/advance/middleware.html">中间件</a>
<a class="doc-section-link-advance-static-file" href="/kayrx/advance/static-file.html">静态文件</a>
</details>
<details open>
<summary id="title"><strong>协议</strong></summary>
<a class="doc-section-link-protocol-websocket" href="/kayrx/protocol/websocket.html">Websocket</a>
<a class="doc-section-link-protocol-http2" href="/kayrx/protocol/http2.html">HTTP2</a>
</details>
<details open>
<summary id="title"><strong>模式</strong></summary>
<a class="doc-section-link-pattern-autoreload" href="/kayrx/pattern/autoreload.html">自动重载</a>
<a class="doc-section-link-pattern-database" href="/kayrx/pattern/database.html">数据库</a>
</details>
</details>
<details id="mobile">
<summary id="dir"><strong>目录指南</strong></summary>
<details open>
<summary id="title"><strong>介绍</strong></summary>
<a class="doc-section-link-introduction-index" href="/kayrx/introduction/index.html">欢迎</a>
<a class="doc-section-link-introduction-whatis" href="/kayrx/introduction/whatis.html">何为Actix</a>
<a class="doc-section-link-introduction-install" href="/kayrx/introduction/install.html">安装</a>
</details>
<details open>
<summary id="title"><strong>基本</strong></summary>
<a class="doc-section-link-basic-start" href="/kayrx/basic/start.html">入门</a>
<a class="doc-section-link-basic-app" href="/kayrx/basic/app.html">应用</a>
<a class="doc-section-link-basic-server" href="/kayrx/basic/server.html">服务器</a>
<a class="doc-section-link-basic-handler" href="/kayrx/basic/handler.html">处理器</a>
<a class="doc-section-link-basic-extractor" href="/kayrx/basic/extractor.html">提取器</a>
</details>
<details open>
<summary id="title"><strong>高级</strong></summary>
<a class="doc-section-link-advance-error" href="/kayrx/advance/error.html">错误</a>
<a class="doc-section-link-advance-url-dispatch" href="/kayrx/advance/url-dispatch.html">路由分发</a>
<a class="doc-section-link-advance-request" href="/kayrx/advance/request.html">请求</a>
<a class="doc-section-link-advance-response" href="/kayrx/advance/response.html">响应</a>
<a class="doc-section-link-advance-test" href="/kayrx/advance/test.html">测试</a>
<a class="doc-section-link-advance-middleware" href="/kayrx/advance/middleware.html">中间件</a>
<a class="doc-section-link-advance-static-file" href="/kayrx/advance/static-file.html">静态文件</a>
</details>
<details open>
<summary id="title"><strong>协议</strong></summary>
<a class="doc-section-link-protocol-websocket" href="/kayrx/protocol/websocket.html">Websocket</a>
<a class="doc-section-link-protocol-http2" href="/kayrx/protocol/http2.html">HTTP2</a>
</details>
<details open>
<summary id="title"><strong>模式</strong></summary>
<a class="doc-section-link-pattern-autoreload" href="/kayrx/pattern/autoreload.html">自动重载</a>
<a class="doc-section-link-pattern-database" href="/kayrx/pattern/database.html">数据库</a>
</details>
</details>
</div>
<div class="doc-content"> <h1 id="websocket">Websocket</h1>
<p>Actix-web supports WebSockets with the <code>actix-web-actors</code> crate. It is possible to convert a
request's <code>Payload</code> to a stream of <a href="https://docs.rs/actix-web-actors/2/actix_web_actors/ws/enum.Message.html"><em>ws::Message</em></a> with a <a href="https://docs.rs/actix-web/2/actix_web/web/struct.Payload.html"><em>web::Payload</em></a>
and then use stream combinators to handle actual messages, but it is simpler to handle
websocket communications with an http actor.</p>
<p>The following is an example of a simple websocket echo server:</p>
<p>{{< include-example example="websockets" file="<a href="http://main.rs">main.rs</a>" section="websockets" >}}</p>
<blockquote>
<p>A simple websocket echo server example is available in the <a href="https://github.com/actix/examples/tree/master/websocket/">examples directory</a>.</p>
</blockquote>
<blockquote>
<p>An example chat server with the ability to chat over a websocket or tcp connection
is available in <a href="https://github.com/actix/examples/tree/master/websocket-chat/">websocket-chat directory</a></p>
</blockquote>
</div>
</div>
</div>
</div>
<div id="footer">
© 2019 <a href="https://github.com/kayrx">Kayrx</a>
</div>
</div>
<script async>
window.onload = function() {
let menu = document.getElementById('menu');
menu.addEventListener('click', function() {
let nav = document.getElementById('rnav');
if (nav.style.height == 'auto') {
nav.style.height = '0';
}else{
nav.style.height = 'auto';
}
}, false)
}
</script>
</body>
</html>