-
Notifications
You must be signed in to change notification settings - Fork 10.5k
Introduce the IResettable type. #46426
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,19 @@ | ||||||
| // Licensed to the .NET Foundation under one or more agreements. | ||||||
| // The .NET Foundation licenses this file to you under the MIT license. | ||||||
|
|
||||||
| namespace Microsoft.Extensions.ObjectPool; | ||||||
|
|
||||||
| /// <summary> | ||||||
| /// Defines a method to reset an object to its initial state. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
While others are free to call it, I think it's worth pointing out that this is the only thing that calls it by default. |
||||||
| /// </summary> | ||||||
| public interface IResettable | ||||||
| { | ||||||
| /// <summary> | ||||||
| /// Reset the object to a neutral state, semantically similar to when the object was first constructed. | ||||||
| /// </summary> | ||||||
| /// <returns><see langword="true" /> if the object was able to reset itself, otherwise <see langword="false" />.</returns> | ||||||
| /// <remarks> | ||||||
| /// In general, this method is not expected to be thread-safe. | ||||||
| /// </remarks> | ||||||
| bool TryReset(); | ||||||
geeknoid marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| } | ||||||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,3 @@ | ||
| #nullable enable | ||
| Microsoft.Extensions.ObjectPool.IResettable | ||
| Microsoft.Extensions.ObjectPool.IResettable.TryReset() -> bool |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -69,6 +69,34 @@ public void DefaultObjectPool_Return_RejectedByPolicy() | |||||
| Assert.NotSame(list1, list2); | ||||||
| } | ||||||
|
|
||||||
| [Fact] | ||||||
| public static void DefaultObjectPool_Honors_IResettable() | ||||||
| { | ||||||
| var p = new DefaultObjectPool<Resettable>(new DefaultPooledObjectPolicy<Resettable>()); | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit:
Suggested change
|
||||||
| var r = new Resettable(); | ||||||
|
|
||||||
| r.ResetReturnValue = false; | ||||||
| p.Return(r); | ||||||
| Assert.Equal(1, r.ResetCallCount); | ||||||
| Assert.NotSame(r, p.Get()); | ||||||
|
|
||||||
| r.ResetReturnValue = true; | ||||||
| p.Return(r); | ||||||
| Assert.Equal(2, r.ResetCallCount); | ||||||
| Assert.Same(r, p.Get()); | ||||||
| } | ||||||
|
|
||||||
| private sealed class Resettable : IResettable | ||||||
| { | ||||||
| public int ResetCallCount { get; set; } | ||||||
| public bool ResetReturnValue { get; set; } | ||||||
| public bool TryReset() | ||||||
| { | ||||||
| ResetCallCount++; | ||||||
| return ResetReturnValue; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| private class ListPolicy : IPooledObjectPolicy<List<int>> | ||||||
| { | ||||||
| public List<int> Create() | ||||||
|
|
||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW, this comment became untrue when I revamped the implementation of DefaultObjectPool a little while ago.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#45251 for reference.