TopicAttribute.cs

// Copyright (c) .NET Core Community. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

using System;

namespace DotNetCore.CAP.Internal;

/// <inheritdoc />
/// <summary>
/// An abstract attribute that for kafka attribute or rabbit mq attribute
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = true)]
public abstract class TopicAttribute : Attribute
{
    protected TopicAttribute(string name, bool isPartial = false)
    {
        Name = name;
        IsPartial = isPartial;
    }

    /// <summary>
    /// Topic or exchange route key name.
    /// </summary>
    public string Name { get; }

    /// <summary>
    /// Defines whether this attribute defines a topic subscription partial.
    /// The defined topic will be combined with a topic subscription defined on class level,
    /// which results for example in subscription on "class.method".
    /// </summary>
    public bool IsPartial { get; }

    /// <summary>
    /// Default group name is CapOptions setting.(Assembly name)
    /// Kafka --> groups.id
    /// RabbitMQ --> queue.name
    /// </summary>
    public string Group { get; set; } = default!;

    /// <summary>
    /// Limit the number of messages consumed concurrently.
    /// If you set this value but don't specify the Group, we will automatically create a Group using the Name.
    /// </summary>
    public byte GroupConcurrent { get; set; }

    /// <summary>
    /// Sent or received succeed message after time span of due, then the message will be deleted at due time.
    /// </summary>
    public int SucceedMessageExpiredAfter { get; set; }
    
    /// <summary>
    /// Sent or received failed message after time span of due, then the message will be deleted at due time.
    /// </summary>
    public int FailedMessageExpiredAfter { get; set; }
}