Kanject.Core.Annotations.Attributes 3.12.7

Kanject.Core.Annotations.Attributes

The attribute and enum types that Kanject source generators read: [Parallel], [Recurring], [RecurringHosted], [QueryableEnum], [EnumParameter], [MultiTenant] and their option enums. The package contains only these declarations. It has no runtime logic and no package dependencies.

The attributes do nothing by themselves. Code is generated only in a project where the matching generator runs; for everything except [MultiTenant], that generator is Kanject.Core.Annotations.

Installation

You rarely need to reference this package directly. It is a dependency of Kanject.Core.Annotations, the generator package that you add alongside Kanject.Core to use these attributes:

<ItemGroup>
  <PackageReference Include="Kanject.Core" />
  <PackageReference Include="Kanject.Core.Annotations" PrivateAssets="all" />
</ItemGroup>

Reference the attributes directly only when a project needs the types without the generators, for example a shared contracts assembly that declares annotated types but does not take a dependency on Kanject.Core:

dotnet add package Kanject.Core.Annotations.Attributes

Targets .NET Standard 2.0, .NET 8, .NET 9 and .NET 10.

Quick start

using System.ComponentModel;
using Kanject.Core.Annotations.Attributes.Parallel;
using Kanject.Core.Annotations.Attributes.QueryableEnums;
using Kanject.Core.Annotations.Attributes.Recurring;
using Kanject.Core.Annotations.Attributes.Recurring.Enums;

namespace Shop;

[QueryableEnum(ConstantParameters = ["Wire"])]
public enum OrderStatus
{
    [EnumParameter("Wire", "pending"), Description("Awaiting payment.")] Pending,
    [EnumParameter("Wire", "shipped"), Description("Handed to the carrier.")] Shipped,
}

public sealed partial class OrderJobs
{
    [Parallel(MaxDegreeOfParallelism = 8, RetryCount = 2, RetryBackoffMs = 250)]
    public ValueTask ShipAsync(Order order, CancellationToken ct) => ValueTask.CompletedTask;

    [Recurring(1, RecurringRateUnit.Minutes, MaxJitterMs = 2_000)]
    [RecurringHosted(Name = "OrderSweep", Lifetime = RecurringServiceLifetime.Scoped)]
    public Task SweepAsync(CancellationToken ct) => Task.CompletedTask;
}

With Kanject.Core and Kanject.Core.Annotations referenced, this produces OrderStatusQuery (including OrderStatusQuery.Wires.Pending), ShipParallelAsync(...), SweepAsyncRecurringAsync(...), and a hosted service registered through AddOrderJobsSweepAsyncRecurring(...). The Kanject.Core and Kanject.Core.Annotations packages describe the generated APIs.

Public surface

Kanject.Core.Annotations.Attributes.Parallel

Kanject.Core.Annotations.Attributes.Recurring

Kanject.Core.Annotations.Attributes.QueryableEnums

Kanject.Core.Annotations.Attributes.Tenancy

Related packages

License

Licensed under the Kanject Code Libraries License Agreement (KCLLA); the full text ships in this package as LICENSE.md. Organizations whose trailing-twelve-month gross revenue and total funding raised are each below US$250,000 may use it at no cost under the Free Tier. At or above either threshold a commercial license is required — contact commercial@kanjectbusiness.com.