RickDotNet.Apollo 0.2.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package RickDotNet.Apollo --version 0.2.0
NuGet\Install-Package RickDotNet.Apollo -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="RickDotNet.Apollo" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add RickDotNet.Apollo --version 0.2.0
#r "nuget: RickDotNet.Apollo, 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 RickDotNet.Apollo as a Cake Addin
#addin nuget:?package=RickDotNet.Apollo&version=0.2.0

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

Apollo

Apollo is a lightweight, high-performance messaging platform built on top of the NATS messaging system. It is designed to provide developers with a simple yet powerful way to incorporate flexible architectures into their .NET applications. With Apollo, you can easily handle events, commands, and requests with minimal configuration, while benefiting from the speed and scalability of NATS.

Planned Features

  • Simple Configuration: Set up your messaging handlers and publishers with just a few lines of code.
  • Auto-wiring of Consumers: Apollo automatically discovers and wires up your message handlers, making it easy to scale your system.
  • Integration with .NET Core: Designed to work seamlessly with the .NET Core dependency injection system.
  • High Throughput: Leverages the performance of NATS to handle high volumes of messages efficiently.
  • Flexible Serialization: Supports various serialization formats to suit your needs.
  • Scalability: Scales horizontally as your application grows, thanks to the underlying NATS infrastructure.
  • Resilience: Built-in fault tolerance and message retry mechanisms to ensure reliable message delivery.

Getting Started

To get started with Apollo, you'll need to have a running instance of NATS. You can find instructions on setting up NATS here.

Current Usage

The API is in rapid design right now. This is the current usage.

Endpoint Host

var builder = Host.CreateApplicationBuilder(args);

var config = ApolloConfig.Default;

builder.Services.AddApollo(
    config,
    apollo => apollo.WithEndpoints(endpoints => endpoints.AddEndpoint<TestEndpoint>()));

return builder.Build();

Endpoint

public record TestEvent(string Message) : IEvent;

// EndpointBase is optional, but provides access to the MesssageContext
public class TestEndpoint : EndpointBase, IListenFor<TestEvent>
{
    private readonly ILogger<TestEndpoint> logger;

    public TestEndpoint(ILogger<TestEndpoint> logger)
    {
        this.logger = logger;
    }
    public Task HandleAsync(TestEvent message, CancellationToken cancellationToken = default)
    {
        logger.LogInformation("TestEndpoint Received: {Message}", message.Message);
        logger.LogInformation("Subject: {Subject}", Context.Subject);
        logger.LogInformation("Source: {Source}", Context.Source);
        logger.LogInformation("ReplyTo: {ReplyTo}", Context.ReplyTo);
        Context.Headers.ToList()
            .ForEach(x => logger.LogInformation("Header: {Key}={Value}", x.Key, x.Value));

        return Task.FromResult(true);
    }
}

External Publisher

var config = ApolloConfig.Default;

var builder = Host.CreateApplicationBuilder(args);
builder.Services
    .AddApollo(config, x=>x.WithEndpoints());

var host = builder.Build();
var publisherFactory = host.Services.GetRequiredService<IPublisherFactory>();

var remoteDispatcher = publisherFactory.CreatePublisher("TestEndpoint");
await remoteDispatcher.BroadcastAsync(new TestEvent("Hello, World!"),default);

public record TestEvent(string Message) : IEvent;

Local Publisher

var localPublisher = publisherFactory.CreatePublisher(nameof(TestEndpoint), PublisherType.Local);
localPublisher.BroadcastAsync(new TestEvent("Hello, World!"), cancellationToken);

NATS Cli

nats pub apollo.default.testendpoint.testevent "{""message"":""Hello, World!""}"

HTTP

POST https://localhost:7199/endpoints/apollo.default.testendpoint.testevent
Accept: application/json
Content-Type: application/json

{
  "message": "Hello, World!"
}
Product Compatible and additional computed target framework versions.
.NET 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.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on RickDotNet.Apollo:

Package Downloads
RickDotNet.Apollo.Lock

Distributed messaging built on top of NATS.

RickDotNet.Apollo.Caching

Distributed messaging built on top of NATS.

RickDotNet.Apollo.Messaging

Distributed messaging built on top of NATS.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.2.1 42 4/27/2024
0.2.0 111 4/13/2024
0.1.1 118 3/24/2024
0.1.0 95 3/20/2024
0.0.5 82 3/10/2024
0.0.4 90 3/8/2024
0.0.3 102 3/3/2024
0.0.2-preview1 80 1/20/2024
0.0.1 156 1/8/2024
0.0.1-preview2 63 1/8/2024
0.0.1-preview 70 1/8/2024