Backport: Add new protocol for ChannelHandler to get buffered bytes in the channel handler (#2918) #2982
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nel handler (apple#2918) Add new protocol to get buffered bytes from `ChannelHandler`s and `ChannelPipeline` API to query the buffered bytes from `ChannelHandler`s ### Motivation: In apple#2849, a new `ChannelOption` is introduced to retrieve the number of buffered outbound bytes in a `Channel`. However, this solution does not account for bytes that may be buffered within individual `ChannelHandler`s. This PR builds on apple#2849 by adding functionality to audit buffered bytes residing in `ChannelHandler`s and exposing this information through new `ChannelPipeline` APIs. ### Modifications: - Two new protocols for `ChannelHandler` to audit buffered bytes for inbound and outbound. - `NIOOutboundByteBufferingChannelHandler` - `NIOInboundByteBufferingChannelHandler` - New `ChannelPipeline` APIs - outboundBufferedBytes() - outboundBufferedBytes(in: ChannelHandlerContext) (only in `syncOperations`) - inboundBufferedBytes() - inboundBufferedBytes(in: ChannelHandlerContext) (only in `syncOperations`) ### Result: Users can now easily query the amount of bytes buffered in `ChannelHandler`s using the new `ChannelPipeline` APIs, enhancing the visibility of `ChannelHandler` performance. --------- Co-authored-by: Cory Benfield <[email protected]> (cherry picked from commit 9356598)
FranzBusch
approved these changes
Nov 21, 2024
Lukasa
merged commit d48b9dd
into
apple:sendable-backport-branch
42 of 44 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a backport of #2918.
Add new protocol to get buffered bytes from
ChannelHandlers andChannelPipelineAPI to query the buffered bytes fromChannelHandlersMotivation:
In #2849, a new
ChannelOptionis introduced to retrieve the number of buffered outbound bytes in aChannel. However, this solution does not account for bytes that may be buffered within individualChannelHandlers. This PR builds on #2849 by adding functionality to audit buffered bytes residing inChannelHandlers and exposing this information through newChannelPipelineAPIs.Modifications:
ChannelHandlerto audit buffered bytes for inbound and outbound.NIOOutboundByteBufferingChannelHandlerNIOInboundByteBufferingChannelHandlerChannelPipelineAPIssyncOperations)syncOperations)Result:
Users can now easily query the amount of bytes buffered in
ChannelHandlers using the newChannelPipelineAPIs, enhancing the visibility ofChannelHandlerperformance.Co-authored-by: Cory Benfield [email protected]
(cherry picked from commit 9356598)