Add some cool docs about IDynamicEndpointMetadata.
This will make James happy, which makes it more likely he will look at the rest of the PR.
This commit is contained in:
parent
48f0a76ea9
commit
94fab79771
|
|
@ -34,6 +34,18 @@ namespace Microsoft.AspNetCore.Routing
|
|||
/// </summary>
|
||||
/// <param name="endpoints">The set of endpoints.</param>
|
||||
/// <returns><c>true</c> if a dynamic endpoint is found; otherwise returns <c>false</c>.</returns>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The presence of <see cref="IDynamicEndpointMetadata"/> signifies that an endpoint that may be replaced
|
||||
/// during processing by an <see cref="IEndpointSelectorPolicy"/>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// An implementation of <see cref="INodeBuilderPolicy"/> should also implement <see cref="IEndpointSelectorPolicy"/>
|
||||
/// and use its <see cref="IEndpointSelectorPolicy"/> implementation when a node contains a dynamic endpoint.
|
||||
/// <see cref="INodeBuilderPolicy"/> implementations rely on caching of data based on a static set of endpoints. This
|
||||
/// is not possible when endpoints are replaced dynamically.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
protected static bool ContainsDynamicEndpoints(IReadOnlyList<Endpoint> endpoints)
|
||||
{
|
||||
if (endpoints == null)
|
||||
|
|
|
|||
Loading…
Reference in New Issue