Skip to content

Document Apache HTTP connection parameters #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanpeppers wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document Apache HTTP connection parameters #531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4ec842
Document Apache HTTP connection parameters
jonathanpeppers Aug 15, 2026
4da2b6d
Align JNI member documentation
jonathanpeppers Aug 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/xml/Org.Apache.Http.Conn.Params/ConnConnectionParamBean.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<Parameter Name="params" Type="Org.Apache.Http.Params.IHttpParams" />
</Parameters>
<Docs>
<param name="params">To be added.</param>
<param name="params">The HTTP parameters to configure.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -115,8 +115,8 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:Java.Interop.JniPeerMembers" /> instance that provides access to JNI peer-member information for this type.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -145,7 +145,7 @@
<Parameter Name="maxStatusLineGarbage" Type="System.Int32" />
</Parameters>
<Docs>
<param name="maxStatusLineGarbage">To be added.</param>
<param name="maxStatusLineGarbage">The maximum number of ignorable lines before an HTTP response status line.</param>
<summary>
</summary>
<remarks>
Expand Down
12 changes: 6 additions & 6 deletions docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParamBean.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<Parameter Name="params" Type="Org.Apache.Http.Params.IHttpParams" />
</Parameters>
<Docs>
<param name="params">To be added.</param>
<param name="params">The HTTP parameters to configure.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -115,8 +115,8 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:Java.Interop.JniPeerMembers" /> instance that provides access to JNI peer-member information for this type.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -145,7 +145,7 @@
<Parameter Name="connPerRoute" Type="Org.Apache.Http.Conn.Params.ConnPerRouteBean" />
</Parameters>
<Docs>
<param name="connPerRoute">To be added.</param>
<param name="connPerRoute">The lookup object for the maximum number of connections allowed per route.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -178,7 +178,7 @@
<Parameter Name="maxConnections" Type="System.Int32" />
</Parameters>
<Docs>
<param name="maxConnections">To be added.</param>
<param name="maxConnections">The maximum number of connections allowed.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -211,7 +211,7 @@
<Parameter Name="timeout" Type="System.Int64" />
</Parameters>
<Docs>
<param name="timeout">To be added.</param>
<param name="timeout">The timeout, in milliseconds, for retrieving a connection from the connection manager.</param>
<summary>
</summary>
<remarks>
Expand Down
8 changes: 4 additions & 4 deletions docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParams+InterfaceConsts.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Constants inherited from <see cref="T:Org.Apache.Http.Conn.Params.IConnManagerPNames" />.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -44,7 +44,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Defines the maximum number of connections per route.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -70,7 +70,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Defines the maximum number of connections in total.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -96,7 +96,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Defines the timeout, in milliseconds, used when retrieving a managed client connection from the connection manager.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
14 changes: 7 additions & 7 deletions docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParams.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<Docs>
<param name="params">HTTP parameters</param>
<summary>Returns lookup interface for maximum number of connections allowed per route.</summary>
<returns>To be added.</returns>
<returns>The lookup interface for the maximum number of connections allowed per route.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -151,7 +151,7 @@
<Docs>
<param name="params">HTTP parameters</param>
<summary>Gets the maximum number of connections allowed.</summary>
<returns>To be added.</returns>
<returns>The maximum number of connections allowed.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -182,11 +182,11 @@
<Parameter Name="params" Type="Org.Apache.Http.Params.IHttpParams" />
</Parameters>
<Docs>
<param name="params">To be added.</param>
<param name="params">The HTTP parameters.</param>
<summary>Returns the timeout in milliseconds used when retrieving a
<see cref="T:Org.Apache.Http.Conn.IManagedClientConnection" /> from the
<see cref="T:Org.Apache.Http.Conn.IClientConnectionManager" />.</summary>
<returns>To be added.</returns>
<returns>The timeout in milliseconds.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -217,8 +217,8 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:Java.Interop.JniPeerMembers" /> instance that provides access to JNI peer-member information for this type.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -317,7 +317,7 @@
<Parameter Name="timeout" Type="System.Int64" />
</Parameters>
<Docs>
<param name="params">To be added.</param>
<param name="params">The HTTP parameters.</param>
<param name="timeout">the timeout in milliseconds
</param>
<summary>Sets the timeout in milliseconds used when retrieving a
Expand Down
22 changes: 11 additions & 11 deletions docs/xml/Org.Apache.Http.Conn.Params/ConnPerRouteBean.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
<Parameter Name="defaultMax" Type="System.Int32" />
</Parameters>
<Docs>
<param name="defaultMax">To be added.</param>
<param name="defaultMax">The default maximum number of connections allowed per route.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -124,7 +124,7 @@
<Docs>
<summary>
</summary>
<value>To be added.</value>
<value>The default maximum number of connections allowed per route.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -185,10 +185,10 @@
<Parameter Name="route" Type="Org.Apache.Http.Conn.Routing.HttpRoute" />
</Parameters>
<Docs>
<param name="route">To be added.</param>
<param name="route">The HTTP route for which to retrieve the maximum connection count.</param>
<summary>
</summary>
<returns>To be added.</returns>
<returns>The maximum number of connections for the route, or the default maximum when no route-specific value is set.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -226,8 +226,8 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:Java.Interop.JniPeerMembers" /> instance that provides access to JNI peer-member information for this type.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -256,7 +256,7 @@
<Parameter Name="max" Type="System.Int32" />
</Parameters>
<Docs>
<param name="max">To be added.</param>
<param name="max">The default maximum number of connections allowed per route. Must be greater than zero.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -289,8 +289,8 @@
<Parameter Name="max" Type="System.Int32" />
</Parameters>
<Docs>
<param name="route">To be added.</param>
<param name="max">To be added.</param>
<param name="route">The HTTP route for which to set the maximum connection count.</param>
<param name="max">The maximum number of connections allowed for the route. Must be greater than zero.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -329,8 +329,8 @@
</Parameter>
</Parameters>
<Docs>
<param name="map">To be added.</param>
<summary>To be added.</summary>
<param name="map">The map of HTTP routes to their maximum connection counts, or <see langword="null" /> to leave the current values unchanged.</param>
<summary>Replaces the route-specific maximum connection counts.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
12 changes: 6 additions & 6 deletions docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParamBean.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<Parameter Name="params" Type="Org.Apache.Http.Params.IHttpParams" />
</Parameters>
<Docs>
<param name="params">To be added.</param>
<param name="params">The HTTP parameters to configure.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -115,8 +115,8 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:Java.Interop.JniPeerMembers" /> instance that provides access to JNI peer-member information for this type.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -145,7 +145,7 @@
<Parameter Name="defaultProxy" Type="Org.Apache.Http.HttpHost" />
</Parameters>
<Docs>
<param name="defaultProxy">To be added.</param>
<param name="defaultProxy">The default proxy value to set.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -178,7 +178,7 @@
<Parameter Name="route" Type="Org.Apache.Http.Conn.Routing.HttpRoute" />
</Parameters>
<Docs>
<param name="route">To be added.</param>
<param name="route">The forced route value to set.</param>
<summary>
</summary>
<remarks>
Expand Down Expand Up @@ -211,7 +211,7 @@
<Parameter Name="address" Type="Java.Net.InetAddress" />
</Parameters>
<Docs>
<param name="address">To be added.</param>
<param name="address">The local address value to set.</param>
<summary>
</summary>
<remarks>
Expand Down
Loading