245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim This file is generated from xml source: DO NOT EDIT
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc<title>mod_proxy_wstunnel - Apache HTTP Server Version 2.5</title>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
2e545ce2450a9953665f701bb05350f0d3f26275nd<script src="/style/scripts/prettify.min.js" type="text/javascript">
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<link href="/images/favicon.ico" rel="shortcut icon" /></head>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<div id="preamble"><h1>Apache Module mod_proxy_wstunnel</h1>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_wstunnel.html" title="English"> en </a></p>
2544c1693130c0a3106f2ff2c0ef7e3cf0a228e0jim<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Websockets support module for
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></td></tr>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>proxy_wstunnel_module</td></tr>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_proxy_wstunnel.c</td></tr>
0bd1ddab48139fbbe68f4e257fe669dc19f58fe9rbowen<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.5 and later</td></tr></table>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim <p>This module <em>requires</em> the service of <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>. It provides support for the tunnelling of web
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim socket connections to a backend websockets server. The connection
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim is automagically upgraded to a websocket connection:</p>
4aa603e6448b99f9371397d439795c91a93637eandConnection: Upgrade</pre>
2fae9d127f7143fabe8f73958eb9bde31df17d41coar <div class="example"><h3>Proxying requests to websockets server</h3><pre class="prettyprint lang-config">ProxyPass "/ws2/" "ws://echo.websocket.org/"
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<div id="quickview"><h3 class="directives">Directives</h3>
0237f43ab925775250e266e479d0a337ff374a4btakashi<li><img alt="" src="/images/down.gif" /> <a href="#proxywebsocketasync">ProxyWebsocketAsync</a></li>
0237f43ab925775250e266e479d0a337ff374a4btakashi<li><img alt="" src="/images/down.gif" /> <a href="#proxywebsocketasyncdelay">ProxyWebsocketAsyncDelay</a></li>
0237f43ab925775250e266e479d0a337ff374a4btakashi<li><img alt="" src="/images/down.gif" /> <a href="#proxywebsocketidletimeout">ProxyWebsocketIdleTimeout</a></li>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<li><code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></li>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
0237f43ab925775250e266e479d0a337ff374a4btakashi<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0237f43ab925775250e266e479d0a337ff374a4btakashi<div class="directive-section"><h2><a name="ProxyWebsocketAsync" id="ProxyWebsocketAsync">ProxyWebsocketAsync</a> <a name="proxywebsocketasync" id="proxywebsocketasync">Directive</a></h2>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Instructs this module to try to create an asynchronous tunnel</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyWebsocketAsync ON|OFF</code></td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_wstunnel</td></tr>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar <p>This directive instructs the server to try to create an asynchronous tunnel.
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar If the current MPM does not support the necessary features, a synchronous
0237f43ab925775250e266e479d0a337ff374a4btakashi tunnel is used.</p>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar <div class="note"><h3>Note</h3><p>Async support is experimental and subject
0237f43ab925775250e266e479d0a337ff374a4btakashi<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0237f43ab925775250e266e479d0a337ff374a4btakashi<div class="directive-section"><h2><a name="ProxyWebsocketAsyncDelay" id="ProxyWebsocketAsyncDelay">ProxyWebsocketAsyncDelay</a> <a name="proxywebsocketasyncdelay" id="proxywebsocketasyncdelay">Directive</a></h2>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the amount of time the tunnel waits synchronously for data</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyWebsocketAsyncDelay <var>num</var>[ms]</code></td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyWebsocketAsyncDelay 0</code></td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_wstunnel</td></tr>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar <p>If <code class="directive">ProxyWebsocketAsync</code> is enabled, this directive
0237f43ab925775250e266e479d0a337ff374a4btakashi controls how long the server synchronously waits for more data.</p>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar <div class="note"><h3>Note</h3><p>Async support is experimental and subject
0237f43ab925775250e266e479d0a337ff374a4btakashi<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0237f43ab925775250e266e479d0a337ff374a4btakashi<div class="directive-section"><h2><a name="ProxyWebsocketIdleTimeout" id="ProxyWebsocketIdleTimeout">ProxyWebsocketIdleTimeout</a> <a name="proxywebsocketidletimeout" id="proxywebsocketidletimeout">Directive</a></h2>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the maximum amount of time to wait for data on the websockets tunnel</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyWebsocketIdleTimeout <var>num</var>[ms]</code></td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyWebsocketIdleTimeout 0</code></td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0237f43ab925775250e266e479d0a337ff374a4btakashi<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_wstunnel</td></tr>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar <p>This directive imposes a maximum amount of time for the tunnel to be
722c4c7fb902aaea0d89d2ec1734869430558cc3nd left open while idle.</p>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_wstunnel.html" title="English"> en </a></p>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajimvar comments_shortname = 'httpd';
245eb3a84b8bc2b350c3a39ba2599444d443b50ajimvar comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_wstunnel.html';
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim(function(w, d) {
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim d.write('<div id="comments_thread"><\/div>');
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim var s = d.createElement('script');
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim})(window, document);
205f749042ed530040a4f0080dbcb47ceae8a374rjung<p class="apache">Copyright 2015 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
245eb3a84b8bc2b350c3a39ba2599444d443b50ajimif (typeof(prettyPrint) !== 'undefined') {
245eb3a84b8bc2b350c3a39ba2599444d443b50ajim prettyPrint();