mirror of
https://github.com/apache/httpd.git
synced 2025-11-12 14:01:05 +03:00
ee7c86455f
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1611430 13f79535-47bb-0310-9956-ffa450edef68
107 lines
3.7 KiB
XML
107 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
|
|
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
|
|
<!-- $LastChangedRevision$ -->
|
|
|
|
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
-->
|
|
|
|
<modulesynopsis metafile="mod_proxy_wstunnel.xml.meta">
|
|
|
|
<name>mod_proxy_wstunnel</name>
|
|
<description>Websockets support module for
|
|
<module>mod_proxy</module></description>
|
|
<status>Extension</status>
|
|
<sourcefile>mod_proxy_wstunnel.c</sourcefile>
|
|
<identifier>proxy_wstunnel_module</identifier>
|
|
<compatibility>Available for unix in version 2.4.5 and later</compatibility>
|
|
|
|
<summary>
|
|
<p>This module <em>requires</em> the service of <module
|
|
>mod_proxy</module>. It provides support for the tunnelling of web
|
|
socket connections to a backend websockets server. The connection
|
|
is automagically upgraded to a websocket connection:</p>
|
|
|
|
<highlight language="config">
|
|
Upgrade: WebSocket
|
|
Connection: Upgrade
|
|
</highlight>
|
|
|
|
|
|
<example><title>Proxying requests to websockets server</title>
|
|
<highlight language="config">
|
|
ProxyPass /ws2/ ws://echo.websocket.org/
|
|
ProxyPass /wss2/ wss://echo.websocket.org/
|
|
</highlight>
|
|
</example>
|
|
|
|
</summary>
|
|
|
|
<seealso><module>mod_proxy</module></seealso>
|
|
|
|
<directivesynopsis>
|
|
<name>ProxyWebsocketAsync</name>
|
|
<description>Instructs this module to try to create an asynchronous tunnel</description>
|
|
<syntax>ProxyWebsocketAsync ON|OFF</syntax>
|
|
<contextlist><context>server config</context>
|
|
<context>virtual host</context>
|
|
</contextlist>
|
|
|
|
<usage>
|
|
<p>This directive instructs the server to try to create an asynchronous tunnel.
|
|
If the current MPM does not support the necessary features, a synchronous
|
|
tunnel is used.</p>
|
|
<note><title>Note</title><p>Async support is experimental and subject
|
|
to change.</p></note>
|
|
</usage>
|
|
</directivesynopsis>
|
|
|
|
<directivesynopsis>
|
|
<name>ProxyWebsocketIdleTimeout</name>
|
|
<description>Sets the maximum amount of time to wait for data on the websockets tunnel</description>
|
|
<syntax>ProxyWebsocketIdleTimeout <var>num</var>[ms]</syntax>
|
|
<default>ProxyWebsocketIdleTimeout 0</default>
|
|
<contextlist><context>server config</context>
|
|
<context>virtual host</context>
|
|
</contextlist>
|
|
|
|
<usage>
|
|
<p>This directive imposes a maximum amount of time for the tunnel to be
|
|
left open while idle.</p>
|
|
</usage>
|
|
</directivesynopsis>
|
|
|
|
<directivesynopsis>
|
|
<name>ProxyWebsocketAsyncDelay</name>
|
|
<description>Sets the amount of time the tunnel waits synchronously for data</description>
|
|
<syntax>ProxyWebsocketAsyncDelay <var>num</var>[ms]</syntax>
|
|
<default>ProxyWebsocketAsyncDelay 0</default>
|
|
<contextlist><context>server config</context>
|
|
<context>virtual host</context>
|
|
</contextlist>
|
|
|
|
<usage>
|
|
<p>If <directive>ProxyWebsocketAsync</directive> is enabled, this directive
|
|
controls how long the server synchronously waits for more data.</p>
|
|
|
|
<note><title>Note</title><p>Async support is experimental and subject
|
|
to change. </p></note>
|
|
|
|
</usage>
|
|
</directivesynopsis>
|
|
</modulesynopsis>
|