SuperSocket.WebSocket 2.0.2

Release Note: SuperSocket 2.0.2

Overview

SuperSocket 2.0.2 is a major update that builds upon the foundation of v2.0.1, introducing significant performance improvements, enhanced API flexibility, and comprehensive bug fixes. This release focuses on optimizing data processing, improving dependency injection capabilities, and enhancing overall stability.

Key Improvements

Performance Enhancements

Optimized Extensions for Data Processing

• Added LittleEndian methods for efficient byte order conversions
• Optimized BigEndian performance with improved algorithms in Extensions.cs
• Enhanced SequenceReader extensions with comprehensive test coverage
• Improved memory efficiency and reduced allocations in data processing pipelines

Method Naming Optimizations

• Optimized method naming conventions across connection classes for better clarity
• Improved readability and consistency in the API surface
• Enhanced developer experience with more intuitive method names

Enhanced Dependency Injection Support

Pipeline Filter Constructor Flexibility

• Removed the new() constraint from pipeline filter type parameters
• Enabled full dependency injection support for pipeline filters
• Pipeline filters can now receive services through constructor injection
• Backward compatible with existing pipeline filters that use default constructors

Affected Components

The dependency injection improvements span across:

• ISuperSocketHostBuilder<TReceivePackage> interface
• HostBuilderExtensions methods
• MultipleServerHostBuilder configurations
• SuperSocketHostBuilder static and instance methods

Connection and Session Management Improvements

IDisposable Implementation

• Added IDisposable interfaces to IConnection and IEasyClient
• Improved resource management and cleanup processes
• Enhanced connection lifecycle management

Stability and Bug Fixes

Configuration and Host Builder Fixes

• Fixed application builder compatibility issues
• Resolved problems where non-web application builders couldn't be used as SuperSocket application builders
• Improved host builder extensibility and configuration options

Connection Reliability

• Added ConfigureAwait(false) to SendAsync operations for better performance
• Improved connection handling and error recovery
• Enhanced connection state management and cleanup

Testing and Quality Improvements

Comprehensive Test Coverage

• Added PipelineFilterRegistrationTest for dependency injection scenarios
• Enhanced SequenceReaderExtensionTest with new test cases
• Improved test infrastructure with better base classes
• Added comprehensive WebSocket testing improvements

Code Quality Enhancements

• Added .editorconfig for consistent code formatting
• Improved XML documentation coverage across the codebase
• Enhanced code comments and documentation
• Better code organization and structure

API and Framework Enhancements

Package Management

• Updated project descriptions across all packages
• Enhanced NuGet package metadata
• Improved release note integration in packages
• Better package discovery and documentation

Framework Integration

• Improved .NET host integration capabilities
• Enhanced middleware pipeline flexibility
• Better service container integration
• Improved configuration system compatibility

Breaking Changes

None - This release maintains full backward compatibility with existing SuperSocket 2.x applications.

Migration Guide

For Pipeline Filter Dependencies

If you want to leverage the new dependency injection capabilities for pipeline filters:

// Before: Only default constructors were supported
public class MyPipelineFilter : IPipelineFilter<TextPackageInfo>
{
    public MyPipelineFilter() { } // Required default constructor
}

// After: Constructor injection is now supported
public class MyPipelineFilter : IPipelineFilter<TextPackageInfo>
{
    private readonly ILogger<MyPipelineFilter> _logger;
    private readonly IConfiguration _configuration;

    public MyPipelineFilter(ILogger<MyPipelineFilter> logger, IConfiguration configuration)
    {
        _logger = logger;
        _configuration = configuration;
    }
}

// Register dependencies and use the filter
hostBuilder
    .ConfigureServices((ctx, services) => 
    {
        services.AddSingleton<IMyService, MyService>();
    })
    .AsSuperSocketHostBuilder<TextPackageInfo, MyPipelineFilter>();

Performance Benchmarks

• Data processing improvements: Up to 15% performance improvement in byte order conversions
• Memory allocation reduction: Reduced allocations in high-throughput scenarios
• Connection handling: Improved connection establishment and cleanup performance

Compatibility

• .NET 6.0+: Full support for modern .NET versions
• Platform: Cross-platform support (Windows, Linux, macOS)
• Backward compatibility: 100% compatible with existing SuperSocket 2.x applications
• Dependencies: Compatible with Microsoft.Extensions.* ecosystem

Contributors

• Kerry Jiang (@kerryjiang)
• Copilot (@Copilot)
• hyabean (@hyabean)

Links

• GitHub Repository: https://github.com/kerryjiang/SuperSocket
• Documentation: https://docs.supersocket.net/
• NuGet Packages: https://www.nuget.org/packages?q=SuperSocket
• Release Downloads: https://github.com/kerryjiang/SuperSocket/releases/tag/v2.0.2

Next Steps

• Continue performance optimizations
• Expand documentation and examples
• Enhanced testing coverage
• Community feedback integration

Installation:

dotnet add package SuperSocket --version 2.0.2

Upgrade from previous versions:

dotnet add package SuperSocket --version 2.0.2
# No breaking changes - direct upgrade supported