fix: Make NetworkManager.Shutdown idempotent #1877
Merged
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.
If calling
Shutdown
on aNetworkManager
that's already shut down, them_ShuttingDown
flag would still be set to true. But if theNetworkManager
is not running thenShutdownInternal
won't get an opportunity to run and clear that flag until the next time theNetworkManager
is started.The result is that calling
Shutdown
on aNetworkManager
that's not running will cause an immediate shutdown the next time it does run. That's unlikely to be the desired behavior here.The fix is to not set
m_ShuttingDown
if theNetworkManager
is not running. This makesShutdown
idempotent; calling it again multiple times produces no effect.Changelog
Shutdown
on aNetworkManager
that was already shut down would cause an immediate shutdown the next time it was started (basically the fix makesShutdown
idempotent).Testing and Documentation