Skip to content

Document Apache HTTP implementations #528

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 implementations #528

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
5e0718d
Document Apache HTTP implementations
jonathanpeppers Aug 15, 2026
6bd10b6
Clarify no-reuse strategy result
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
110 changes: 55 additions & 55 deletions docs/xml/Org.Apache.Http.Impl/AbstractHttpClientConnection.xml
View file
Open in desktop

Large diffs are not rendered by default.

104 changes: 52 additions & 52 deletions docs/xml/Org.Apache.Http.Impl/AbstractHttpServerConnection.xml
View file
Open in desktop

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions docs/xml/Org.Apache.Http.Impl/DefaultConnectionReuseStrategy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Determines whether an HTTP connection can be reused according to the default rules.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -67,7 +67,7 @@
</Attributes>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the DefaultConnectionReuseStrategy class.</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 @@ -88,9 +88,9 @@
<Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
</Parameters>
<Docs>
<param name="javaReference">To be added.</param>
<param name="transfer">To be added.</param>
<summary>To be added.</summary>
<param name="javaReference">The JNI reference for the Java object.</param>
<param name="transfer">The ownership transfer for the JNI reference.</param>
<summary>Initializes a managed wrapper for an existing Java object.</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 Expand Up @@ -119,9 +119,9 @@
<Parameter Name="hit" Type="Org.Apache.Http.IHeaderIterator" />
</Parameters>
<Docs>
<param name="hit">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="hit">The iterator over HTTP headers.</param>
<summary>Creates an iterator over the connection header tokens.</summary>
<returns>An iterator over the connection header tokens.</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 @@ -154,8 +154,8 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the JNI peer metadata for this instance.</summary>
<value>The JNI peer metadata for this instance.</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 @@ -188,10 +188,10 @@
<Parameter Name="context" Type="Org.Apache.Http.Protocol.IHttpContext" />
</Parameters>
<Docs>
<param name="response">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="response">The HTTP response to process.</param>
<param name="context">The HTTP context associated with the operation.</param>
<summary>Determines whether the connection can remain open after a response.</summary>
<returns>true if the connection can be reused; otherwise, false.</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 @@ -221,8 +221,8 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the Java class used to dispatch virtual method calls.</summary>
<value>The Java class used to dispatch virtual method calls.</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 @@ -252,12 +252,12 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the managed type used to dispatch virtual method calls.</summary>
<value>The managed type used to dispatch virtual method calls.</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>
</Docs>
</Member>
</Members>
</Type>
</Type>
30 changes: 15 additions & 15 deletions docs/xml/Org.Apache.Http.Impl/DefaultHttpClientConnection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Implements a default HTTP client connection over a socket.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -54,7 +54,7 @@
</Attributes>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the DefaultHttpClientConnection class.</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 @@ -75,9 +75,9 @@
<Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
</Parameters>
<Docs>
<param name="javaReference">To be added.</param>
<param name="transfer">To be added.</param>
<summary>To be added.</summary>
<param name="javaReference">The JNI reference for the Java object.</param>
<param name="transfer">The ownership transfer for the JNI reference.</param>
<summary>Initializes a managed wrapper for an existing Java object.</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 Expand Up @@ -107,9 +107,9 @@
<Parameter Name="params" Type="Org.Apache.Http.Params.IHttpParams" />
</Parameters>
<Docs>
<param name="socket">To be added.</param>
<param name="params">To be added.</param>
<summary>To be added.</summary>
<param name="socket">The socket to bind or use for buffer creation.</param>
<param name="params">The HTTP parameters that configure the connection or buffer.</param>
<summary>Binds this connection to a socket using the supplied HTTP parameters.</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 Expand Up @@ -139,8 +139,8 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the JNI peer metadata for this instance.</summary>
<value>The JNI peer metadata for this instance.</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 @@ -170,8 +170,8 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the Java class used to dispatch virtual method calls.</summary>
<value>The Java class used to dispatch virtual method calls.</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 @@ -201,12 +201,12 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the managed type used to dispatch virtual method calls.</summary>
<value>The managed type used to dispatch virtual method calls.</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>
</Docs>
</Member>
</Members>
</Type>
</Type>
38 changes: 19 additions & 19 deletions docs/xml/Org.Apache.Http.Impl/DefaultHttpRequestFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Creates HTTP request instances using the default request implementation.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -67,7 +67,7 @@
</Attributes>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the DefaultHttpRequestFactory class.</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 @@ -88,9 +88,9 @@
<Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
</Parameters>
<Docs>
<param name="javaReference">To be added.</param>
<param name="transfer">To be added.</param>
<summary>To be added.</summary>
<param name="javaReference">The JNI reference for the Java object.</param>
<param name="transfer">The ownership transfer for the JNI reference.</param>
<summary>Initializes a managed wrapper for an existing Java object.</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 Expand Up @@ -123,8 +123,8 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the JNI peer metadata for this instance.</summary>
<value>The JNI peer metadata for this instance.</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 @@ -156,9 +156,9 @@
<Parameter Name="requestline" Type="Org.Apache.Http.IRequestLine" />
</Parameters>
<Docs>
<param name="requestline">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="requestline">The request line that describes the HTTP request.</param>
<summary>Creates an HTTP request from the supplied request information.</summary>
<returns>The created HTTP request.</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 @@ -191,10 +191,10 @@
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<param name="method">To be added.</param>
<param name="uri">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="method">The HTTP method for the request.</param>
<param name="uri">The request URI.</param>
<summary>Creates an HTTP request from the supplied request information.</summary>
<returns>The created HTTP request.</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 @@ -224,8 +224,8 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the Java class used to dispatch virtual method calls.</summary>
<value>The Java class used to dispatch virtual method calls.</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 @@ -255,12 +255,12 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the managed type used to dispatch virtual method calls.</summary>
<value>The managed type used to dispatch virtual method calls.</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>
</Docs>
</Member>
</Members>
</Type>
</Type>
Loading