manual/mod/mod_proxy_wstunnel.html.en

	mod_proxy_wstunnel.html.en revision 722c4c7fb902aaea0d89d2ec1734869430558cc3
0N/A<?xml version="1.0" encoding="ISO-8859-1"?>
1879N/A<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
0N/A<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
0N/A        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0N/A              This file is generated from xml source: DO NOT EDIT
0N/A        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0N/A      -->
0N/A<title>mod_proxy_wstunnel - Apache HTTP Server</title>
0N/A<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
0N/A<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
0N/A<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" />
0N/A<script src="/style/scripts/prettify.min.js" type="text/javascript">
0N/A</script>
0N/A
0N/A<link href="/images/favicon.ico" rel="shortcut icon" /></head>
0N/A<body>
0N/A<div id="page-header">
0N/A<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>
1472N/A<p class="apache">Apache HTTP Server Version 2.5</p>
1472N/A<img alt="" src="/images/feather.gif" /></div>
1472N/A<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
0N/A<div id="path">
0N/A<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
0N/A<div id="page-content">
1879N/A<div id="preamble"><h1>Apache Module mod_proxy_wstunnel</h1>
1879N/A<div class="toplang">
1879N/A<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_wstunnel.html" title="English">&nbsp;en&nbsp;</a></p>
0N/A</div>
0N/A<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Websockets support module for
0N/A<code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></td></tr>
0N/A<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0N/A<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>proxy_wstunnel_module</td></tr>
0N/A<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_proxy_wstunnel.c</td></tr>
0N/A<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available for unix in version 2.4.5 and later</td></tr></table>
0N/A<h3>Summary</h3>
0N/A
0N/A    <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
0N/A    socket connections to a backend websockets server. The connection
0N/A    is automagically upgraded to a websocket connection:</p>
0N/A
0N/A    <pre class="prettyprint lang-config">Upgrade: WebSocket
0N/AConnection: Upgrade</pre>
0N/A
0N/A
0N/A
0N/A    <div class="example"><h3>Proxying requests to websockets server</h3><pre class="prettyprint lang-config">ProxyPass /ws2/  ws://echo.websocket.org/
0N/AProxyPass /wss2/ wss://echo.websocket.org/</pre>
0N/A</div>
0N/A
0N/A</div>
0N/A<div id="quickview"><h3 class="directives">Directives</h3>
0N/A<ul id="toc">
0N/A<li><img alt="" src="/images/down.gif" /> <a href="#proxywebsocketasync">ProxyWebsocketAsync</a></li>
0N/A<li><img alt="" src="/images/down.gif" /> <a href="#proxywebsocketasyncdelay">ProxyWebsocketAsyncDelay</a></li>
0N/A<li><img alt="" src="/images/down.gif" /> <a href="#proxywebsocketidletimeout">ProxyWebsocketIdleTimeout</a></li>
0N/A</ul>
0N/A<h3>See also</h3>
0N/A<ul class="seealso">
0N/A<li><code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></li>
0N/A</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
0N/A
0N/A<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0N/A<div class="directive-section"><h2><a name="ProxyWebsocketAsync" id="ProxyWebsocketAsync">ProxyWebsocketAsync</a> <a name="proxywebsocketasync" id="proxywebsocketasync">Directive</a></h2>
0N/A<table class="directive">
0N/A<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Instructs this module to try to create an asynchronous tunnel</td></tr>
0N/A<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyWebsocketAsync ON|OFF</code></td></tr>
0N/A<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0N/A<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0N/A<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_wstunnel</td></tr>
0N/A</table>
0N/A    <p>This directive instructs the server to try to create an asynchronous tunnel.
144N/A    If the current MPM does not support the necessary features, a synchronous
0N/A    tunnel is used.</p>
0N/A
0N/A</div>
0N/A<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0N/A<div class="directive-section"><h2><a name="ProxyWebsocketAsyncDelay" id="ProxyWebsocketAsyncDelay">ProxyWebsocketAsyncDelay</a> <a name="proxywebsocketasyncdelay" id="proxywebsocketasyncdelay">Directive</a></h2>
641N/A<table class="directive">
641N/A<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>
0N/A<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyWebsocketAsyncDelay <var>num</var>[ms]</code></td></tr>
0N/A<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyWebsocketAsyncDelay 0</code></td></tr>
0N/A<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0N/A<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0N/A<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_wstunnel</td></tr>
0N/A</table>
144N/A    <p>If <code class="directive">ProxyWebsocketAsync</code> is enabled, this directive
144N/A    controls how long the server synchronously waits for more data.</p>
144N/A
0N/A</div>
0N/A<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0N/A<div class="directive-section"><h2><a name="ProxyWebsocketIdleTimeout" id="ProxyWebsocketIdleTimeout">ProxyWebsocketIdleTimeout</a> <a name="proxywebsocketidletimeout" id="proxywebsocketidletimeout">Directive</a></h2>
0N/A<table class="directive">
0N/A<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>
0N/A<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyWebsocketIdleTimeout <var>num</var>[ms]</code></td></tr>
641N/A<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyWebsocketIdleTimeout 0</code></td></tr>
641N/A<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0N/A<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0N/A<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_wstunnel</td></tr>
0N/A</table>
0N/A    <p>This directive imposes a maximum amount of time for the tunnel to be
0N/A    left open while idle.</p>
144N/A
0N/A</div>
0N/A</div>
0N/A<div class="bottomlang">
0N/A<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_wstunnel.html" title="English">&nbsp;en&nbsp;</a></p>
0N/A</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&amp;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>
0N/A<script type="text/javascript"><!--//--><![CDATA[//><!--
0N/Avar comments_shortname = 'httpd';
0N/Avar comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_wstunnel.html';
0N/A(function(w, d) {
0N/A    if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
0N/A        d.write('<div id="comments_thread"><\/div>');
0N/A        var s = d.createElement('script');
0N/A        s.type = 'text/javascript';
0N/A        s.async = true;
0N/A        s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
0N/A        (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
0N/A    }
0N/A    else {
0N/A        d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
0N/A    }
0N/A})(window, document);
0N/A//--><!]]></script></div><div id="footer">
0N/A<p class="apache">Copyright 2014 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>
0N/A<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[//><!--
0N/Aif (typeof(prettyPrint) !== 'undefined') {
0N/A    prettyPrint();
0N/A}
0N/A//--><!]]></script>
0N/A</body></html>