aspnetcore/src/Microsoft.AspNet.Mvc.Core/IActionDescriptorsCollectio...

25 lines
1.1 KiB
C#

// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
namespace Microsoft.AspNet.Mvc
{
/// <summary>
/// Provides the currently cached collection of <see cref="ActionDescriptor"/>.
/// </summary>
/// <remarks>
/// The default implementation, does not update the cache, it is up to the user
/// to create or use an implementation that can update the available actions in
/// the application. The implementor is also responsible for updating the
/// <see cref="ActionDescriptorsCollection.Version"/> in a thread safe way.
///
/// Default consumers of this service, are aware of the version and will recache
/// data as appropriate, but rely on the version being unique.
/// </remarks>
public interface IActionDescriptorsCollectionProvider
{
/// <summary>
/// Returns the current cached <see cref="ActionDescriptorsCollection"/>
/// </summary>
ActionDescriptorsCollection ActionDescriptors { get; }
}
}