Nixie 0.0.1-alpha

Nyx: A Lightweight Actor Model Implementation for C#/.NET

Overview

Nyx is a lightweight, high-performance implementation of the actor model tailored for the latest versions of C#/.NET. Developed with a focus on type safety, Nyx provides strongly-typed actors and takes full advantage of nullable support, thereby promoting a reduced error-prone codebase and bolstering performance. Built atop the Task Parallel Library (TPL) provided by .NET, it manages the lifecycle of actors diligently, ensuring a seamless and efficient concurrent programming experience.

Features

• Strongly-Typed Actors: Ensuring that your actor interactions are type-safe and as per expectations.
• Nullable Support: Full support for nullability in line with the latest C# features, ensuring your code is robust and safeguarded against null reference issues.
• Lifecycle Management: Nyx handles the meticulous management of actor lifecycle, allowing developers to focus on implementing logic.
• High Performance: Thanks to being lightweight and leveraging the powerful TPL, Nyx ensures that your actor systems are both scalable and performant.
• Less Error Prone: The strongly-typed nature and nullability checks inherently make your actor system more reliable and resilient.
• Built on TPL: Make the most out of the robust, scalable, and performant asynchronous programming features offered by TPL.

Getting Started

Prerequisites

• .NET SDK 6.0 or later
• A suitable IDE (e.g., Visual Studio, Visual Studio Code, or Rider)

Installation

To install Nyx into your C#/.NET project, you can use the .NET CLI or the NuGet Package Manager.

Using .NET CLI

dotnet add package Nyx --version [version_number]

Using NuGet Package Manager

Search for Nyx and install it from the NuGet package manager UI, or use the Package Manager Console:

Install-Package Nyx -Version [version_number]

Usage

Here's a basic example to get you started with Nixie. More comprehensive documentation and usage examples can be found in the /docs folder:

using Nyx;

public class GreetMessage
{
    public string Greeting { get; }

    public GreetMessage(string greeting)
    {
        Greeting = greeting;
    }
}

public class GreeterActor : IActor<GreetMessage>
{    
    public FireAndForgetActor(IActorContext _)
    {

    }

    public async Task Receive(GreetMessage message)
    {
        Console.WriteLine("Message: {0}", message.Greeting);
    }
}

var system = new ActorSystem();

var greeter = system.Create<GreeterActor, GreetMessage>();

greeter.Send(new GreetMessage("Hello, Nyx!"));

Contribution

Nyx is an open-source project, and contributions are heartily welcomed! Whether you are looking to fix bugs, add new features, or improve documentation, your efforts and contributions will be appreciated. Check out the CONTRIBUTING.md file for guidelines on how to get started with contributing to Nixie.

License

Nyx is released under the MIT License.

Acknowledgements

Sincere thanks to all contributors and the C#/.NET community for the continual support and inspiration.

Let's build robust and efficient actor systems with Nyx! 🚀