You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2016/10/19 11:33:11 UTC

svn commit: r1765582 - in /tomcat/trunk/webapps/docs: changelog.xml config/http.xml config/http2.xml config/project.xml

Author: markt
Date: Wed Oct 19 11:33:11 2016
New Revision: 1765582

URL: http://svn.apache.org/viewvc?rev=1765582&view=rev
Log:
Add HTTP/2 configuration information to the documentation web application.

Added:
    tomcat/trunk/webapps/docs/config/http2.xml   (with props)
Modified:
    tomcat/trunk/webapps/docs/changelog.xml
    tomcat/trunk/webapps/docs/config/http.xml
    tomcat/trunk/webapps/docs/config/project.xml

Modified: tomcat/trunk/webapps/docs/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/changelog.xml?rev=1765582&r1=1765581&r2=1765582&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/trunk/webapps/docs/changelog.xml Wed Oct 19 11:33:11 2016
@@ -124,6 +124,14 @@
       </update>
     </changelog>
   </subsection>
+  <subsection name="Web applications">
+    <changelog>
+      <add>
+        Add HTTP/2 configuration information to the documentation web
+        application. (markt)
+      </add>
+    </changelog>
+  </subsection>
   <subsection name="Other">
     <changelog>
       <add>

Modified: tomcat/trunk/webapps/docs/config/http.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/http.xml?rev=1765582&r1=1765581&r2=1765582&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/http.xml (original)
+++ tomcat/trunk/webapps/docs/config/http.xml Wed Oct 19 11:33:11 2016
@@ -1019,6 +1019,9 @@
      <code>sslImplementationName</code> attribute of the
      <strong>Connector</strong>.</p>
 
+  <p>Additional configuration attributes are available. See the
+  <a href="http2.html">HTTP/2 Upgrade Protocol</a> documentaion for details.</p>
+
   </subsection>
 
   <subsection name="Proxy Support">

Added: tomcat/trunk/webapps/docs/config/http2.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/http2.xml?rev=1765582&view=auto
==============================================================================
--- tomcat/trunk/webapps/docs/config/http2.xml (added)
+++ tomcat/trunk/webapps/docs/config/http2.xml Wed Oct 19 11:33:11 2016
@@ -0,0 +1,137 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  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.
+-->
+<!DOCTYPE document [
+  <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="http2.html">
+
+  &project;
+
+  <properties>
+    <title>The HTTP2 Upgrade Protocol</title>
+  </properties>
+
+<body>
+
+<section name="Table of Contents">
+<toc/>
+</section>
+
+<section name="Introduction">
+
+  <p>The <strong>HTTP Upgrade Protocol</strong> element represents an
+  <strong>Upgrade Protocol</strong> component that supports the HTTP/2 protocol.
+  An instance of this component must be associated with an existing
+  <a href="http.html">HTTP/1.1 Connector</a>.</p>
+
+  <p>HTTP/2 connectors use non-blocking I/O, only utilising a container thread
+  from the thread pool when there is data to read and write. However, because
+  the Servlet API is fundamentally blocking, each HTTP/2 stream requires a
+  dedicated container thread for the duration of that stream.</p>
+
+</section>
+
+
+<section name="Attributes">
+
+  <subsection name="Common Attributes">
+
+  <p>All implementations of <strong>Upgrade Protocol</strong> support the
+  following attributes:</p>
+
+  <attributes>
+
+    <attribute name="className" required="true">
+      <p>This must be <code>org.apache.coyote.http2.Http2Protocol</code>.</p>
+    </attribute>
+
+  </attributes>
+
+  </subsection>
+
+  <subsection name="Standard Implementation">
+
+  <p>The HTTP/2 <strong>Upgrade Protocol</strong> implementation supports the
+  following attributes in addition to the common attributes listed above.</p>
+
+  <attributes>
+
+    <attribute name="initialWindowSize" required="false">
+      <p>Controls the initial size of the flow control window for streams that
+      Tomcat advertises to clients. If not specified, the default value of
+      <code>65535</code> is used.</p>
+    </attribute>
+
+    <attribute name="keepAliveTimeout" required="false">
+      <p>The time, in milliseconds, that Tomcat will wait between HTTP/2 frames
+      before closing the connection. Negative values will be treated as an
+      infinite timeout. If not specified, a default value of <code>-1</code>
+      will be used.</p>
+    </attribute>
+
+    <attribute name="maxConccurentStreamExecution" required="false">
+      <p>The controls the maximum number of streams for any one connection that
+      can be allocated threads from the container thread pool. If more streams
+      are active than threads are avaialble, those streams will have to wait
+      for a stream to become available. If not specified, the default value of
+      <code>200</code> will be used.</p>
+    </attribute>
+
+    <attribute name="maxConccurentStreams" required="false">
+      <p>The controls the maximum number of active streams permitted for any one
+      connection. If a client attempts to open more active streams than this
+      limit, the stream will be reset with a <code>STREAM_REFUSED</code> error.
+      If not specified, the default value of <code>200</code> will be used.</p>
+    </attribute>
+
+    <attribute name="readTimeout" required="false">
+      <p>The time, in milliseconds, that Tomcat will wait for additional data
+      when a partial HTTP/2 frame has been received. Negative values will be
+      treated as an infinite timeout. If not specified, a default value of
+      <code>10000</code> will be used.</p>
+    </attribute>
+
+    <attribute name="writeTimeout" required="false">
+      <p>The time, in milliseconds, that Tomcat will wait to write additional
+      data when an HTTP/2 frame has been partially written. Negative values will
+      be treated as an infinite timeout. If not specified, a default value of
+      <code>10000</code> will be used.</p>
+    </attribute>
+
+  </attributes>
+
+  </subsection>
+
+</section>
+
+<section name="Nested Components">
+
+  <p>This component does not support any nested components.</p>
+
+</section>
+
+
+<section name="Special Features">
+
+  <p>This component does not support any special features.</p>
+
+</section>
+
+</body>
+
+</document>

Propchange: tomcat/trunk/webapps/docs/config/http2.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: tomcat/trunk/webapps/docs/config/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/project.xml?rev=1765582&r1=1765581&r2=1765582&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/project.xml (original)
+++ tomcat/trunk/webapps/docs/config/project.xml Wed Oct 19 11:33:11 2016
@@ -44,7 +44,8 @@
     </menu>
 
     <menu name="Connectors">
-        <item name="HTTP"                  href="http.html"/>
+        <item name="HTTP/1.1"              href="http.html"/>
+        <item name="HTTP/2"                href="http2.html"/>
         <item name="AJP"                   href="ajp.html"/>
     </menu>
 



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org