doc(ITcpSocketClient): update AddDataPackageAdapter documentation #6686
Conversation
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
Reviewer's GuideThis PR refines the ITcpSocketClient documentation by renaming the converter attribute, introducing a new ConfigureDataConverters/ DataPackageAdapter sample for MockEntity, and updating all sample usages of SetDataPackageAdapter to AddDataPackageAdapter (with memory‐leak notes). Sequence diagram for AddDataPackageAdapter usage and callback invocationsequenceDiagram
actor User
participant ITcpSocketClient
participant DataPackageAdapter
participant MockEntity
User->ITcpSocketClient: AddDataPackageAdapter(adapter, OnReceiveAsync)
ITcpSocketClient->DataPackageAdapter: Assign adapter
ITcpSocketClient->User: OnReceiveAsync(MockEntity)
User->ITcpSocketClient: (Optionally) Remove callback to prevent memory leak
Class diagram for updated MockEntity and Data converter configurationclassDiagram
class MockEntity {
+byte[]? Header
+byte[]? Body
}
class DataTypeConverter {
+Type: Type
}
class DataPropertyConverterAttribute {
+Type: Type
+Offset: int
+Length: int
}
MockEntity <|-- DataTypeConverter
MockEntity "1" o-- "*" DataPropertyConverterAttribute: property converters
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation for the ITcpSocketClient interface, specifically changing method references from SetDataPackageAdapter to AddDataPackageAdapter and adds new configuration examples. The changes include localized content updates, code sample corrections, and package version updates.
- Updated method references from
SetDataPackageAdaptertoAddDataPackageAdapteracross documentation - Added new configuration examples for data type converters using
ConfigureDataConverters - Updated package references to newer versions
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/BootstrapBlazor.Server/Locales/zh-CN.json | Added Chinese localization for new configuration section |
| src/BootstrapBlazor.Server/Locales/en-US.json | Added English localization for new configuration section |
| src/BootstrapBlazor.Server/Components/Samples/Sockets/DataEntities.razor | Corrected attribute name and added configuration example |
| src/BootstrapBlazor.Server/Components/Samples/Sockets/Adapters.razor.cs | Updated method reference in comments |
| src/BootstrapBlazor.Server/Components/Samples/Sockets/Adapters.razor | Updated method reference and added memory leak warning |
| src/BootstrapBlazor.Server/Components/Samples/SocketFactories.razor | Updated method reference and added memory leak prevention comment |
| src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj | Updated package versions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| <Pre>// 实战中可以使用 ITcpSocketClient 扩展方法 SetDataPackageAdapter 简化代码 | ||
| _client.SetDataPackageAdapter(_dataAdapter, UpdateReceiveLog);</Pre> | ||
| <Pre>// 实战中可以使用 ITcpSocketClient 扩展方法 AddDataPackageAdapter 简化代码 | ||
| // 如果 _client 实例在当前页面不销毁时，切记使用 AddDataPackageAdapter 移除当前页面加载的 UpdateReceiveLog 回调方法避免内存泄露 |
There was a problem hiding this comment.
The comment mentions using 'AddDataPackageAdapter' to remove a callback method, but 'AddDataPackageAdapter' is typically used to add adapters. The comment should reference the correct method name for removing adapters, likely 'RemoveDataPackageAdapter'.
Suggested change
| // 如果 _client 实例在当前页面不销毁时，切记使用 AddDataPackageAdapter 移除当前页面加载的 UpdateReceiveLog 回调方法避免内存泄露 | |
| // 如果 _client 实例在当前页面不销毁时，切记使用 RemoveDataPackageAdapter 移除当前页面加载的 UpdateReceiveLog 回调方法避免内存泄露 |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6686 +/- ##
=========================================
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 was referenced Sep 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 #6685
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Update ITcpSocketClient AddDataPackageAdapter documentation by replacing obsolete methods with the new generic overload, adding guidance to avoid memory leaks, and introducing a demo for configuring custom data converters.
Documentation: