PurpleSofa 0.2.0

dotnet add package PurpleSofa --version 0.2.0
NuGet\Install-Package PurpleSofa -Version 0.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PurpleSofa" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PurpleSofa --version 0.2.0
#r "nuget: PurpleSofa, 0.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PurpleSofa as a Cake Addin
#addin nuget:?package=PurpleSofa&version=0.2.0

// Install PurpleSofa as a Cake Tool
#tool nuget:?package=PurpleSofa&version=0.2.0

PurpleSofa - C# .NET async tcp server & client

nuget .NET CI codecov License

feature

PurpleSofa is 'Asynchronous Programming Model (APM)' socket wrapper library,
with 'Task-based Asynchronous Pattern (TAP)' at callback methods.
Otherwise, APM and TAP mixed.
Sync methods (OnOpen, OnMessage and OnClose) are disallowed for async override.
If you want to use 'async', Async methods (OnOpenAsync, OnMessageAsync and OnCloseAsync) are override with 'UseAsyncCallback = true'.

  • Callback for
    • 'OnOpen or OnOpenAsync' (accepted or connected)
    • 'OnMessage or OnMessageAsync' (received)
    • 'OnClose or OnCloseAsync' (received none).
  • Can store user value in session.
  • Check timeout at regular intervals by last receive time. It's useful to detect 'half close'.
  • 'OnClose or OnCloseAsync' execution is taken via queue in order to avoid simultaneously many 'close'.

how to use

callback (sync)

public class Callback : PsCallback
{
    private const string Key = "inc";
    
    public override void OnOpen(PsSession session)
    {
        Console.WriteLine($"OnOpen {session}");
        session.SetValue(Key, 0);
        session.ChangeIdleMilliSeconds(5000);

        int inc = session.GetValue<int>(Key);
        session.Send($"inc: {inc}");
    }

    public override void OnMessage(PsSession session, byte[] message)
    {
        Console.WriteLine($"OnMessage {session} {Encoding.UTF8.GetString(message)}");
        int inc = session.GetValue<int>(Key);
        inc++;
        session.SetValue(Key, inc);
        session.Send($"inc: {inc}");
        if (inc > 3) session.Close();
    }

    public override void OnClose(PsSession session, PsCloseReason closeReason)
    {
        session.ClearValue(Key);
        int inc = session.GetValue<int>(Key);
        Console.WriteLine($"OnClose {session} {closeReason}, inc:{inc}");
    }
}

callback (async)

public class AsyncCallback : PsCallback
{
    private const string Key = "inc";

    public override bool UseAsyncCallback { get; init; } = true;

    public override async Task OnOpenAsync(PsSession session)
    {
        Console.WriteLine($"OnOpen {session}");
        session.SetValue(Key, 0);
        session.ChangeIdleMilliSeconds(5000);

        int inc = session.GetValue<int>(Key);
        await session.SendAsync($"inc: {inc}");
    }

    public override async Task OnMessageAsync(PsSession session, byte[] message)
    {
        Console.WriteLine($"OnMessage {session} {Encoding.UTF8.GetString(message)}");
        int inc = session.GetValue<int>(Key);
        inc++;
        session.SetValue(Key, inc);
        await session.SendAsync($"inc: {inc}");
        if (inc > 3) session.Close();
    }

    public override Task OnCloseAsync(PsSession session, PsCloseReason closeReason)
    {
        session.ClearValue(Key);
        int inc = session.GetValue<int>(Key);
        Console.WriteLine($"OnClose {session} {closeReason}, inc:{inc}");
        return Task.CompletedTask;
    }
}

for server (ip v4)

public static void Main(string[] args)
{
    var server = new PsServer(new Callback());
    server.Start();
    server.WaitFor();
    // --- another thread
    // server.Shutdown();
}

for client (ip v4)

public static void Main(string[] args)
{
    var client = new PsClient(new Callback(), "127.0.0.1", 8710);
    client.Connect();
    // ...
    client.Disconnect();
}

for server (ip v6)

public static void Main(string[] args)
{
    var server = new PsServer(new Callback())
    {
        SocketAddressFamily = PsSocketAddressFamily.Ipv6
    };
    server.Start();
    server.WaitFor();
    // --- another thread
    // server.Shutdown();
}
  • Ipv4 socket is treated as ipv6 socket.
  • If host address 0.0.0.0, changed to ::.

for client (ip v6)

public static void Main(string[] args)
{
    var client = new PsClient(new Callback(), PsSocketAddressFamily.Ipv6, "::1", 8710);
    // Below is no problem
    // var client = new PsClient(new Callback(), "127.0.0.1", 8710);
    client.Connect();
    // ...
    client.Disconnect();
}
  • Ipv4 socket is treated as ipv6 socket.
  • If server is listening on ipv6, client is enable to connect to server like v4.

for multi client (ip v4, v6)

var multiClient = new PsMultiClient(new Callback());
multiClient.InitBundle();
for (int i = 0; i < 3; i++)
{
    // assume that server listening on 8710, 8711, 8712
    var clientConnection = multiClient.Connect("127.0.0.1", 8710 + i);
    // ip v6
    // var clientConnection = multiClient.Connect(PsSocketAddressFamily.Ipv6, "::1", 8710 + i);
    :
    multiClient.Disconnect(clientConnection);
}
multiClient.DestroyBundle();
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.
  • net7.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on PurpleSofa:

Package Downloads
FluentNetting

Fluent forwarded server.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.2.0 142 4/15/2024
0.1.1 411 12/8/2023
0.1.0 452 9/5/2023
0.0.9 614 1/3/2023
0.0.8 616 12/20/2022
0.0.7 718 12/12/2022
0.0.6 956 1/24/2022
0.0.5 929 1/13/2022
0.0.4 595 12/21/2021
0.0.3 619 12/10/2021
0.0.2 667 12/2/2021
0.0.1 629 12/2/2021