Skip to content

Commit

Permalink
Updates XML documentation to call out prereq of LoadShedding. (#5387)
Browse files Browse the repository at this point in the history
- Must have a registered implementation of `IHostEnvironmentStatistics` for `LoadShedding` to function.
  • Loading branch information
Kritner authored and sergeybykov committed Feb 22, 2019
1 parent 7f15878 commit 63374fd
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/Orleans.Core/Configuration/Options/LoadSheddingOptions.cs
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@

using Orleans.Statistics;

namespace Orleans.Configuration
{
public class LoadSheddingOptions
{
/// <summary>
/// Specifies whether or not load shedding in the client gateway and stream providers is enabled.
/// The default value is false, meaning that load shedding is disabled.
///
/// In addition to LoadSheddingEnabled being true, in order for the cluster to utilize LoadShedding
/// a valid <see cref="IHostEnvironmentStatistics"/> implementation must be registered within the ISiloHost.
/// </summary>
public bool LoadSheddingEnabled { get; set; }

Expand Down

0 comments on commit 63374fd

Please sign in to comment.