Skip to content

fix comment for parameters "end_stream" of decodeData/encodeData. #14620

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

Merged
htuch merged 7 commits into from
Jan 13, 2021
Merged

fix comment for parameters "end_stream" of decodeData/encodeData. #14620

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7a45ea5
Merge pull request #1 from envoyproxy/master
wangfakang Apr 22, 2020
1335354
Merge pull request #2 from envoyproxy/master
wangfakang Aug 11, 2020
446c4b1
Merge pull request #3 from envoyproxy/master
wangfakang Sep 5, 2020
8e7d66a
Merge pull request #4 from envoyproxy/master
wangfakang Sep 11, 2020
7d72ab9
Merge pull request #5 from envoyproxy/master
wangfakang Oct 20, 2020
dd0dba9
Merge pull request #6 from envoyproxy/master
wangfakang Jan 10, 2021
b900803
fix comment for parameters end_stream of decodeData/encodeData.
wangfakang Jan 10, 2021
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
2 changes: 2 additions & 0 deletions include/envoy/http/filter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,7 @@ class StreamDecoderFilter : public StreamFilterBase {
* Called with a decoded data frame.
* @param data supplies the decoded data.
* @param end_stream supplies whether this is the last data frame.
* Further note that end_stream is only true if there are no trailers.
Copy link
Member

@htuch htuch Jan 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this a tautology? I.e. the fact that the data frame is last already means this.

Copy link
Member Author

@wangfakang wangfakang Jan 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this a tautology? I.e. the fact that the data frame is last already means this.

@htuch The data frame is easily mistaken for the body of the request or response. Here's the same issue.

virtual FilterDataStatus decodeData(Buffer::Instance& data, bool end_stream) PURE

Copy link
Member

@htuch htuch Jan 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair, I guess this is clearer.

* @return FilterDataStatus determines how filter chain iteration proceeds.
*/
virtual FilterDataStatus decodeData(Buffer::Instance& data, bool end_stream) PURE;
Expand Down Expand Up @@ -825,6 +826,7 @@ class StreamEncoderFilter : public StreamFilterBase {
* Called with data to be encoded, optionally indicating end of stream.
* @param data supplies the data to be encoded.
* @param end_stream supplies whether this is the last data frame.
* Further note that end_stream is only true if there are no trailers.
* @return FilterDataStatus determines how filter chain iteration proceeds.
*/
virtual FilterDataStatus encodeData(Buffer::Instance& data, bool end_stream) PURE;
Expand Down