Foundatio by ejsmith, bniemyjski

<PackageReference Include="Foundatio" Version="3.0.532" />

---

API Diff between 3.0.532 and 10.1.1

513 Additions 414 Removals

Foundatio

• public sealed delegate Builder<TBuilder, TOptions> : MulticastDelegate where TBuilder : IOptionsBuilder<TOptions>
• public interface IOptionsBuilder
• public interface IOptionsBuilder<T> : IOptionsBuilder
• public class OptionsBuilder<T> : IOptionsBuilder<T>, IOptionsBuilder
• public static class OptionsBuilderExtensions
• public class SharedOptions
• public class SharedOptionsBuilder<TOption, TBuilder> : OptionsBuilder<TOption> where TOption : SharedOptions where TBuilder : SharedOptionsBuilder<TOption, TBuilder>

Foundatio.AsyncEx

• public sealed class AsyncAutoResetEvent
• public sealed class AsyncConditionVariable
• public sealed class AsyncCountdownEvent
• public sealed class AsyncLazy<T>
• public enum AsyncLazyFlags
• public sealed class AsyncLock
• public sealed class AsyncManualResetEvent
• public sealed class AsyncReaderWriterLock
• public sealed class AsyncSemaphore
• public struct AwaitableDisposable<T> where T : IDisposable
• public sealed class CancellationTokenTaskSource<T> : IDisposable
• public static class TaskCompletionSourceExtensions
• public static class TaskConstants
• public static class TaskConstants<T>
• public static class TaskExtensions

Foundatio.AsyncEx.Synchronous

• public static class TaskExtensions

Foundatio.Caching

• public static class CacheClientExtensions
  • public static Task<long> DecrementAsync(this ICacheClient client, string key, TimeSpan? expiresIn = default)
  • public static Task<long> DecrementAsync(this ICacheClient client, string key, long amount, TimeSpan? expiresIn = default)
  • public static Task<long> DecrementAsync(this ICacheClient client, string key, long amount, DateTime? expiresAtUtc)
  • public static Task<double> DecrementAsync(this ICacheClient client, string key, double amount, DateTime? expiresAtUtc)
  • public static Task<long> DecrementAsync(this ICacheClient client, string key, int amount = 1, TimeSpan? expiresIn = default)
  • public static Task<long> DecrementAsync(this ICacheClient client, string key, int amount = 1, DateTime? expiresAtUtc = default)
  • public static Task<CacheValue<ICollection<T>>> GetSetAsync<T>(this ICacheClient client, string key)
  • public static Task<DateTime> GetUnixTimeMillisecondsAsync(this ICacheClient client, string key, DateTime? defaultValue = default)
  • public static Task<DateTime> GetUnixTimeSecondsAsync(this ICacheClient client, string key, DateTime? defaultValue = default)
  • public static Task<long> IncrementAsync(this ICacheClient client, string key, long amount, DateTime? expiresAtUtc)
  • public static Task<double> IncrementAsync(this ICacheClient client, string key, double amount, DateTime? expiresAtUtc)
  • public static Task<long> IncrementAsync(this ICacheClient client, string key, TimeSpan? expiresIn = default)
  • public static Task<bool> ListAddAsync<T>(this ICacheClient client, string key, T value, TimeSpan? expiresIn = default)
  • public static Task<bool> ListRemoveAsync<T>(this ICacheClient client, string key, T value, TimeSpan? expiresIn = default)
  • public static Task<long> IncrementAsync(this ICacheClient client, string key, int amount = 1, DateTime? expiresAtUtc = default)
  • public static Task<bool> RemoveAsync(this ICacheClient client, string key)
  • public static Task<bool> ReplaceIfEqualAsync<T>(this ICacheClient client, string key, T value, T expected, DateTime? expiresAtUtc)
  • public static Task<bool> SetAddAsync<T>(this ICacheClient client, string key, T value, TimeSpan? expiresIn = default)
  • public static Task<long> SetAddAsync<T>(this ICacheClient client, string key, IEnumerable<T> value, TimeSpan? expiresIn = default)
  • public static Task<long> SetIfHigherAsync(this ICacheClient client, string key, DateTime value, TimeSpan? expiresIn = default)
  • public static Task<long> SetIfLowerAsync(this ICacheClient client, string key, DateTime value, TimeSpan? expiresIn = default)
  • public static Task<bool> SetRemoveAsync<T>(this ICacheClient client, string key, T value, TimeSpan? expiresIn = default)
  • public static Task<long> SetRemoveAsync<T>(this ICacheClient client, string key, IEnumerable<T> value, TimeSpan? expiresIn = default)
  • public static Task<bool> SetUnixTimeMillisecondsAsync(this ICacheClient client, string key, DateTime value, TimeSpan? expiresIn = default)
  • public static Task<bool> SetUnixTimeMillisecondsAsync(this ICacheClient client, string key, DateTime value, DateTime? expiresAtUtc)
  • public static Task<bool> SetUnixTimeSecondsAsync(this ICacheClient client, string key, DateTime value, TimeSpan? expiresIn = default)
  • public static Task<bool> SetUnixTimeSecondsAsync(this ICacheClient client, string key, DateTime value, DateTime? expiresAtUtc)
• public class HybridCacheClient : ICacheClient, IDisposable
  • protected readonly ICacheClient _distributedCache
  • protected readonly IMessageBus _messageBus
  • public HybridCacheClient(ICacheClient distributedCacheClient, IMessageBus messageBus, InMemoryCacheClientOptions localCacheOptions = null, ILoggerFactory loggerFactory = null)
  • public int LocalCacheSize { get; set; }
  • public HybridCacheClient(ICacheClient distributedCacheClient, IMessageBus messageBus)
  • public Task<bool> ExistsAsync(string key)
  • public Task<CacheValue<ICollection<T>>> GetListAsync<T>(string key, int? page = default, int pageSize = 100)
  • public Task<double> IncrementAsync(string key, double amount, TimeSpan? expiresIn = default)
  • public Task<long> IncrementAsync(string key, long amount, TimeSpan? expiresIn = default)
  • public Task<long> ListAddAsync<T>(string key, IEnumerable<T> values, TimeSpan? expiresIn = default)
  • public Task<long> ListRemoveAsync<T>(string key, IEnumerable<T> values, TimeSpan? expiresIn = default)
  • public Task<long> IncrementAsync(string key, int amount = 1, TimeSpan? expiresIn = default)
  • public Task<bool> RemoveAsync(string key)
  • public Task<bool> RemoveIfEqualAsync<T>(string key, T expected)
  • public Task<bool> ReplaceIfEqualAsync<T>(string key, T value, T expected, TimeSpan? expiresIn = default)
  • public Task<double> SetIfHigherAsync(string key, double value, TimeSpan? expiresIn = default)
  • public Task<long> SetIfHigherAsync(string key, long value, TimeSpan? expiresIn = default)
  • public Task<double> SetIfLowerAsync(string key, double value, TimeSpan? expiresIn = default)
  • public Task<long> SetIfLowerAsync(string key, long value, TimeSpan? expiresIn = default)
• public interface ICacheClient : IDisposable
  • Task<bool> ExistsAsync(string key)
  • Task<CacheValue<ICollection<T>>> GetListAsync<T>(string key, int? page = default, int pageSize = 100)
  • Task<double> IncrementAsync(string key, double amount, TimeSpan? expiresIn = default)
  • Task<long> IncrementAsync(string key, long amount, TimeSpan? expiresIn = default)
  • Task<long> ListAddAsync<T>(string key, IEnumerable<T> value, TimeSpan? expiresIn = default)
  • Task<long> ListRemoveAsync<T>(string key, IEnumerable<T> value, TimeSpan? expiresIn = default)
  • Task<long> IncrementAsync(string key, int amount = 1, TimeSpan? expiresIn = default)
  • Task<bool> RemoveAsync(string key)
  • Task<bool> RemoveIfEqualAsync<T>(string key, T expected)
  • Task<bool> ReplaceIfEqualAsync<T>(string key, T value, T expected, TimeSpan? expiresIn = default)
  • Task<double> SetIfHigherAsync(string key, double value, TimeSpan? expiresIn = default)
  • Task<long> SetIfHigherAsync(string key, long value, TimeSpan? expiresIn = default)
  • Task<double> SetIfLowerAsync(string key, double value, TimeSpan? expiresIn = default)
  • Task<long> SetIfLowerAsync(string key, long value, TimeSpan? expiresIn = default)
• public interface IHybridCacheClient : ICacheClient, IDisposable
• public class InMemoryCacheClient : MaintenanceBase, ICacheClient, IDisposable
  • public long Calls { get; }
  • public ICollection<KeyValuePair<string, object>> Items { get; }
  • public long Reads { get; }
  • public long Writes { get; }
  • public bool ShouldCloneValues { get; set; }
  • public InMemoryCacheClient(InMemoryCacheClientOptions options = null)
  • public InMemoryCacheClient(Builder<InMemoryCacheClientOptionsBuilder, InMemoryCacheClientOptions> config)
  • public void Dispose()
  • public Task<bool> ExistsAsync(string key)
  • public Task<CacheValue<ICollection<T>>> GetListAsync<T>(string key, int? page = default, int pageSize = 100)
  • public Task<double> IncrementAsync(string key, double amount, TimeSpan? expiresIn = default)
  • public Task<long> IncrementAsync(string key, long amount, TimeSpan? expiresIn = default)
  • public Task<long> ListAddAsync<T>(string key, IEnumerable<T> values, TimeSpan? expiresIn = default)
  • public Task<long> ListRemoveAsync<T>(string key, IEnumerable<T> values, TimeSpan? expiresIn = default)
  • public Task<long> IncrementAsync(string key, int amount = 1, TimeSpan? expiresIn = default)
  • protected virtual Task OnItemExpiredAsync(string key)
  • public Task<bool> RemoveAsync(string key)
  • public Task<bool> RemoveIfEqualAsync<T>(string key, T expected)
  • public Task<bool> ReplaceIfEqualAsync<T>(string key, T value, T expected, TimeSpan? expiresIn = default)
  • public void ResetStats()
  • public Task<double> SetIfHigherAsync(string key, double value, TimeSpan? expiresIn = default)
  • public Task<long> SetIfHigherAsync(string key, long value, TimeSpan? expiresIn = default)
  • public Task<double> SetIfLowerAsync(string key, double value, TimeSpan? expiresIn = default)
  • public Task<long> SetIfLowerAsync(string key, long value, TimeSpan? expiresIn = default)
• public class InMemoryCacheClientOptions : SharedOptions
• public class InMemoryCacheClientOptionsBuilder : SharedOptionsBuilder<InMemoryCacheClientOptions, InMemoryCacheClientOptionsBuilder>
• public class ItemExpiredEventArgs : EventArgs
  • public bool SendNotification { get; set; }
• public class NullCacheClient : ICacheClient, IDisposable
  • public static readonly NullCacheClient Instance
  • public long Calls { get; }
  • public long Reads { get; }
  • public long Writes { get; }
  • public Task<bool> ExistsAsync(string key)
  • public Task<CacheValue<ICollection<T>>> GetListAsync<T>(string key, int? page = default, int pageSize = 100)
  • public Task<double> IncrementAsync(string key, double amount, TimeSpan? expiresIn = default)
  • public Task<long> IncrementAsync(string key, long amount, TimeSpan? expiresIn = default)
  • public Task<long> ListAddAsync<T>(string key, IEnumerable<T> values, TimeSpan? expiresIn = default)
  • public Task<long> ListRemoveAsync<T>(string key, IEnumerable<T> values, TimeSpan? expiresIn = default)
  • public Task<long> IncrementAsync(string key, int amount = 1, TimeSpan? expiresIn = default)
  • public Task<bool> RemoveAsync(string key)
  • public Task<bool> RemoveIfEqualAsync<T>(string key, T expected)
  • public Task<bool> ReplaceIfEqualAsync<T>(string key, T value, T expected, TimeSpan? expiresIn = default)
  • public void ResetStats()
  • public Task<double> SetIfHigherAsync(string key, double value, TimeSpan? expiresIn = default)
  • public Task<long> SetIfHigherAsync(string key, long value, TimeSpan? expiresIn = default)
  • public Task<double> SetIfLowerAsync(string key, double value, TimeSpan? expiresIn = default)
  • public Task<long> SetIfLowerAsync(string key, long value, TimeSpan? expiresIn = default)
• public class ScopedCacheClient : ICacheClient, IDisposable
  • public Task<bool> ExistsAsync(string key)
  • public Task<CacheValue<ICollection<T>>> GetListAsync<T>(string key, int? page = default, int pageSize = 100)
  • protected string GetUnscopedCacheKey(string key)
  • protected IEnumerable<string> GetUnscopedCacheKeys(IEnumerable<string> keys)
  • public Task<double> IncrementAsync(string key, double amount, TimeSpan? expiresIn = default)
  • public Task<long> IncrementAsync(string key, long amount, TimeSpan? expiresIn = default)
  • public Task<long> ListAddAsync<T>(string key, IEnumerable<T> values, TimeSpan? expiresIn = default)
  • public Task<long> ListRemoveAsync<T>(string key, IEnumerable<T> values, TimeSpan? expiresIn = default)
  • protected IEnumerable<string> GetScopedCacheKey(IEnumerable<string> keys)
  • public Task<long> IncrementAsync(string key, int amount = 1, TimeSpan? expiresIn = default)
  • public Task<bool> RemoveAsync(string key)
  • public Task<bool> RemoveIfEqualAsync<T>(string key, T expected)
  • public Task<bool> ReplaceIfEqualAsync<T>(string key, T value, T expected, TimeSpan? expiresIn = default)
  • public Task<double> SetIfHigherAsync(string key, double value, TimeSpan? expiresIn = default)
  • public Task<long> SetIfHigherAsync(string key, long value, TimeSpan? expiresIn = default)
  • public Task<double> SetIfLowerAsync(string key, double value, TimeSpan? expiresIn = default)
  • public Task<long> SetIfLowerAsync(string key, long value, TimeSpan? expiresIn = default)
  • public void SetScope(string scope)
• public class ScopedHybridCacheClient : ScopedCacheClient, IHybridCacheClient, ICacheClient, IDisposable

Foundatio.Collections

• public sealed class Deque<T> : IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable, IReadOnlyList<T>, IReadOnlyCollection<T>, IList, ICollection

Foundatio.Disposables

• public sealed class AnonymousDisposable : SingleDisposable<Action>
• public abstract class SingleDisposable<T> : IDisposable

Foundatio.Disposables.Internals

• public sealed class BoundActionField<T>

Foundatio.Extensions

• public static class ConcurrentQueueExtensions
  • public static void Clear<T>(this ConcurrentQueue<T> queue)
• public static class DateTimeExtensions
  • public static DateTime Ceiling(this DateTime date, TimeSpan interval)
  • public static DateTime Floor(this DateTime date, TimeSpan interval)
• public static class EnumerableExtensions
  • public static void ForEach<T>(this IEnumerable<T> collection, Action<T> action)
• public static class EnumExtensions
  • public static string GetDescription(Enum en)
  • public static object GetEnumDefaultValue(Type type)
  • public static List<string> GetValues<T>() where T : struct, IConvertible
  • public static bool IsAnyFlagOn<T>(this Enum mask, T flag) where T : struct, IComparable, IFormattable, IConvertible
  • public static bool IsFlagOn<T>(this Enum mask, T flag) where T : struct, IComparable, IFormattable, IConvertible
  • public static T SetFlagOff<T>(this Enum mask, T flag) where T : struct, IComparable, IFormattable, IConvertible
  • public static T SetFlagOn<T>(this Enum mask, T flag) where T : struct, IComparable, IFormattable, IConvertible
  • public static T ToggleFlag<T>(this Enum mask, T flag) where T : struct, IComparable, IFormattable, IConvertible
  • public static string ToStringHex<T>(this Enum enum) where T : struct, IComparable, IFormattable, IConvertible
  • public static bool TryEnumIsDefined(Type type, object value)
  • public static bool TryParseEnum<T>(this Enum value, string input, out T returnValue) where T : struct, IComparable, IFormattable, IConvertible
• public static class ExceptionExtensions
  • public static Exception GetInnermostException(this Exception exception)
  • public static string GetMessage(this Exception exception)
• public enum JsonType
  • Array = 2
  • None = 0
  • Object = 1
• public static class NumericExtensions
  • public static TimeSpan Max(this TimeSpan source, TimeSpan other)
  • public static TimeSpan Min(this TimeSpan source, TimeSpan other)
  • public static string ToFileSizeDisplay(this int i)
  • public static string ToFileSizeDisplay(this int i, int decimals)
  • public static string ToFileSizeDisplay(this long i)
  • public static string ToFileSizeDisplay(this long i, int decimals)
  • public static string ToOrdinal(this int num)
• public static class ObjectExtensions
  • public static object Copy(this object original)
  • public static T Copy<T>(this T original)
  • public static bool IsPrimitive(this Type type)
• public class PriorityAttribute : Attribute
  • public int Priority { get; }
  • public PriorityAttribute(int priority)
• public class ReferenceEqualityComparer : EqualityComparer<object>
  • public ReferenceEqualityComparer()
• public static class ServiceProviderExtensions
  • public static T GetService<T>(this IServiceProvider serviceProvider)
• public static class StringExtensions
  • public static JsonType GetJsonType(this string value)
  • public static bool IsJson(this string value)
  • public static string RemoveWhiteSpace(this string s)
• public static class TimespanExtensions
  • public static CancellationToken ToCancellationToken(this TimeSpan timeout)
  • public static CancellationToken ToCancellationToken(this TimeSpan? timeout, TimeSpan defaultTimeout)
• public static class TypeExtensions
  • public static object GetDefaultValue(this Type type)
  • public static PropertyInfo[] GetPublicProperties(this Type type)
  • public static bool IsNullable(this Type type)
  • public static bool IsNumeric(this Type type)
  • public static IList<Type> SortByPriority(this IEnumerable<Type> types)
  • public static T ToType<T>(this object value)

Foundatio.Extensions.ArrayExtensions

• public static class ArrayExtensions
  • public static void ForEach(this Array array, Action<Array, int[]> action)

Foundatio.Jobs

• public class DelegateWorkItemHandler : IWorkItemHandler
  • public DelegateWorkItemHandler(Func<WorkItemContext, Task> handler, ILogger logger = null, Action<IQueueEntry<WorkItemData>, Type, object> logProcessingWorkItem = null, Action<IQueueEntry<WorkItemData>, Type, object> logAutoCompletedWorkItem = null)
  • public bool AutoRenewLockOnProgress { get; set; }
  • public DelegateWorkItemHandler(Func<WorkItemContext, Task> handler)
  • public Task<ILock> GetWorkItemLockAsync(object workItem, CancellationToken cancellationToken = default)
  • public Task HandleItemAsync(WorkItemContext context)
• public interface IJob
• public interface IQueueJob<T> : IJob
• public interface IOneTimeWorkItemHandler : IWorkItemHandler
  • string GetKey()
• public interface IQueueProcessorJob : IDisposable
  • Task RunUntilEmptyAsync(CancellationToken cancellationToken = default)
• public interface IWorkItemHandler
  • ILogger Log { get; set; }
  • void LogAutoCompletedQueueEntry(IQueueEntry<WorkItemData> queueEntry, Type workItemDataType, object workItem)
  • void LogProcessingQueueEntry(IQueueEntry<WorkItemData> queueEntry, Type workItemDataType, object workItem)
• public class JobAttribute : Attribute
• public abstract class JobBase : IDisposable
  • protected readonly ILogger _logger
  • public JobBase(ILoggerFactory loggerFactory = null)
  • public JobBase()
  • public virtual void Dispose()
  • protected virtual Task<ILock> GetJobLockAsync()
  • protected abstract Task<JobResult> RunInternalAsync(JobContext context)
  • public Task RunContinuousAsync(TimeSpan? interval = default, int iterationLimit = -1, CancellationToken cancellationToken = default, Func<Task<bool>> continuationCallback = null)
  • protected abstract Task<JobResult> RunInternalAsync(JobRunContext context)
• public class JobContext
• public static class JobExtensions
• public static class JobOptionExtensions
• public class JobOptions
• public class JobQueueEntryContext<T>
  • public CancellationToken CancellationToken { get; }
  • public QueueEntry<T> QueueEntry { get; }
  • public ILock QueueEntryLock { get; }
  • public JobQueueEntryContext(QueueEntry<T> queueEntry, ILock queueEntryLock, CancellationToken cancellationToken = default)
• public class JobResult
  • public static JobResult CancelledWithMessage(string message)
  • public static JobResult FailedWithMessage(string format, object[] args)
  • public static JobResult FromException(Exception exception, string format, object[] args)
  • public static JobResult SuccessWithMessage(string format, object[] args)
• public static class JobResultExtensions
• public class JobRunContext
  • public CancellationToken CancellationToken { get; }
  • public ILock JobLock { get; }
  • public JobRunContext(ILock jobLock, CancellationToken cancellationToken = default)
• public class JobRunner
  • public CancellationTokenSource CancellationTokenSource { get; }
  • public JobRunner(JobOptions options, ILoggerFactory loggerFactory = null)
  • public JobRunner(IJob instance, ILoggerFactory loggerFactory = null, TimeSpan? initialDelay = default, int instanceCount = 1, bool runContinuous = true, int iterationLimit = -1, TimeSpan? interval = default)
  • public JobRunner(Func<IJob> jobFactory, ILoggerFactory loggerFactory = null, TimeSpan? initialDelay = default, int instanceCount = 1, bool runContinuous = true, int iterationLimit = -1, TimeSpan? interval = default)
  • public static CancellationToken GetShutdownCancellationToken(ILogger logger = null)
  • public Task<bool> RunAsync(CancellationToken cancellationToken = default)
  • public void RunInBackground(CancellationToken cancellationToken = default)
  • public Task<int> RunInConsoleAsync()
  • public JobRunner()
  • public static JobBase CreateJobInstance(string jobTypeName)
  • public static JobBase CreateJobInstance(Type jobType)
  • public static void ResolveTypes(JobRunOptions options)
  • public static Task<JobResult> RunAsync(Type jobType, TimeSpan? initialDelay = default, CancellationToken cancellationToken = default)
  • public static Task<int> RunAsync(JobRunOptions options, CancellationToken cancellationToken = default)
  • public static Task RunContinuousAsync(Type jobType, TimeSpan? interval = default, TimeSpan? initialDelay = default, int iterationLimit = -1, int instanceCount = 1, CancellationToken cancellationToken = default)
  • public static Task RunContinuousAsync<T>(TimeSpan? interval = default, TimeSpan? initialDelay = default, int iterationLimit = -1, int instanceCount = 1, CancellationToken cancellationToken = default)
  • public static int RunInConsole(JobRunOptions options, Action<IServiceProvider> afterBootstrap = null)
  • public static Task RunUntilEmptyAsync<T>(CancellationToken cancellationToken = default) where T : IQueueProcessorJob
• public abstract class JobWithLockBase : IJob, IHaveLogger
• public class QueueEntryContext<T> : JobContext
• public abstract class QueueJobBase<T> : IQueueJob<T>, IJob, IHaveLogger
• public static class QueueJobExtensions
• public class JobRunOptions
  • public TimeSpan? InitialDelay { get; set; }
  • public int InstanceCount { get; set; }
  • public TimeSpan? Interval { get; set; }
  • public int IterationLimit { get; set; }
  • public Type JobType { get; set; }
  • public string JobTypeName { get; set; }
  • public bool? NoServiceProvider { get; set; }
  • public bool RunContinuous { get; set; }
  • public Type ServiceProviderType { get; set; }
  • public string ServiceProviderTypeName { get; set; }
  • public JobRunOptions()
• public abstract class OneTimeWorkItemHandlerBase : IOneTimeWorkItemHandler, IWorkItemHandler
  • public bool AutoRenewLockOnProgress { get; set; }
  • protected OneTimeWorkItemHandlerBase()
  • protected int CalculateProgress(long total, long completed, int startProgress = 0, int endProgress = 100)
  • public abstract string GetKey()
  • public virtual Task<ILock> GetWorkItemLockAsync(object workItem, CancellationToken cancellationToken = default)
  • public abstract Task HandleItemAsync(WorkItemContext context)
• public abstract class QueueProcessorJobBase<T> : JobBase, IQueueProcessorJob, IDisposable
  • protected readonly IQueue<T> _queue
  • protected bool AutoComplete { get; protected set; }
  • public QueueProcessorJobBase(IQueue<T> queue)
  • protected virtual Task<ILock> GetQueueEntryLockAsync(QueueEntry<T> queueEntry, CancellationToken cancellationToken = default)
  • protected abstract Task<JobResult> ProcessQueueEntryAsync(JobQueueEntryContext<T> context)
  • public Task RunUntilEmptyAsync(CancellationToken cancellationToken = default)
• public class ShutdownEventArgs
  • public readonly Exception Exception
  • public readonly ShutdownReason Reason
  • public ShutdownEventArgs(ShutdownReason reason)
  • public ShutdownEventArgs(Exception exception)
• public static class ShutdownEventCatcher
  • public static event Action<ShutdownEventArgs> Shutdown
• public enum ShutdownReason
  • ConsoleClosing = 2
  • Exception = 1001
  • PressCtrlBreak = 1
  • PressCtrlC = 0
  • ReachEndOfMain = 1000
  • WindowsLogOff = 5
  • WindowsShutdown = 6
• public class WorkItemContext : JobQueueEntryContext<WorkItemData>
  • public CancellationToken CancellationToken { get; }
  • public WorkItemContext(object data, string jobId, ILock workItemLock, CancellationToken cancellationToken, Func<int, string, Task> progressCallback)
  • public WorkItemContext(JobQueueEntryContext<WorkItemData> context, object data, string jobId, ILock workItemLock, Func<int, string, Task> progressCallback)
  • public Task RenewLockAsync()
• public class WorkItemData : IHaveMetricName
  • public byte[] Data { get; set; }
  • public string Data { get; set; }
  • public string SubMetricName { get; set; }
  • public string UniqueIdentifier { get; set; }
  • public string GetMetricName()
  • public string GetTypeName(string assemblyQualifiedName)
• public abstract class WorkItemHandlerBase : IWorkItemHandler
  • public ILogger Log { get; set; }
  • public WorkItemHandlerBase(ILoggerFactory loggerFactory = null)
  • public WorkItemHandlerBase(ILogger logger)
  • protected WorkItemHandlerBase()
  • public virtual void LogAutoCompletedQueueEntry(IQueueEntry<WorkItemData> queueEntry, Type workItemDataType, object workItem)
  • public virtual void LogProcessingQueueEntry(IQueueEntry<WorkItemData> queueEntry, Type workItemDataType, object workItem)
• public class WorkItemHandlers
  • public void Register<TWorkItem, THandler>() where THandler : IWorkItemHandler
  • public void Register<T>(Func<IWorkItemHandler> handler)
  • public void Register<T>(Func<WorkItemContext, Task> handler, ILogger logger = null, Action<IQueueEntry<WorkItemData>, Type, object> logProcessingWorkItem = null, Action<IQueueEntry<WorkItemData>, Type, object> logAutoCompletedWorkItem = null)
  • public void Register<T>(Func<WorkItemContext, Task> handler, CancellationToken cancellationToken = default)
• public class WorkItemJob : QueueProcessorJobBase<WorkItemData>
  • protected readonly ILogger _logger
  • protected readonly IMessagePublisher _publisher
  • protected readonly IQueue<WorkItemData> _queue
  • public string JobId { get; }
  • public WorkItemJob(IQueue<WorkItemData> queue, IMessagePublisher publisher, WorkItemHandlers handlers, ILoggerFactory loggerFactory = null)
  • protected virtual Type GetWorkItemType(string workItemType)
  • public Task<JobResult> ProcessAsync(IQueueEntry<WorkItemData> queueEntry, CancellationToken cancellationToken)
  • protected Task ReportProgressAsync(IWorkItemHandler handler, IQueueEntry<WorkItemData> queueEntry, int progress = 0, string message = null)
  • public virtual Task<JobResult> RunAsync(CancellationToken cancellationToken = default)
  • protected readonly IMessageBus _messageBus
  • public WorkItemJob(IQueue<WorkItemData> queue, IMessageBus messageBus, WorkItemHandlers handlers)

Foundatio.Lock

• public class CacheLockProvider : ILockProvider, IDisposable
  • public CacheLockProvider(ICacheClient cacheClient, IMessageBus messageBus, ILoggerFactory loggerFactory = null)
  • public Task<ILock> AcquireAsync(string resource, TimeSpan? timeUntilExpires = default, bool releaseOnDispose = true, CancellationToken cancellationToken = default)
  • public CacheLockProvider(ICacheClient cacheClient, IMessageBus messageBus)
  • public Task<ILock> AcquireAsync(string name, TimeSpan? lockTimeout = default, CancellationToken cancellationToken = default)
  • public void Dispose()
  • public Task ReleaseAsync(string resource, string lockId)
  • public Task RenewAsync(string resource, string lockId, TimeSpan? timeUntilExpires = default)
  • public Task ReleaseAsync(string name)
  • public Task RenewAsync(string name, TimeSpan? lockExtension = default)
• public class CacheLockReleased
• public interface ILock : IDisposable
  • DateTime AcquiredTimeUtc { get; }
  • string LockId { get; }
  • int RenewalCount { get; }
  • string Resource { get; }
  • TimeSpan TimeWaitedForLock { get; }
  • Task ReleaseAsync()
• public interface ILockProvider : IDisposable
  • Task<ILock> AcquireAsync(string resource, TimeSpan? timeUntilExpires = default, bool releaseOnDispose = true, CancellationToken cancellationToken = default)
  • Task<ILock> AcquireAsync(string name, TimeSpan? lockTimeout = default, CancellationToken cancellationToken = default)
  • Task ReleaseAsync(string resource, string lockId)
  • Task RenewAsync(string resource, string lockId, TimeSpan? timeUntilExpires = default)
  • Task ReleaseAsync(string name)
  • Task RenewAsync(string name, TimeSpan? lockExtension = default)
• public static class LockProviderExtensions
  • public static Task<ILock> AcquireAsync(this ILockProvider provider, string resource, TimeSpan? timeUntilExpires = default, CancellationToken cancellationToken = default)
  • public static Task<ILock> AcquireAsync(this ILockProvider provider, IEnumerable<string> resources, TimeSpan? timeUntilExpires = default, bool releaseOnDispose = true, CancellationToken cancellationToken = default)
  • public static Task<ILock> AcquireAsync(this ILockProvider provider, IEnumerable<string> resources, TimeSpan? timeUntilExpires, TimeSpan? acquireTimeout)
  • public static Task<ILock> AcquireAsync(this ILockProvider provider, IEnumerable<string> resources, TimeSpan? timeUntilExpires, TimeSpan? acquireTimeout, bool releaseOnDispose)
  • public static Task ReleaseAsync(this ILockProvider provider, ILock lock)
  • public static Task RenewAsync(this ILockProvider provider, ILock lock, TimeSpan? timeUntilExpires = default)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, string resource, Func<CancellationToken, Task> work, TimeSpan? timeUntilExpires = default, CancellationToken cancellationToken = default)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, string resource, Func<Task> work, TimeSpan? timeUntilExpires = default, CancellationToken cancellationToken = default)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, string resource, Func<CancellationToken, Task> work, TimeSpan? timeUntilExpires = default, TimeSpan? acquireTimeout = default)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, string resource, Func<Task> work, TimeSpan? timeUntilExpires = default, TimeSpan? acquireTimeout = default)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, string resource, Action work, TimeSpan? timeUntilExpires = default, TimeSpan? acquireTimeout = default)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, IEnumerable<string> resources, Func<CancellationToken, Task> work, TimeSpan? timeUntilExpires = default, CancellationToken cancellationToken = default)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, IEnumerable<string> resources, Func<Task> work, TimeSpan? timeUntilExpires = default, CancellationToken cancellationToken = default)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, IEnumerable<string> resources, Func<CancellationToken, Task> work, TimeSpan? timeUntilExpires, TimeSpan? acquireTimeout)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, IEnumerable<string> resources, Func<Task> work, TimeSpan? timeUntilExpires, TimeSpan? acquireTimeout)
  • public static Task<bool> TryUsingAsync(this ILockProvider locker, IEnumerable<string> resources, Action work, TimeSpan? timeUntilExpires, TimeSpan? acquireTimeout)
  • public static Task TryUsingAsync(this ILockProvider locker, string name, Func<CancellationToken, Task> work, TimeSpan? lockTimeout = default, CancellationToken cancellationToken = default)
  • public static Task TryUsingAsync(this ILockProvider locker, string name, Func<Task> work, TimeSpan? lockTimeout = default, CancellationToken cancellationToken = default)
  • public static Task TryUsingAsync(this ILockProvider locker, string name, Func<CancellationToken, Task> work, TimeSpan? lockTimeout = default, TimeSpan? acquireTimeout = default)
  • public static Task TryUsingAsync(this ILockProvider locker, string name, Func<Task> work, TimeSpan? lockTimeout = default, TimeSpan? acquireTimeout = default)
• public class ScopedLockProvider : ILockProvider, IHaveLogger
• public class ThrottlingLockProvider : ILockProvider, IDisposable
  • public ThrottlingLockProvider(ICacheClient cacheClient, int maxHitsPerPeriod = 100, TimeSpan? throttlingPeriod = default, ILoggerFactory loggerFactory = null)
  • public Task<ILock> AcquireAsync(string resource, TimeSpan? timeUntilExpires = default, bool releaseOnDispose = true, CancellationToken cancellationToken = default)
  • public ThrottlingLockProvider(ICacheClient cacheClient, int maxHitsPerPeriod = 100, TimeSpan? throttlingPeriod = default)
  • public Task<ILock> AcquireAsync(string name, TimeSpan? lockTimeout = default, CancellationToken cancellationToken = default)
  • public void Dispose()
  • public Task ReleaseAsync(string resource, string lockId)
  • public Task RenewAsync(string resource, string lockId, TimeSpan? timeUntilExpires = default)
  • public Task ReleaseAsync(string name)
  • public Task RenewAsync(string name, TimeSpan? lockExtension = default)

Foundatio.Logging

• public class AsynchronousContext : IPropertyContext
  • public AsynchronousContext()
  • public void Apply(ILogBuilder builder)
  • public void Clear()
  • public bool Contains(string key)
  • public object Get(string key)
  • public IEnumerable<string> Keys()
  • public bool Remove(string key)
  • public IDisposable Set(string key, object value)
• public sealed class DisposeAction : IDisposable
  • public DisposeAction(Action exitAction)
• public interface ILogBuilder
  • LogData LogData { get; }
  • ILogBuilder Exception(Exception exception)
  • ILogBuilder Level(LogLevel logLevel)
  • ILogBuilder Logger(string logger)
  • ILogBuilder Logger<TLogger>()
  • ILogBuilder Message(string message)
  • ILogBuilder Message(string format, object arg0)
  • ILogBuilder Message(string format, object arg0, object arg1)
  • ILogBuilder Message(string format, object arg0, object arg1, object arg2)
  • ILogBuilder Message(string format, object arg0, object arg1, object arg2, object arg3)
  • ILogBuilder Message(string format, object[] args)
  • ILogBuilder Message(IFormatProvider provider, string format, object[] args)
  • ILogBuilder Property(string name, object value)
  • void Write(string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
  • void WriteIf(Func<bool> condition, string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
  • void WriteIf(bool condition, string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
• public interface ILogger
  • string Name { get; }
  • IPropertyContext Properties { get; }
  • ILogBuilder Debug()
  • ILogBuilder Error()
  • ILogBuilder Fatal()
  • ILogBuilder Info()
  • ILogBuilder Log(LogLevel logLevel)
  • ILogBuilder Log(Func<LogLevel> logLevelFactory)
  • ILogBuilder Trace()
  • ILogBuilder Warn()
• public interface ILogWriter
  • void WriteLog(LogData logData)
• public interface IPropertyContext
  • void Apply(ILogBuilder builder)
  • void Clear()
  • bool Contains(string key)
  • object Get(string key)
  • IEnumerable<string> Keys()
  • bool Remove(string key)
  • IDisposable Set(string key, object value)
• public sealed class LogBuilder : ILogBuilder
  • public LogData LogData { get; }
  • public LogBuilder(LogLevel logLevel, Action<LogData> writer)
  • public ILogBuilder Exception(Exception exception)
  • public ILogBuilder Level(LogLevel logLevel)
  • public ILogBuilder Logger(string logger)
  • public ILogBuilder Logger<TLogger>()
  • public ILogBuilder Message(string message)
  • public ILogBuilder Message(string format, object arg0)
  • public ILogBuilder Message(string format, object arg0, object arg1)
  • public ILogBuilder Message(string format, object arg0, object arg1, object arg2)
  • public ILogBuilder Message(string format, object arg0, object arg1, object arg2, object arg3)
  • public ILogBuilder Message(string format, object[] args)
  • public ILogBuilder Message(IFormatProvider provider, string format, object[] args)
  • public ILogBuilder Property(string name, object value)
  • public void Write(string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
  • public void WriteIf(Func<bool> condition, string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
  • public void WriteIf(bool condition, string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
• public sealed class LogData
  • public Exception Exception { get; set; }
  • public string FilePath { get; set; }
  • public IFormatProvider FormatProvider { get; set; }
  • public int LineNumber { get; set; }
  • public string Logger { get; set; }
  • public LogLevel LogLevel { get; set; }
  • public string MemberName { get; set; }
  • public string Message { get; set; }
  • public object[] Parameters { get; set; }
  • public IDictionary<string, object> Properties { get; set; }
  • public LogData()
  • public string ToString(bool includeFileInfo, bool includeException)
• public sealed class Logger : ILogger
  • public static IPropertyContext AsyncProperties { get; }
  • public static IPropertyContext GlobalProperties { get; }
  • public static IPropertyContext ThreadProperties { get; }
  • public string Name { get; set; }
  • public IPropertyContext Properties { get; }
  • public Logger()
  • public static ILogger CreateLogger(Action<LoggerCreateBuilder> builder)
  • public static ILogger CreateLogger(string callerFilePath = null)
  • public static ILogger CreateLogger(Type type)
  • public static ILogger CreateLogger<T>()
  • public static ILogBuilder Debug(string callerFilePath = null)
  • public static ILogBuilder Error(string callerFilePath = null)
  • public static ILogBuilder Fatal(string callerFilePath = null)
  • public static ILogBuilder Info(string callerFilePath = null)
  • public static ILogBuilder Log(LogLevel logLevel, string callerFilePath = null)
  • public static ILogBuilder Log(Func<LogLevel> logLevelFactory, string callerFilePath = null)
  • public static void RegisterWriter(Action<LogData> writer)
  • public static void RegisterWriter<TWriter>(TWriter writer) where TWriter : ILogWriter
  • public static void SetMinimumLogLevel(LogLevel level)
  • public static ILogBuilder Trace(string callerFilePath = null)
  • public static ILogBuilder Warn(string callerFilePath = null)
• public class LoggerCreateBuilder
  • public LoggerCreateBuilder(Logger logger)
  • public LoggerCreateBuilder Logger(string logger)
  • public LoggerCreateBuilder Logger<TLogger>()
  • public LoggerCreateBuilder Logger(Type type)
  • public LoggerCreateBuilder Property(string name, object value)
• public class LoggerTextWriter : TextWriter
  • public string Source { get; set; }
  • public LoggerTextWriter()
• public enum LogLevel
  • Debug = 1
  • Error = 4
  • Fatal = 5
  • Info = 2
  • None = 100
  • Trace = 0
  • Warn = 3
• public sealed class NullLogBuilder : ILogBuilder
  • public LogData LogData { get; }
  • public NullLogBuilder()
  • public ILogBuilder Exception(Exception exception)
  • public ILogBuilder Level(LogLevel logLevel)
  • public ILogBuilder Logger(string logger)
  • public ILogBuilder Logger<TLogger>()
  • public ILogBuilder Message(string message)
  • public ILogBuilder Message(string format, object arg0)
  • public ILogBuilder Message(string format, object arg0, object arg1)
  • public ILogBuilder Message(string format, object arg0, object arg1, object arg2)
  • public ILogBuilder Message(string format, object arg0, object arg1, object arg2, object arg3)
  • public ILogBuilder Message(string format, object[] args)
  • public ILogBuilder Message(IFormatProvider provider, string format, object[] args)
  • public ILogBuilder Property(string name, object value)
  • public void Write(string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
  • public void WriteIf(Func<bool> condition, string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
  • public void WriteIf(bool condition, string callerMemberName = null, string callerFilePath = null, int callerLineNumber = 0)
• public class PropertyContext : IPropertyContext
  • public PropertyContext()
  • public void Apply(ILogBuilder builder)
  • public void Clear()
  • public bool Contains(string key)
  • public object Get(string key)
  • public IEnumerable<string> Keys()
  • public bool Remove(string key)
  • public IDisposable Set(string key, object value)
• public class TraceLogWriter : ILogWriter
  • public TraceLogWriter()
  • public void WriteLog(LogData logData)

Foundatio.Messaging

• public interface IMessage
• public interface IMessageSubscriber
  • Task SubscribeAsync<T>(Func<T, CancellationToken, Task> handler, CancellationToken cancellationToken = default)
  • void Subscribe<T>(Func<T, CancellationToken, Task> handler, CancellationToken cancellationToken = default)
• public class InMemoryMessageBus : MessageBusBase, IMessageBus, IMessagePublisher, IMessageSubscriber, IDisposable
  • public long MessagesSent { get; }
  • public InMemoryMessageBus(InMemoryMessageBusOptions options)
  • public InMemoryMessageBus(Builder<InMemoryMessageBusOptionsBuilder, InMemoryMessageBusOptions> config)
  • public long GetMessagesSent(Type messageType)
  • public long GetMessagesSent<T>()
  • public void ResetMessagesSent()
• public class InMemoryMessageBusOptions : SharedMessageBusOptions
• public class InMemoryMessageBusOptionsBuilder : SharedMessageBusOptionsBuilder<InMemoryMessageBusOptions, InMemoryMessageBusOptionsBuilder>
• public class Message : IMessage
• public abstract class MessageBusBase<TOptions> : IMessageBus, IMessagePublisher, IMessageSubscriber, IDisposable where TOptions : SharedMessageBusOptions
• public abstract class MessageBusBase : MaintenanceBase, IMessagePublisher
  • protected class DelayedMessage
  • protected class Subscriber
  • protected readonly ConcurrentDictionary<string, Subscriber> _subscribers
  • public MessageBusBase()
  • protected Task AddDelayedMessageAsync(Type messageType, object message, TimeSpan delay)
  • public abstract Task PublishAsync(Type messageType, object message, TimeSpan? delay = default, CancellationToken cancellationToken = default)
  • protected Task SendMessageToSubscribersAsync(Type messageType, object message)
  • public virtual void Subscribe<T>(Func<T, CancellationToken, Task> handler, CancellationToken cancellationToken = default)
• public class MessageBusData
  • public string Data { get; set; }
  • public string Type { get; set; }
  • public MessageBusData()
• public static class MessageBusExtensions
  • public static Task SubscribeAsync<T>(this IMessageSubscriber subscriber, Func<T, Task> handler, CancellationToken cancellationToken = default)
  • public static Task SubscribeAsync<T>(this IMessageSubscriber subscriber, Action<T> handler, CancellationToken cancellationToken = default)
  • public static Task SubscribeAsync(this IMessageSubscriber subscriber, Func<IMessage, CancellationToken, Task> handler, CancellationToken cancellationToken = default)
  • public static Task SubscribeAsync(this IMessageSubscriber subscriber, Func<IMessage, Task> handler, CancellationToken cancellationToken = default)
  • public static Task SubscribeAsync(this IMessageSubscriber subscriber, Action<IMessage> handler, CancellationToken cancellationToken = default)
  • public static void Subscribe<T>(this IMessageSubscriber subscriber, Func<T, Task> handler, CancellationToken cancellationToken = default)
  • public static void Subscribe<T>(this IMessageSubscriber subscriber, Action<T> handler, CancellationToken cancellationToken = default)
• public class NullMessageBus : IMessageBus, IMessagePublisher, IMessageSubscriber, IDisposable
• public class SharedMessageBusOptions : SharedOptions
• public class SharedMessageBusOptionsBuilder<TOptions, TBuilder> : SharedOptionsBuilder<TOptions, TBuilder> where TOptions : SharedMessageBusOptions where TBuilder : SharedMessageBusOptionsBuilder<TOptions, TBuilder>

Foundatio.Metrics

• public abstract class BufferedMetricsClientBase : IBufferedMetricsClient, IMetricsClient, IDisposable
• public abstract class CacheBucketMetricsClientBase : BufferedMetricsClientBase, IMetricsClientStats
• public class CountedEventArgs : EventArgs
• public class CounterStat
• public class CounterStatSummary
• public class GaugeStat
• public class GaugeStatSummary
• public interface IBufferedMetricsClient : IMetricsClient, IDisposable
• public interface IHaveSubMetricName
• public class CounterStats : ICounterStats
  • public double Rate { get; }
  • public double RecentRate { get; }
  • public long RecentValue { get; }
  • public long Value { get; }
  • public CounterStats(long value)
  • public void Increment(long value)
• public class GaugeStats : IGaugeStats
  • public double Average { get; }
  • public int Count { get; }
  • public double Current { get; }
  • public double Max { get; }
  • public double Total { get; }
  • public GaugeStats(double value)
  • public void Set(double value)
• public interface ICounterStats
  • double Rate { get; }
  • double RecentRate { get; }
  • long RecentValue { get; }
  • long Value { get; }
• public interface IGaugeStats
  • double Average { get; }
  • int Count { get; }
  • double Current { get; }
  • double Max { get; }
  • double Total { get; }
• public interface IHaveMetricName
  • string GetMetricName()
• public interface IHaveMetricStats
  • MetricStats GetMetricStats()
• public interface IMetricsClient : IDisposable
  • void Counter(string name, int value = 1)
  • void Gauge(string name, double value)
  • void Timer(string name, int milliseconds)
  • Task CounterAsync(string statName, int value = 1)
  • Task GaugeAsync(string statName, double value)
  • Task TimerAsync(string statName, long milliseconds)
• public interface IMetricsClientStats
• public class InMemoryMetricsClient : IMetricsClient, IDisposable
  • public IDictionary<string, CounterStats> Counters { get; }
  • public IDictionary<string, GaugeStats> Gauges { get; }
  • public IDictionary<string, TimingStats> Timings { get; }
  • public InMemoryMetricsClient(InMemoryMetricsClientOptions options)
  • public InMemoryMetricsClient(Builder<InMemoryMetricsClientOptionsBuilder, InMemoryMetricsClientOptions> config)
  • public Task CounterAsync(string statName, int value = 1)
  • public void DisplayStats(TextWriter writer = null)
  • public void Dispose()
  • public Task GaugeAsync(string statName, double value)
  • public long GetCount(string statName)
  • public double GetGaugeValue(string statName)
  • public MetricStats GetMetricStats()
  • public void Reset()
  • public void StartDisplayingStats(TimeSpan? interval = default, TextWriter writer = null)
  • public void StopDisplayingStats()
  • public Task TimerAsync(string statName, long milliseconds)
  • public Task<bool> WaitForCounterAsync(string statName, long count = 1, TimeSpan? timeout = default)
  • public Task<bool> WaitForCounterAsync(string statName, Func<Task> work, long count = 1, CancellationToken cancellationToken = default)
• public class InMemoryMetricsClientOptions : SharedMetricsClientOptions
• public class InMemoryMetricsClientOptionsBuilder : SharedMetricsClientOptionsBuilder<InMemoryMetricsClientOptions, InMemoryMetricsClientOptionsBuilder>
• public struct MetricKey : IEquatable<MetricKey>
• public interface ITimingStats
  • double Average { get; }
  • int Count { get; }
  • long Current { get; }
  • long Max { get; }
  • long Min { get; }
  • long Total { get; }
• public static class MetricsClientExtensions
  • public static Task TimeAsync(this IMetricsClient client, Func<Task> action, string name)
  • public static Task<T> TimeAsync<T>(this IMetricsClient client, Func<Task<T>> func, string name)
  • public static T Time<T>(this IMetricsClient client, Func<T> func, string statName)
• public static class MetricsClientStatsExtensions
• public class MetricStats
  • public IDictionary<string, ICounterStats> Counters { get; set; }
  • public IDictionary<string, IGaugeStats> Gauges { get; set; }
  • public IDictionary<string, ITimingStats> Timings { get; set; }
  • public MetricStats()
• public class NullMetricsClient : IMetricsClient, IDisposable
• public class SharedMetricsClientOptions : SharedOptions
• public class SharedMetricsClientOptionsBuilder<TOption, TBuilder> : SharedOptionsBuilder<TOption, TBuilder> where TOption : SharedMetricsClientOptions where TBuilder : SharedMetricsClientOptionsBuilder<TOption, TBuilder>
• public class StatsDMetricsClient : IMetricsClient, IDisposable
  • public StatsDMetricsClient(StatsDMetricsClientOptions options)
  • public StatsDMetricsClient(Builder<StatsDMetricsClientOptionsBuilder, StatsDMetricsClientOptions> config)
  • public void Counter(string name, int value = 1)
  • public StatsDMetricsClient(string serverName = "127.0.0.1", int port = 8125, string prefix = null)
  • public Task CounterAsync(string statName, int value = 1)
  • public void Gauge(string name, double value)
  • public void Timer(string name, int milliseconds)
  • public Task GaugeAsync(string statName, double value)
  • public Task TimerAsync(string statName, long milliseconds)
• public class StatsDMetricsClientOptions : SharedMetricsClientOptions
• public class StatsDMetricsClientOptionsBuilder : SharedMetricsClientOptionsBuilder<StatsDMetricsClientOptions, StatsDMetricsClientOptionsBuilder>
• public class TimingStat
• public class TimingStatSummary
• public class TimingStats : ITimingStats
  • public double Average { get; }
  • public int Count { get; }
  • public long Current { get; }
  • public long Max { get; }
  • public long Min { get; }
  • public long Total { get; }
  • public TimingStats(long value)
  • public void Set(long value)

Foundatio.Queues

• public class AbandonedEventArgs<T> : EventArgs
  • public IQueueEntry<T> Entry { get; set; }
  • public QueueEntryMetadata Metadata { get; set; }
• public class CompletedEventArgs<T> : EventArgs
  • public IQueueEntry<T> Entry { get; set; }
  • public QueueEntryMetadata Metadata { get; set; }
• public class DequeuedEventArgs<T> : EventArgs
  • public IQueueEntry<T> Entry { get; set; }
  • public T Data { get; set; }
  • public QueueEntryMetadata Metadata { get; set; }
• public class DuplicateDetectionQueueBehavior<T> : QueueBehaviorBase<T>
• public class EnqueuedEventArgs<T> : EventArgs
  • public IQueueEntry<T> Entry { get; set; }
  • public T Data { get; set; }
  • public QueueEntryMetadata Metadata { get; set; }
• public class EnqueuingEventArgs<T> : CancelEventArgs
  • public QueueEntryOptions Options { get; set; }
• public interface IHaveUniqueIdentifier
• public class InMemoryQueue<T> : QueueBase<T>
  • public InMemoryQueue()
  • public InMemoryQueue(InMemoryQueueOptions<T> options)
  • public InMemoryQueue(Builder<InMemoryQueueOptionsBuilder<T>, InMemoryQueueOptions<T>> config)
  • public IReadOnlyCollection<QueueEntry<T>> GetEntries()
  • public InMemoryQueue(int retries = 2, TimeSpan? retryDelay = default, int[] retryMultipliers = null, TimeSpan? workItemTimeout = default, ISerializer serializer = null, IEnumerable<IQueueBehavior<T>> behaviors = null)
• public class InMemoryQueueOptions<T> : SharedQueueOptions<T>
• public class InMemoryQueueOptionsBuilder<T> : SharedQueueOptionsBuilder<T, InMemoryQueueOptions<T>, InMemoryQueueOptionsBuilder<T>>
• public interface IQueue : IHaveSerializer, IDisposable
• public interface IQueue<T> : IHaveSerializer, IDisposable
  • AsyncEvent<LockRenewedEventArgs<T>> LockRenewed { get; }
  • Task AbandonAsync(IQueueEntry<T> queueEntry)
  • string QueueId { get; }
  • Task AbandonAsync(string id)
  • Task CompleteAsync(IQueueEntry<T> queueEntry)
  • Task<IQueueEntry<T>> DequeueAsync(CancellationToken cancellationToken)
  • Task<IQueueEntry<T>> DequeueAsync(TimeSpan? timeout = default)
  • Task<string> EnqueueAsync(T data, QueueEntryOptions options = null)
  • Task CompleteAsync(string id)
  • Task DeleteQueueAsync()
  • Task<QueueEntry<T>> DequeueAsync(CancellationToken cancellationToken = default)
  • Task<string> EnqueueAsync(T data)
  • Task RenewLockAsync(IQueueEntry<T> queueEntry)
  • Task StartWorkingAsync(Func<IQueueEntry<T>, CancellationToken, Task> handler, bool autoComplete = false, CancellationToken cancellationToken = default)
  • Task<QueueStats> GetQueueStatsAsync()
  • void StartWorking(Func<QueueEntry<T>, CancellationToken, Task> handler, bool autoComplete = false, CancellationToken cancellationToken = default)
• public interface IQueueActivity
• public interface IQueueEntry
• public interface IQueueEntry<T> : IQueueEntry
• public interface IQueueEntryMetadata
• public class LockRenewedEventArgs<T> : EventArgs
• public class MetricsQueueBehavior<T> : QueueBehaviorBase<T>
  • public MetricsQueueBehavior(IMetricsClient metrics, string metricsPrefix = null, TimeSpan? reportCountsInterval = default, ILoggerFactory loggerFactory = null)
  • public MetricsQueueBehavior(IMetricsClient metrics, string metricsPrefix = null)
  • protected string GetCustomMetricName(QueueEntryMetadata metadata)
  • protected string GetCustomMetricName(T data)
  • protected string GetSubMetricName(T data)
• public abstract class QueueBase<T, TOptions> : MaintenanceBase, IQueue<T>, IQueue, IHaveSerializer, IDisposable, IQueueActivity where TOptions : SharedQueueOptions<T>
• public abstract class QueueBase<T> : MaintenanceBase, IQueue<T>, IHaveSerializer, IDisposable
  • protected readonly List<IQueueBehavior<T>> _behaviors
  • protected readonly ISerializer _serializer
  • public AsyncEvent<AbandonedEventArgs<T>> Abandoned { get; }
  • public IReadOnlyCollection<IQueueBehavior<T>> Behaviors { get; }
  • public AsyncEvent<CompletedEventArgs<T>> Completed { get; }
  • public AsyncEvent<DequeuedEventArgs<T>> Dequeued { get; }
  • public AsyncEvent<EnqueuedEventArgs<T>> Enqueued { get; }
  • public AsyncEvent<EnqueuingEventArgs<T>> Enqueuing { get; }
  • public string QueueId { get; protected set; }
  • public QueueBase(ISerializer serializer, IEnumerable<IQueueBehavior<T>> behaviors)
  • public abstract Task AbandonAsync(string id)
  • public void AttachBehavior(IQueueBehavior<T> behavior)
  • public abstract Task CompleteAsync(string id)
  • public abstract Task DeleteQueueAsync()
  • public abstract Task<QueueEntry<T>> DequeueAsync(CancellationToken cancellationToken = default)
  • public abstract Task<string> EnqueueAsync(T data)
  • public abstract Task<IEnumerable<T>> GetDeadletterItemsAsync(CancellationToken cancellationToken = default)
  • public abstract Task<QueueStats> GetQueueStatsAsync()
  • protected virtual Task OnAbandonedAsync(string id)
  • protected virtual Task OnCompletedAsync(string id)
  • protected virtual Task OnDequeuedAsync(QueueEntry<T> entry)
  • protected virtual Task OnEnqueuedAsync(T data, string id)
  • protected virtual Task<bool> OnEnqueuingAsync(T data)
  • public abstract void StartWorking(Func<QueueEntry<T>, CancellationToken, Task> handler, bool autoComplete = false, CancellationToken cancellationToken = default)
• public abstract class QueueBehaviorBase<T> : IQueueBehavior<T>, IDisposable
  • protected virtual Task OnLockRenewed(object sender, LockRenewedEventArgs<T> dequeuedEventArgs)
• public class QueueEntry<T> : IDisposable
  • public string CorrelationId { get; }
  • public Type EntryType { get; }
  • public bool IsAbandoned { get; }
  • public bool IsCompleted { get; }
  • public TimeSpan ProcessingTime { get; set; }
  • public DataDictionary Properties { get; }
  • public DateTime RenewedTimeUtc { get; set; }
  • public TimeSpan TotalTime { get; set; }
  • public QueueEntry(string id, string correlationId, T value, IQueue<T> queue, DateTime enqueuedTimeUtc, int attempts)
  • public QueueEntry(string id, T value, IQueue<T> queue, DateTime enqueuedTimeUtc, int attempts)
  • public ValueTask DisposeAsync()
  • public object GetValue()
  • public Task RenewLockAsync()
  • public virtual void Dispose()
  • public QueueEntryMetadata ToMetadata()
• public class QueueEntryOptions
• public class QueueEntryMetadata
  • public int Attempts { get; set; }
  • public DataDictionary Data { get; set; }
  • public DateTime DequeuedTimeUtc { get; set; }
  • public DateTime EnqueuedTimeUtc { get; set; }
  • public string Id { get; set; }
  • public TimeSpan ProcessingTime { get; set; }
  • public QueueEntryMetadata()
• public static class QueueExtensions
  • public static Task StartWorkingAsync<T>(this IQueue<T> queue, Func<IQueueEntry<T>, Task> handler, bool autoComplete = false, CancellationToken cancellationToken = default)
  • public static Task<QueueEntry<T>> DequeueAsync<T>(this IQueue<T> queue, TimeSpan? timeout = default)
  • public static void StartWorking<T>(this IQueue<T> queue, Func<QueueEntry<T>, Task> handler, bool autoComplete = false, CancellationToken cancellationToken = default)
• public class QueueStatSummary
• public class SharedQueueOptions<T> : SharedOptions
• public class SharedQueueOptionsBuilder<T, TOptions, TBuilder> : SharedOptionsBuilder<TOptions, TBuilder> where TOptions : SharedQueueOptions<T> where TBuilder : SharedQueueOptionsBuilder<T, TOptions, TBuilder>

Foundatio.Serializer

• public static class DefaultSerializer
• public interface ISerializer
  • object Deserialize(Stream data, Type objectType)
  • void Serialize(object value, Stream output)
  • Task<object> DeserializeAsync(byte[] data, Type objectType)
  • Task<byte[]> SerializeAsync(object value)
• public interface ITextSerializer : ISerializer
• public class ObjectToInferredTypesConverter : JsonConverter<object>
• public class JsonNetSerializer : ISerializer
  • protected readonly JsonSerializerSettings _settings
  • public JsonNetSerializer(JsonSerializerSettings settings = null)
  • public Task<object> DeserializeAsync(byte[] value, Type objectType)
  • public Task<byte[]> SerializeAsync(object value)
• public static class SerializerExtensions
  • public static T Deserialize<T>(this ISerializer serializer, Stream data)
  • public static T Deserialize<T>(this ISerializer serializer, byte[] data)
  • public static object Deserialize(this ISerializer serializer, byte[] data, Type objectType)
  • public static T Deserialize<T>(this ISerializer serializer, string data)
  • public static object Deserialize(this ISerializer serializer, string data, Type objectType)
  • public static byte[] SerializeToBytes<T>(this ISerializer serializer, T value)
  • public static string SerializeToString<T>(this ISerializer serializer, T value)
  • public static Task<object> DeserializeAsync(this ISerializer serializer, string data, Type objectType)
  • public static Task<T> DeserializeAsync<T>(this ISerializer serializer, byte[] data)
  • public static Task<T> DeserializeAsync<T>(this ISerializer serializer, string data)
  • public static Task<string> SerializeToStringAsync(this ISerializer serializer, object value)
• public class SystemTextJsonSerializer : ITextSerializer, ISerializer

Foundatio.ServiceProviders

• public class ActivatorServiceProvider : IServiceProvider
  • public ActivatorServiceProvider()
  • public object GetService(Type serviceType)
• public abstract class BootstrappedServiceProviderBase : IBootstrappedServiceProvider, IServiceProvider
  • protected BootstrappedServiceProviderBase()
  • public abstract IServiceProvider Bootstrap()
  • public object GetService(Type serviceType)
• public interface IBootstrappedServiceProvider : IServiceProvider
  • IServiceProvider Bootstrap()
• public static class ServiceProvider
  • public static IServiceProvider Current { get; set; }
  • public static void SetServiceProvider(string serviceProviderTypeName, string[] typeNamesToSearch)
  • public static void SetServiceProvider(Type serviceProviderOrJobType)
  • public static void SetServiceProvider(Assembly[] assembliesToSearch)

Foundatio.Storage

• public class ActionableStream : Stream
• public static class FileStorageExtensions
  • public static Task<IReadOnlyCollection<FileSpec>> GetFileListAsync(this IFileStorage storage, string searchPattern = null, int? limit = default, CancellationToken cancellationToken = default)
• public class FolderFileStorage : IFileStorage, IDisposable
  • protected readonly ILogger _logger
  • public FolderFileStorage(FolderFileStorageOptions options)
  • public FolderFileStorage(Builder<FolderFileStorageOptionsBuilder, FolderFileStorageOptions> config)
  • public FolderFileStorage(string folder)
  • public Task<int> DeleteFilesAsync(string searchPattern = null, CancellationToken cancellation = default)
  • public Task<IEnumerable<FileSpec>> GetFileListAsync(string searchPattern = null, int? limit = default, int? skip = default, CancellationToken cancellationToken = default)
  • public Task<PagedFileListResult> GetPagedFileListAsync(int pageSize = 100, string searchPattern = null, CancellationToken cancellationToken = default)
• public class FolderFileStorageOptions : SharedOptions
• public class FolderFileStorageOptionsBuilder : SharedOptionsBuilder<FolderFileStorageOptions, FolderFileStorageOptionsBuilder>
• public interface IFileStorage : IDisposable
  • Task<int> DeleteFilesAsync(string searchPattern = null, CancellationToken cancellation = default)
  • Task<IEnumerable<FileSpec>> GetFileListAsync(string searchPattern = null, int? limit = default, int? skip = default, CancellationToken cancellationToken = default)
  • Task<PagedFileListResult> GetPagedFileListAsync(int pageSize = 100, string searchPattern = null, CancellationToken cancellationToken = default)
• public interface IHasNextPageFunc
• public class InMemoryFileStorage : IFileStorage, IDisposable
  • public InMemoryFileStorage(InMemoryFileStorageOptions options)
  • public InMemoryFileStorage(Builder<InMemoryFileStorageOptionsBuilder, InMemoryFileStorageOptions> config)
  • public InMemoryFileStorage(long maxFileSize, int maxFiles)
  • public Task<int> DeleteFilesAsync(string searchPattern = null, CancellationToken cancellation = default)
  • public Task<IEnumerable<FileSpec>> GetFileListAsync(string searchPattern = null, int? limit = default, int? skip = default, CancellationToken cancellationToken = default)
  • public Task<PagedFileListResult> GetPagedFileListAsync(int pageSize = 100, string searchPattern = null, CancellationToken cancellationToken = default)
• public class InMemoryFileStorageOptions : SharedOptions
• public class InMemoryFileStorageOptionsBuilder : SharedOptionsBuilder<InMemoryFileStorageOptions, InMemoryFileStorageOptionsBuilder>
• public class NextPageResult
• public class PagedFileListResult : IHasNextPageFunc
• public class ScopedFileStorage : IFileStorage, IHaveSerializer, IDisposable

Foundatio.Utility

• public static class Async
• public class AsyncEvent<TEventArgs> : IObservable<TEventArgs> where TEventArgs : EventArgs
  • public bool HasHandlers { get; }
  • public void Dispose()
• public static class ConnectionStringParser
• public class DataDictionary : Dictionary<string, object>
  • public static readonly DataDictionary Empty
  • public void ConvertJObjectToDataDictionary()
  • public void RemoveSensitiveData()
• public sealed class DisposableAction : IDisposable
• public class EmptyLock : ILock, IDisposable
  • public DateTime AcquiredTimeUtc { get; }
  • public string LockId { get; }
  • public int RenewalCount { get; }
  • public string Resource { get; }
  • public TimeSpan TimeWaitedForLock { get; }
  • public ValueTask DisposeAsync()
  • public Task ReleaseAsync()
  • public void Dispose()
• public interface IAsyncLifetime : IAsyncDisposable
• public interface IHaveLogger
• public interface ISystemClock
• public static class LoggerExtensions
• public class MaintenanceBase : IDisposable
  • protected readonly ILogger _logger
  • public MaintenanceBase(ILoggerFactory loggerFactory)
  • public MaintenanceBase()
  • protected virtual Task<DateTime?> DoMaintenanceAsync()
  • protected void InitializeMaintenance(TimeSpan? dueTime = default, TimeSpan? intervalTime = default)
  • protected virtual Task<DateTime> DoMaintenanceAsync()
  • protected void InitializeMaintenance()
• public static class ObjectExtensions
• public static class PathHelper
• public class RealSystemClock : ISystemClock
• public static class Run
• public class ScheduledTimer : IDisposable
• public static class SystemClock
• public class TestSystemClock
• public static class TimeExtensions
• public static class TimeUnit
• public class TraceTextWriter : TextWriter
  • public TraceTextWriter()
  • public TraceTextWriter(string category)
• public static class TypeHelper
  • public static readonly Type BoolType
  • public static readonly Type ByteArrayType
  • public static readonly Type ByteType
  • public static readonly Type CharType
  • public static readonly Type DateTimeType
  • public static readonly Type DecimalType
  • public static readonly Type DoubleType
  • public static readonly Type Int16Type
  • public static readonly Type Int32Type
  • public static readonly Type Int64Type
  • public static readonly Type NullableBoolType
  • public static readonly Type NullableCharType
  • public static readonly Type NullableDateTimeType
  • public static readonly Type ObjectType
  • public static readonly Type SByteType
  • public static readonly Type SingleType
  • public static readonly Type StringType
  • public static readonly Type UInt16Type
  • public static readonly Type UInt32Type
  • public static readonly Type UInt64Type
  • public static IEnumerable<Type> GetDerivedTypes<TAction>(IEnumerable<Assembly> assemblies = null)
  • public static string GetTypeDisplayName(Type type)
  • public static Type ResolveType(string fullTypeName, Type expectedBase = null, ILogger logger = null)
  • public static Type ResolveType(string fullTypeName, Type expectedBase = null)

Microsoft.Extensions.Logging

• public static class LoggerExtensions
• public class LogState : IEnumerable<KeyValuePair<string, object>>, IEnumerable