Skip to content
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.

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

correct the doc about unactivated stream and add test #460

Merged
merged 2 commits into from
Dec 21, 2023
Merged

Conversation

TingDaoK
Copy link
Contributor

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@@ -188,13 +188,14 @@ typedef int(aws_http_on_incoming_request_done_fn)(struct aws_http_stream *stream
/**
* Invoked when request/response stream is completely destroyed.
* This may be invoked synchronously when aws_http_stream_release() is called.
* This is invoked even if the stream is never activated.
* This will not be invoked if the stream is never activated.
Copy link
Contributor

Choose a reason for hiding this comment

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

if we don't invoke it on unactivated streams, is the the line above still true?

This may be invoked synchronously when aws_http_stream_release() is called.

Copy link
Contributor

Choose a reason for hiding this comment

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

I was wondering how this comment ever got here. Looks like I suggested it for the destroy_fn when the destroy_fn was added to the API, but you accidentally added it to the complete_fn instead.
#390 (comment)

Copy link
Contributor

@graebm graebm Dec 21, 2023

Choose a reason for hiding this comment

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

The docs for aws_http_on_stream_complete_fn should go back to what they used to be:

/**
 * Invoked when a request/response stream is complete, whether successful or unsuccessful
 * This is always invoked on the HTTP connection's event-loop thread.
 * This will not be invoked if the stream is never activated.
 */

@TingDaoK TingDaoK merged commit 2f07551 into main Dec 21, 2023
35 checks passed
@TingDaoK TingDaoK deleted the unactivate branch December 21, 2023 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants