granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_wstunnel.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_proxy_wstunnel.xml.meta">
  24
  25 <name>mod_proxy_wstunnel</name>
  26 <description>Websockets support module for
  27 <module>mod_proxy</module></description>
  28 <status>Extension</status>
  29 <sourcefile>mod_proxy_wstunnel.c</sourcefile>
  30 <identifier>proxy_wstunnel_module</identifier>
  31 <compatibility>Available for unix in version 2.4.5 and later</compatibility>
  32
  33 <summary>
  34     <p>This module <em>requires</em> the service of <module
  35     >mod_proxy</module>. It provides support for the tunnelling of web
  36     socket connections to a backend websockets server. The connection
  37     is automagically upgraded to a websocket connection:</p>
  38
  39     <highlight language="config">
  40 Upgrade: WebSocket
  41 Connection: Upgrade
  42     </highlight>
  43
  44
  45     <example><title>Proxying requests to websockets server</title>
  46     <highlight language="config">
  47 ProxyPass /ws2/  ws://echo.websocket.org/
  48 ProxyPass /wss2/ wss://echo.websocket.org/
  49     </highlight>
  50     </example>
  51
  52 </summary>
  53
  54 <seealso><module>mod_proxy</module></seealso>
  55
  56 <directivesynopsis>
  57 <name>ProxyWebsocketAsync</name>
  58 <description>Instructs this module to try to create an asynchronous tunnel</description>
  59 <syntax>ProxyWebsocketAsync ON|OFF</syntax>
  60 <contextlist><context>server config</context>
  61 <context>virtual host</context>
  62 </contextlist>
  63
  64 <usage>
  65     <p>This directive instructs the server to try to create an asynchronous tunnel.
  66     If the current MPM does not support the necessary features, a synchronous
  67     tunnel is used.</p>
  68     <note><title>Note</title><p>Async support is experimental and subject
  69     to change.</p></note>
  70 </usage>
  71 </directivesynopsis>
  72
  73 <directivesynopsis>
  74 <name>ProxyWebsocketIdleTimeout</name>
  75 <description>Sets the maximum amount of time to wait for data on the websockets tunnel</description>
  76 <syntax>ProxyWebsocketIdleTimeout <var>num</var>[ms]</syntax>
  77 <default>ProxyWebsocketIdleTimeout 0</default>
  78 <contextlist><context>server config</context>
  79 <context>virtual host</context>
  80 </contextlist>
  81
  82 <usage>
  83     <p>This directive imposes a maximum amount of time for the tunnel to be
  84     left open while idle.</p>
  85 </usage>
  86 </directivesynopsis>
  87
  88 <directivesynopsis>
  89 <name>ProxyWebsocketAsyncDelay</name>
  90 <description>Sets the amount of time the tunnel waits synchronously for data</description>
  91 <syntax>ProxyWebsocketAsyncDelay <var>num</var>[ms]</syntax>
  92 <default>ProxyWebsocketAsyncDelay 0</default>
  93 <contextlist><context>server config</context>
  94 <context>virtual host</context>
  95 </contextlist>
  96
  97 <usage>
  98     <p>If <directive>ProxyWebsocketAsync</directive> is enabled, this directive
  99     controls how long the server synchronously waits for more data.</p>
 100
 101     <note><title>Note</title><p>Async support is experimental and subject
 102     to change. </p></note>
 103
 104 </usage>
 105 </directivesynopsis>
 106 </modulesynopsis>