doc(ITcpSocketClient): update SetDataPackageAdapter documentation#6681
Merged
doc(ITcpSocketClient): update SetDataPackageAdapter documentation#6681
Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis pull request refactors the sample implementation by simplifying DataPackageAdapter instantiation and callback registration, showcases the SetDataPackageAdapter extension method in documentation, and converts the UpdateReceiveLog async handler to ValueTask for consistency. Class diagram for updated DataPackageAdapter usageclassDiagram
class Adapters {
- CancellationTokenSource _connectTokenSource
- CancellationTokenSource _sendTokenSource
- CancellationTokenSource _receiveTokenSource
- DataPackageAdapter _dataAdapter
- bool _useDataAdapter
+ OnInitialized()
+ OnConnectAsync()
+ OnReceivedAsync(ReadOnlyMemory<byte> data)
+ UpdateReceiveLog(ReadOnlyMemory<byte> data)
}
class DataPackageAdapter {
+ ReceivedCallBack
+ DataPackageHandler
}
class FixLengthDataPackageHandler {
+ FixLengthDataPackageHandler(int length)
}
Adapters --> DataPackageAdapter : uses
DataPackageAdapter --> FixLengthDataPackageHandler : uses
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6681 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 739 739
Lines 31698 31698
Branches 4462 4462
=========================================
Hits 31698 31698
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This was referenced Aug 29, 2025
This was referenced Sep 8, 2025
This was referenced Sep 16, 2025
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
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.
Link issues
fixes #6680
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Update ITcpSocketClient sample to simplify DataPackageAdapter setup and demonstrate using SetDataPackageAdapter extension.
Enhancements:
Documentation: