O.Announcements 2.0.1

O.Announcements

Overview

The Announcements project provides a mechanism for internal communication within an application through announcements. It includes interfaces for announcement publishers and subscribers, a factory for creating announcement publishers, and an example implementation demonstrating its usage.

Installation

You can install the package via NuGet:

dotnet add package O.Announcements

Or via the NuGet Package Manager Console:

Install-Package O.Announcements

Usage

To use the announcement mechanism, follow these steps:

1. Create a subscriber that implements the ISubscriber interface.
2. Add the subscriber to the AnnouncementFactory.
3. Create a publisher using the AnnouncementFactory.
4. Publish announcements using the publisher.

The AnnouncementCommand class in the Demo project provides an example of how to set up and use the announcement mechanism.

Example

Here is a basic example of how to use the announcement mechanism:

using O.Announcements;
using System;

public class ExampleSubscriber : ISubscriber
{
    public void Receive(Type module, IAnnouncement announcement)
    {
        Console.WriteLine($"Received announcement from {module.Name}: {announcement}");
    }
}

public class Program
{
    public static void Main()
    {
        // Create and add a subscriber
        ExampleSubscriber subscriber = new ExampleSubscriber();
        AnnouncementFactory.AddSubscriber(subscriber);

        // Create a publisher
        IPublisher publisher = AnnouncementFactory.GetPublisher<Program>();

        // Publish an announcement
        publisher.Publish(new StatusAnnouncement(Status.Connected));

        // Clean up
        AnnouncementFactory.RemoveSubscriber(subscriber);
    }
}

public sealed class StatusAnnouncement : IAnnouncement
{
    public Status Status { get; }

    public StatusAnnouncement(Status status)
    {
        Status = status;
    }

    public override string ToString() => Status.ToString();
}

public enum Status
{
    Disconnected,
    Connected,
    Error
}

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Project Links

• Project URL
• Repository URL

Authors

• Oakrey

Tags

• Application internal communication
• Messaging