Reviewer's Guide

This 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 usage

classDiagram
    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

• doc(ITcpSocketClient): update SetDataPackageAdapter documentation #6680: The PR updates the SetDataPackageAdapter documentation and adds new sample code demonstrating its usage, directly addressing the issue.
• doc(ITcpSocketClient): update SetDataPackageAdapter documentation #6680: The PR updates DataPackageAdapter and SetDataPackageAdapter documentation, which directly addresses the issue's request to update DataPackageAdapter docs and ReceiveAsync comments.
• doc(ITcpSocketClient): update SetDataPackageAdapter documentation #6680: The PR updates DataPackageAdapter initialization and adds documentation for the SetDataPackageAdapter method, which directly contributes to the DataAdapter documentation requested by the issue.

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

@@            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.

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.