Skip to content

Commit

Permalink
Clarify semantics of methods introduced in 64ef517
Browse files Browse the repository at this point in the history
Motivation:

We should better clarify the sementatics related to ownership of ReferenceCounted objects.

Modifications:

Clarify semantics

Result:

Easy to understand documentation
  • Loading branch information
normanmaurer committed Aug 7, 2024
1 parent 64ef517 commit 9efa65c
Showing 1 changed file with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ public static BinaryHttpRequest convert(HttpRequest request, String scheme, Stri
* All {@link HttpHeaders} names of the {@link FullHttpRequest} will be changed to lowercase to be in line with
* the
* <a href="https://www.rfc-editor.org/rfc/rfc9292.html">Binary Representation of HTTP Messages</a> specification.
* This method will take ownership of {@link FullBinaryHttpRequest} and so is responsible for releasing it.
*
* @param request the request.
* @param scheme the scheme
Expand Down Expand Up @@ -104,6 +105,7 @@ public static BinaryHttpResponse convert(HttpResponse response) {
* All {@link HttpHeaders} names of the {@link FullHttpResponse} will be changed to lowercase to be in line with
* the
* <a href="https://www.rfc-editor.org/rfc/rfc9292.html">Binary Representation of HTTP Messages</a> specification.
* This method will take ownership of {@link FullBinaryHttpResponse} and so is responsible for releasing it.
*
* @param response the response.
* @return the created response.
Expand All @@ -124,7 +126,8 @@ public static FullBinaryHttpResponse convert(FullHttpResponse response) {
* All {@link HttpHeaders} names of the {@link LastHttpContent} will be changed to lowercase to be in line with
* the
* <a href="https://www.rfc-editor.org/rfc/rfc9292.html">Binary Representation of HTTP Messages</a> specification.
*
* This method will take ownership of {@link LastHttpContent} and so is responsible for releasing it.
* @param content the last content..
* @return the created content.
*/
Expand Down

0 comments on commit 9efa65c

Please sign in to comment.