PicoBus 0.0.5

PicoBus

A lightweight, thread-safe, in-memory event bus for .NET — designed for simplicity, minimal overhead, and zero dependencies.

PicoBus allows decoupled communication between components in your application through an intuitive publish/subscribe model.

🚀 Features

• Light & dependency-free — no external libraries used or required.
• Thread-safe using minimal locking.
• Fluent API for clean and expressive subscriptions.
• Tiny footprint — a few hundred lines of C# code.

📦 Installation

You can include this in your project manually or via a NuGet package (if you publish it):

dotnet add package PicoBus

Or clone and reference it locally:

git clone https://github.com/paulpeters144/PicoBus.git

💡 Quick Start

Here’s a simple example showing how to use PicoBus to publish and subscribe to events:

using PicoBus;

// Create the event bus
var bus = PicoBusFactory.New();

// Define an event type
public class OrderPlaced
{
    public string OrderId { get; set; } = string.Empty;
}

// Subscribe to the event
var subscription = bus.CreateSub<OrderPlaced>();

subscription.OnMessage(order =>
{
    Console.WriteLine($"Order received: {order.OrderId}");
});

// Publish an event
bus.Fire(new OrderPlaced { OrderId = "ORD-001" });

// Unsubscribe when done
subscription.Dispose();

Output:

Order received: ORD-001

⚙️ API Overview

IEventBus

Subscription<TEvent>

🧩 Thread Safety

PicoBus ensures safe concurrent publishing and subscribing across multiple threads.

🧹 Lifecycle Management

Each subscription is automatically tracked.
When you call Dispose() on a Subscription<TEvent>, it:

1. Sets IsActive to false.
2. Removes the subscription from the internal dictionary.

This ensures your application won't leak handlers over time.

🧪 Example: Multiple Subscribers

// Define the event as a simple, immutable record
public record StatusUpdate(string NewStatus);

var bus = PicoBusFactory.New();
var statusEvent = new StatusUpdate("System Online");

// Handler A subscribes and processes the event
var serviceSub1 = bus.CreateSub<StatusUpdate>();
serviceSub1.OnMessage(e => 
{
    Console.WriteLine($"[Service 1] Received: {e.NewStatus}");
});

// Handler B subscribes and processes the same event
var serviceSub2 = bus.CreateSub<StatusUpdate>();
serviceSub2.OnMessage(e => 
{
    Console.WriteLine($"[Service 2] Logging change...");
});

// Publish the single event
bus.Fire(statusEvent);

Output:

[Service 1] Received: System Online
[Service 2] Logging change...

🧠 Design Philosophy

PicoBus is intentionally minimalist — designed for small services, background workers, and local message-passing between components where introducing a full-blown event system (like MediatR, MassTransit, or Kafka) would be excessive.

It’s not meant to replace distributed message buses — it’s a micro bus for in-memory, single-process event delivery.

📄 License

MIT License

Copyright (c) 2025 Paul Q. Peters

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.