IMessenger.cs

using System;
using System.Collections.Generic;

namespace Messenger
{
    public interface IMessenger
    {
        /// <summary>
        /// Subscribe to a message type with the given destination and delivery action.
        /// </summary>
        /// <typeparam name="TMessage">Type of message</typeparam>
        /// <param name="deliveryAction">Action to invoke when message is delivered</param>
        /// <param name="reference">Use a strong or weak reference to the deliveryAction</param>
        /// <param name="tag">An optional tag to include with this subscription</param>
        /// <returns>MessageSubscription used to unsubscribing</returns>
        MessengerSubscriptionToken Subscribe<TMessage>(Action<TMessage> deliveryAction, MessengerReference reference = MessengerReference.Weak, string tag = null)
            where TMessage : MessengerMessage;

        /// <summary>
        /// Subscribe to a message type with the given destination and delivery action.
        /// This subscription always invokes the delivery Action on the Main thread.
        /// </summary>
        /// <typeparam name="TMessage">Type of message</typeparam>
        /// <param name="deliveryAction">Action to invoke when message is delivered</param>
        /// <param name="reference">Use a strong or weak reference to the deliveryAction</param>
        /// <param name="tag">An optional tag to include with this subscription</param>
        /// <returns>MessageSubscription used to unsubscribing</returns>
        MessengerSubscriptionToken SubscribeOnMainThread<TMessage>(Action<TMessage> deliveryAction, MessengerReference reference = MessengerReference.Weak, string tag = null)
             where TMessage : MessengerMessage;

        /// <summary>
        /// Subscribe to a message type with the given destination and delivery action.
        /// This subscription always invokes the delivery Action called on a threadpool thread.
        /// </summary>
        /// <typeparam name="TMessage">Type of message</typeparam>
        /// <param name="deliveryAction">Action to invoke when message is delivered</param>
        /// <param name="reference">Use a strong or weak reference to the deliveryAction</param>
        /// <param name="tag">An optional tag to include with this subscription</param>
        /// <returns>MessageSubscription used to unsubscribing</returns>
        MessengerSubscriptionToken SubscribeOnThreadPoolThread<TMessage>(Action<TMessage> deliveryAction, MessengerReference reference = MessengerReference.Weak, string tag = null)
             where TMessage : MessengerMessage;

        /// <summary>
        /// Unsubscribe from a particular message type.
        /// </summary>
        /// <typeparam name="TMessage">Type of message</typeparam>
        /// <param name="mvxSubscriptionId">Subscription to remove</param>
        void Unsubscribe<TMessage>(MessengerSubscriptionToken subscriptionId)
            where TMessage : MessengerMessage;

        /// <summary>
        /// Has subscriptions for TMessage
        /// </summary>
        /// <typeparam name="TMessage"></typeparam>
        /// <returns></returns>
        bool HasSubscriptionsFor<TMessage>()
             where TMessage : MessengerMessage;

        /// <summary>
        /// Number of subscriptions for TMessage
        /// </summary>
        /// <typeparam name="TMessage"></typeparam>
        /// <returns></returns>
        int CountSubscriptionsFor<TMessage>()
             where TMessage : MessengerMessage;

        /// <summary>
        /// Has subscriptions for TMessage with a tag value of tag
        /// </summary>
        /// <typeparam name="TMessage"></typeparam>
        /// <param name="tag">An optional tag to include with this subscription</param>
        /// <returns></returns>
        bool HasSubscriptionsForTag<TMessage>(string tag)
             where TMessage : MessengerMessage;

        /// <summary>
        /// Number of subscriptions for TMessage with a tag value of tag
        /// </summary>
        /// <typeparam name="TMessage"></typeparam>
        /// <param name="tag">An optional tag to include with this subscription</param>
        /// <returns></returns>
        int CountSubscriptionsForTag<TMessage>(string tag)
             where TMessage : MessengerMessage;

        /// <summary>
        /// Get all the tags (including nulls) for subscriptions for TMessage
        /// </summary>
        /// <typeparam name="TMessage"></typeparam>
        /// <returns></returns>
        IList<string> GetSubscriptionTagsFor<TMessage>()
             where TMessage : MessengerMessage;

        /// <summary>
        /// Publish a message to any subscribers
        /// </summary>
        /// <typeparam name="TMessage">Type of message</typeparam>
        /// <param name="message">Message to deliver</param>
        void Publish<TMessage>(TMessage message) where TMessage : MessengerMessage;

        /// <summary>
        /// Publish a message to any subscribers
        /// - GetType() will be used to determine the message type
        /// </summary>
        /// <param name="message">Message to deliver</param>
        void Publish(MessengerMessage message);

        /// <summary>
        /// Publish a message to any subscribers
        /// </summary>
        /// <param name="message">Message to deliver</param>
        /// <param name="messageType">The type of the message to use for delivery - message should be of that class or a of a subclass</param>
        void Publish(MessengerMessage message, Type messageType);

        /// <summary>
        /// Schedules a check on all subscribers for the specified messageType. If any are not alive, they will be removed
        /// </summary>
        /// <param name="messageType">The type of the message to check</param>
        void RequestPurge(Type messageType);

        /// <summary>
        /// Schedules a check on all subscribers for all messageType. If any are not alive, they will be removed
        /// </summary>
        void RequestPurgeAll();
    }
}