Class ApplicationConfiguration

Orleans application configuration parameters.

Inheritance
System.Object
ApplicationConfiguration
Namespace: Orleans.Runtime.Configuration
Assembly: Orleans.Core.Legacy.dll
Syntax
public class ApplicationConfiguration : object

Constructors

| Improve this Doc View Source

ApplicationConfiguration(Nullable<TimeSpan>)

Constructor.

Declaration
public ApplicationConfiguration(TimeSpan? defaultCollectionAgeLimit = null)
Parameters
Type Name Description
System.Nullable<TimeSpan> defaultCollectionAgeLimit

The default time period used to collect in-active activations.

Properties

| Improve this Doc View Source

ClassSpecific

IEnumerable of all configurations for different grain types.

Declaration
public IEnumerable<GrainTypeConfiguration> ClassSpecific { get; }
Property Value
Type Description
IEnumerable<GrainTypeConfiguration>
| Improve this Doc View Source

DefaultCollectionAgeLimit

The default time period used to collect in-active activations. Applies to all grain types.

Declaration
public TimeSpan DefaultCollectionAgeLimit { get; }
Property Value
Type Description
TimeSpan

Methods

| Improve this Doc View Source

GetCollectionAgeLimit(String)

Returns the time period used to collect in-active activations of a given type.

Declaration
public TimeSpan GetCollectionAgeLimit(string grainTypeFullName)
Parameters
Type Name Description
System.String grainTypeFullName

Grain type full name.
Returns
Type Description
TimeSpan
| Improve this Doc View Source

GetCollectionAgeLimit(Type)

Returns the time period used to collect in-active activations of a given type.

Declaration
public TimeSpan GetCollectionAgeLimit(Type type)
Parameters
Type Name Description
Type type

Grain type.
Returns
Type Description
TimeSpan
| Improve this Doc View Source

Load(XmlElement)

Load this configuratin from xml element.

Declaration
public void Load(XmlElement xmlElement)
Parameters
Type Name Description
XmlElement xmlElement
| Improve this Doc View Source

ResetCollectionAgeLimitToDefault(String)

Resets the time period to collect in-active activations for a given type to a default value.

Declaration
public void ResetCollectionAgeLimitToDefault(string grainTypeFullName)
Parameters
Type Name Description
System.String grainTypeFullName

Grain type full name.
| Improve this Doc View Source

ResetCollectionAgeLimitToDefault(Type)

Resets the time period to collect in-active activations for a given type to a default value.

Declaration
public void ResetCollectionAgeLimitToDefault(Type type)
Parameters
Type Name Description
Type type

Grain type full name.
| Improve this Doc View Source

SetCollectionAgeLimit(String, TimeSpan)

Sets the time period to collect in-active activations for a given type.

Declaration
public void SetCollectionAgeLimit(string grainTypeFullName, TimeSpan ageLimit)
Parameters
Type Name Description
System.String grainTypeFullName

Grain type full name string.
TimeSpan ageLimit

The age limit to use.
| Improve this Doc View Source

SetCollectionAgeLimit(Type, TimeSpan)

Sets the time period to collect in-active activations for a given type.

Declaration
public void SetCollectionAgeLimit(Type type, TimeSpan ageLimit)
Parameters
Type Name Description
Type type

Grain type full name.
TimeSpan ageLimit

The age limit to use.
| Improve this Doc View Source

SetDefaultCollectionAgeLimit(TimeSpan)

Sets the default time period to collect in-active activations for all grain type.

Declaration
public void SetDefaultCollectionAgeLimit(TimeSpan ageLimit)
Parameters
Type Name Description
TimeSpan ageLimit

The age limit to use.
| Improve this Doc View Source

ToString()

Prints the current application configuration.

Declaration
public override string ToString()
Returns
Type Description
System.String

Extension Methods