ClientConfiguration Class

Definition

Namespace:

Orleans.Runtime.Configuration

Assembly:

Orleans.Core.Legacy.dll

Package:

Microsoft.Orleans.Core.Legacy v2.4.5

Caution

This type is obsolete and may be removed in a future release. Use configuration methods on ClientBuilder to configure specific types.

Orleans client configuration parameters.

[System.Obsolete("This type is obsolete and may be removed in a future release. Use configuration methods on ClientBuilder to configure specific types.")]
[System.Serializable]
public class ClientConfiguration : Orleans.Runtime.Configuration.MessagingConfiguration, Orleans.Runtime.Configuration.IStatisticsConfiguration

[<System.Obsolete("This type is obsolete and may be removed in a future release. Use configuration methods on ClientBuilder to configure specific types.")>]
[<System.Serializable>]
type ClientConfiguration = class
    inherit MessagingConfiguration
    interface IStatisticsConfiguration

Public Class ClientConfiguration
Inherits MessagingConfiguration
Implements IStatisticsConfiguration

Inheritance

Object

MessagingConfiguration

ClientConfiguration

Attributes

ObsoleteAttribute SerializableAttribute

Implements

IStatisticsConfiguration

Constructors

ClientConfiguration()

Initializes a new instance of 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
BufferPoolBufferSize	(Inherited from MessagingConfiguration)
BufferPoolMaxSize	(Inherited from MessagingConfiguration)
BufferPoolPreallocationSize	(Inherited from MessagingConfiguration)
ClientDropTimeout	(Inherited from MessagingConfiguration)
ClientName	The name of this client.
ClientSenderBuckets	(Inherited from MessagingConfiguration)
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.
CustomGatewayProviderAssemblyName
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.
DeploymentId	Obsolete. Deployment Id. This is the same as ClusterId and has been deprecated in favor of it.
DNSHostName	Gets the true host name, no IP address. It equals Dns.GetHostName()
DropExpiredMessages	(Inherited from MessagingConfiguration)
FallbackSerializationProvider	(Inherited from MessagingConfiguration)
GatewayListRefreshPeriod
GatewayProvider
Gateways	The list of 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.
GatewaySenderQueues	(Inherited from MessagingConfiguration)
LargeMessageWarningThreshold	The LargeMessageWarningThreshold attribute specifies when to generate a warning trace message for large messages. (Inherited from MessagingConfiguration)
LimitManager
MaxForwardCount	The MaxForwardCount attribute specifies the maximal number of times a message is being forwared from one silo to another. Forwarding is used internally by the tuntime as a recovery mechanism when silos fail and the membership is unstable. In such times the messages might not be routed correctly to destination, and runtime attempts to forward such messages a number of times before rejecting them. (Inherited from MessagingConfiguration)
MaxResendCount	(Inherited from MessagingConfiguration)
MaxSocketAge	(Inherited from MessagingConfiguration)
MaxSockets	(Inherited from MessagingConfiguration)
NetInterface	The Interface attribute specifies the name of the network interface to use to work out an IP address for this machine.
OpenConnectionTimeout	(Inherited from MessagingConfiguration)
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.
PreferedGatewayIndex
PreferredFamily
PropagateActivityId	Whether Trace.CorrelationManager.ActivityId settings should be propagated into grain calls.
ProviderConfigurations
ResendOnTimeout	(Inherited from MessagingConfiguration)
ResponseTimeout	(Inherited from MessagingConfiguration)
SerializationProviders	(Inherited from MessagingConfiguration)
ServiceId	Service Id.
SiloSenderQueues	(Inherited from MessagingConfiguration)
SourceFile	Gets the configuration source file path
StatisticsCollectionLevel
StatisticsLogWriteInterval
StatisticsPerfCountersWriteInterval
StatisticsProviderName
StatisticsWriteLogStatisticsToTable
TelemetryConfiguration
UseAdoNetSystemStore
UseAzureSystemStore

Methods

GetAllProviderConfigurations()	Retrieves an enumeration of all currently configured provider configurations.
Load(TextReader)
LoadFromFile(String)
LocalhostSilo(Int32)	Returns a ClientConfiguration object for connecting to a local silo (for testing).
RegisterStreamProvider(String, String, IDictionary<String,String>)	Registers a given stream provider.
RegisterStreamProvider<T>(String, IDictionary<String,String>)	Registers a given type of T where T is stream provider
StandardLoad()	Loads the configuration from the standard paths, looking up the directory hierarchy
ToString()	Returns a detailed human readable string that represents the current configuration. It does not contain every single configuration knob.
TryGetProviderConfiguration(String, String, IProviderConfiguration)	Retrieves an existing provider configuration

Extension Methods