Class ClientConfiguration

Orleans client configuration parameters.

Inheritance

System.Object

ClientConfiguration

Implements

IStatisticsConfiguration

Namespace: Orleans.Runtime.Configuration

Assembly: Orleans.Core.Legacy.dll

Syntax

public class ClientConfiguration : MessagingConfiguration, IStatisticsConfiguration

Constructors

ClientConfiguration()

Initializes a new instance of ClientConfiguration.

Declaration

public ClientConfiguration()

Properties

AdoInvariant

When using ADO, identifies the underlying data provider for the gateway provider. This three-part naming syntax is also used when creating a new factory and for identifying the provider in an application configuration file so that the provider name, along with its associated connection string, can be retrieved at run time. https://msdn.microsoft.com/en-us/library/dd0w4a2z%28v=vs.110%29.aspx

Declaration

public string AdoInvariant { get; set; }

Property Value

Type	Description
System.String

ClientName

The name of this client.

Declaration

public string ClientName { get; set; }

Property Value

Type	Description
System.String

ClusterId

Specifies a unique identifier for this cluster. If the silos are deployed on Azure (run as workers roles), deployment id is set automatically by Azure runtime, accessible to the role via RoleEnvironment.DeploymentId static variable and is passed to the silo automatically by the role via config. So if the silos are run as Azure roles this variable should not be specified in the OrleansConfiguration.xml (it will be overwritten if specified). If the silos are deployed on the cluster and not as Azure roles, this variable should be set by a deployment script in the OrleansConfiguration.xml file.

Declaration

public string ClusterId { get; set; }

Property Value

Type	Description
System.String

CustomGatewayProviderAssemblyName

Declaration

public string CustomGatewayProviderAssemblyName { get; set; }

Property Value

Type	Description
System.String

DataConnectionString

Specifies the connection string for the gateway provider. If the silos are deployed on Azure (run as workers roles), DataConnectionString may be specified via RoleEnvironment.GetConfigurationSettingValue("DataConnectionString"); In such a case it is taken from there and passed to the silo automatically by the role via config. So if the silos are run as Azure roles and this config is specified via RoleEnvironment, this variable should not be specified in the OrleansConfiguration.xml (it will be overwritten if specified). If the silos are deployed on the cluster and not as Azure roles, this variable should be set in the OrleansConfiguration.xml file. If not set at all, DevelopmentStorageAccount will be used.

Declaration

public string DataConnectionString { get; set; }

Property Value

Type	Description
System.String

DeploymentId

Deployment Id. This is the same as ClusterId and has been deprecated in favor of it.

Declaration

public string DeploymentId { get; set; }

Property Value

Type	Description
System.String

DNSHostName

Gets the true host name, no IP address. It equals Dns.GetHostName()

Declaration

public string DNSHostName { get; }

Property Value

Type	Description
System.String

GatewayListRefreshPeriod

Declaration

public TimeSpan GatewayListRefreshPeriod { get; set; }

Property Value

Type	Description
TimeSpan

GatewayProvider

Declaration

public ClientConfiguration.GatewayProviderType GatewayProvider { get; set; }

Property Value

Type	Description
ClientConfiguration.GatewayProviderType

Gateways

The list fo the gateways to use. Each GatewayNode element specifies an outside grain client gateway node. If outside (non-Orleans) clients are to connect to the Orleans system, then at least one gateway node must be specified. Additional gateway nodes may be specified if desired, and will add some failure resilience and scalability. If multiple gateways are specified, then each client will select one from the list at random.

Declaration

public IList<IPEndPoint> Gateways { get; set; }

Property Value

Type	Description
IList<IPEndPoint>

LimitManager

Declaration

public LimitManager LimitManager { get; }

Property Value

Type	Description
LimitManager

NetInterface

The Interface attribute specifies the name of the network interface to use to work out an IP address for this machine.

Declaration

public string NetInterface { get; }

Property Value

Type	Description
System.String

Port

The Port attribute specifies the specific listen port for this client machine. If value is zero, then a random machine-assigned port number will be used.

Declaration

public int Port { get; }

Property Value

Type	Description
System.Int32

PreferedGatewayIndex

Declaration

public int PreferedGatewayIndex { get; set; }

Property Value

Type	Description
System.Int32

PreferredFamily

Declaration

public AddressFamily PreferredFamily { get; set; }

Property Value

Type	Description
AddressFamily

PropagateActivityId

Whether Trace.CorrelationManager.ActivityId settings should be propagated into grain calls.

Declaration

public bool PropagateActivityId { get; set; }

Property Value

Type	Description
System.Boolean

ProviderConfigurations

Declaration

public IDictionary<string, ProviderCategoryConfiguration> ProviderConfigurations { get; set; }

Property Value

Type	Description
IDictionary<System.String, ProviderCategoryConfiguration>

SourceFile

Gets the configuration source file path

Declaration

public string SourceFile { get; }

Property Value

Type	Description
System.String

StatisticsCollectionLevel

Declaration

public StatisticsLevel StatisticsCollectionLevel { get; set; }

Property Value

Type	Description
StatisticsLevel

StatisticsLogWriteInterval

Declaration

public TimeSpan StatisticsLogWriteInterval { get; set; }

Property Value

Type	Description
TimeSpan

StatisticsPerfCountersWriteInterval

Declaration

public TimeSpan StatisticsPerfCountersWriteInterval { get; set; }

Property Value

Type	Description
TimeSpan

StatisticsProviderName

Declaration

public string StatisticsProviderName { get; set; }

Property Value

Type	Description
System.String

StatisticsWriteLogStatisticsToTable

Declaration

public bool StatisticsWriteLogStatisticsToTable { get; set; }

Property Value

Type	Description
System.Boolean

TelemetryConfiguration

Declaration

public TelemetryConfiguration TelemetryConfiguration { get; }

Property Value

Type	Description
TelemetryConfiguration

UseAdoNetSystemStore

Declaration

public bool UseAdoNetSystemStore { get; }

Property Value

Type	Description
System.Boolean

UseAzureSystemStore

Declaration

public bool UseAzureSystemStore { get; }

Property Value

Type	Description
System.Boolean

Methods

GetAllProviderConfigurations()

Retrieves an enumeration of all currently configured provider configurations.

Declaration

public IEnumerable<IProviderConfiguration> GetAllProviderConfigurations()

Returns

Type	Description
IEnumerable<IProviderConfiguration>	An enumeration of all currently configured provider configurations.

Load(TextReader)

Declaration

public void Load(TextReader input)

Parameters

Type	Name	Description
TextReader	input

LoadFromFile(String)

Declaration

public static ClientConfiguration LoadFromFile(string fileName)

Parameters

Type	Name	Description
System.String	fileName

Returns

Type	Description
ClientConfiguration

LocalhostSilo(Int32)

Returns a ClientConfiguration object for connecting to a local silo (for testing).

Declaration

public static ClientConfiguration LocalhostSilo(int gatewayPort = 40000)

Parameters

Type	Name	Description
System.Int32	gatewayPort	Client gateway TCP port

Returns

Type	Description
ClientConfiguration	ClientConfiguration object that can be passed to GrainClient class for initialization

RegisterStreamProvider(String, String, IDictionary<String, String>)

Registers a given stream provider.

Declaration

public void RegisterStreamProvider(string providerTypeFullName, string providerName, IDictionary<string, string> properties = null)

Parameters

Type	Name	Description
System.String	providerTypeFullName	Full name of the stream provider type
System.String	providerName	Name of the stream provider
IDictionary<System.String, System.String>	properties	Properties that will be passed to the stream provider upon initialization

RegisterStreamProvider<T>(String, IDictionary<String, String>)

Registers a given type of T where T is stream provider

Declaration

public void RegisterStreamProvider<T>(string providerName, IDictionary<string, string> properties = null)where T : IStreamProvider

Parameters

Type	Name	Description
System.String	providerName	Name of the stream provider
IDictionary<System.String, System.String>	properties	Properties that will be passed to stream provider upon initialization

Type Parameters

Name	Description
T	Non-abstract type which implements IStreamProvider stream

StandardLoad()

Loads the configuration from the standard paths, looking up the directory hierarchy

Declaration

public static ClientConfiguration StandardLoad()

Returns

Type	Description
ClientConfiguration	Client configuration data if a configuration file was found.

ToString()

Returns a detailed human readable string that represents the current configuration. It does not contain every single configuration knob.

Declaration

public override string ToString()

Returns

Type	Description
System.String

TryGetProviderConfiguration(String, String, out IProviderConfiguration)

Retrieves an existing provider configuration

Declaration

public bool TryGetProviderConfiguration(string providerTypeFullName, string providerName, out IProviderConfiguration config)

Parameters

Type	Name	Description
System.String	providerTypeFullName	Full name of the stream provider type
System.String	providerName	Name of the stream provider
IProviderConfiguration	config	The provider configuration, if exists

Returns

Type	Description
System.Boolean	True if a configuration for this provider already exists, false otherwise.

Implements

IStatisticsConfiguration

Extension Methods

ImmutableExt.AsImmutable<T>(T)