Moving PooledRecvBufferAllocator from NIOPosix to NIOCore
#3110
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
gjcairo
reviewed
Feb 5, 2025
| @@ -58,7 +61,7 @@ internal struct PooledRecvBufferAllocator { | |||
| } | |||
|
|
|||
| /// Update the capacity of the underlying buffer pool. | |||
| mutating func updateCapacity(to newCapacity: Int) { | |||
| public mutating func updateCapacity(to newCapacity: Int) { | |||
There was a problem hiding this comment.
Can we update the docs for this and the other public methods to include a list of arguments (i.e. the Parameters keyword as in the public init above)?
There was a problem hiding this comment.
I've added the missing documentation. Let me know if you think I should change anything else.
Lukasa
reviewed
Feb 5, 2025
| @@ -12,10 +12,8 @@ | |||
| // | |||
| //===----------------------------------------------------------------------===// | |||
|
|
|||
| import NIOCore | |||
|
|
|||
| /// A receive buffer allocator which cycles through a pool of buffers. | |||
There was a problem hiding this comment.
We should extend this to express when users might want to use this type.
There was a problem hiding this comment.
Is this addition to the comment accurate and sufficient: This type is useful when allocating new buffers for every IO read is expensive or undesirable.?
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.
Moving
PooledRecvBufferAllocatorfrom NIOPosix to NIOCore, making it part of its public interface.Motivation:
We want to introduce the capability of reusing receiving buffers from a pool into swift-nio-transport-services project. To prevent duplicating this functionality there, this change is making the existing functionality from NIO part of its public API.
Modifications:
Moved the type
PooledRecvBufferAllocatorfrom NIOPosix module to NIOCore and turned it into a public type.Result:
PooledRecvBufferAllocatoris part of NIOCore public API.