Class NCacheConfiguration

This class contains the client connection properties, e.g. client-request-timeout, connection-retries, retry-interval. These values are the same which can be configured through the client.ncconf file.

Inheritance
System.Object
NCacheConfiguration
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Alachisoft.NCache.DistributedCache.dll
Syntax
public class NCacheConfiguration

Properties

AppName

If different client applications are connected to a single server and face any connection failure, AppName identifies each different client application after the client reestablishes the connection.

Declaration
public string AppName { get; set; }
Property Value
Type Description
System.String

Client application name.

BindIP

Gets/Sets the IP for the client to be binded with.

Declaration
public string BindIP { get; set; }
Property Value
Type Description
System.String

The IP for the client to be binded with.

CacheName

It is the name of the cache.

Declaration
public string CacheName { get; set; }
Property Value
Type Description
System.String

Name of the cache.

ClientCacheSyncMode

Gets/Sets Enumeration to specify how the client cache is synchronized with the cluster caches through events.

Declaration
public ClientCacheSyncMode? ClientCacheSyncMode { get; set; }
Property Value
Type Description
System.Nullable<ClientCacheSyncMode>

Enumeration to specify how the client cache is synchronized with the cluster caches through events.

ClientRequestTimeOut

Clients operation timeout specified in seconds. Clients wait for the response from the server for this time. If the response is not received within this time, the operation is not successful. Based on the network conditions, the OperationTimeout value can be adjusted. The default value is 90 seconds.

Declaration
public TimeSpan? ClientRequestTimeOut { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>

Clients operation timeout specified in seconds.

CommandRetries

If client application sends request to server for any operation and a response is not received, then the number of retries it does until it gets a response, is defined here.

Declaration
public int? CommandRetries { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

If client application sends request to server for any operation and a response is not received, then the number of retries it will make until it gets a response, is defined here.

CommandRetryInterval

The client app does not get response against some operation call on server, the command retry interval defines the waiting period before the next attempt to send the operation the server is made. It is of type integer, defined in seconds.

Declaration
public TimeSpan? CommandRetryInterval { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>

In case if client app does not get a response against some operation call on server, the command retry interval defines the waiting period before the next attempt to send the operation the server is made.

ConnectionRetries

Number of tries to reestablish a broken connection between client and server.

Declaration
public int? ConnectionRetries { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Number of tries to reestablish a broken connection between client and server.

ConnectionTimeout

Client's connection timeout specified in seconds.

Declaration
public TimeSpan? ConnectionTimeout { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>

Client's connection timeout specified in seconds.

DefaultReadThruProvider

ID of Default Read Thru Provider.

Declaration
public string DefaultReadThruProvider { get; set; }
Property Value
Type Description
System.String

ID of Default Read Thru Provider.

DefaultWriteThruProvider

Gets/Sets ID of DefaultWriteThruProvider.

Declaration
public string DefaultWriteThruProvider { get; set; }
Property Value
Type Description
System.String

ID of DefaultWriteThruProvider.

EnableDetailLogs

Gets/Sets EnableLogs property. If set to true, the NCache logs will be enabled.

Declaration
public bool? EnableDetailLogs { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Boolean value representing status of EnableLogs property. If true is returned, NCache logs will be enabled.

EnableKeepAlive

Gets/Sets the keep alive flag.

Declaration
public bool? EnableKeepAlive { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Gets/Sets the keep alive flag.

EnableLogs

Gets/Sets EnableLogs property. If set to true, NCache logs will be enabled.

Declaration
public bool? EnableLogs { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Boolean value representing status of EnableLogs property. If true is returned, the NCache logs will be enabled.

ExceptionsEnabled

Gets/Sets ExceptionsEnabled property. If set to true, any exceptions that occurred will be thrown to the application.

Declaration
public bool? ExceptionsEnabled { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Returns a boolean value representing status of ExceptionsEnabled property. If true is returned, any exceptions that occurred will be thrown to the application.

KeepAliveInterval

Get/Sets the KeepAliveInterval, which will be in effect if the EnabledKeepAlive is set to true or is specified to be true from the client configuration. Note: If the value to be set is lesser than 1 or is greater than 7200 (2 hours in seconds), it will revert back 30 seconds, internally.

Declaration
public TimeSpan? KeepAliveInterval { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>

Gets/Sets the KeepAliveInterval, which will be in effect if the EnabledKeepAlive is set to true or is specified to be true from the client configuration.

LoadBalance

When this flag is set, client tries to connect to the optimum server, in terms of number of connected clients. This way approximately equal number of clients are connected to every node in the clustered cache and no single node is overburdened.

Declaration
public bool? LoadBalance { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

When this flag is set, client tries to connect to the optimum server in terms of number of connected clients.

Mode

Gets/Sets the cache mode (InProc/OutProc).

Declaration
public IsolationLevel? Mode { get; set; }
Property Value
Type Description
System.Nullable<IsolationLevel>

The cache mode (InProc/OutProc).

PrimaryUserCredentials

Gets/Sets the UserId and Password for the primary cache user. This information is required when security is enabled. If primary user authentication fails, SecondaryUserCredentials are tried.

Declaration
public Credentials PrimaryUserCredentials { get; set; }
Property Value
Type Description
Credentials

The UserId and Password for the primary cache user.

RequestTimeout

Time after which a new request forcefully releases the lock which is being held by an older request.

Declaration
public double? RequestTimeout { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

Time after which a new request forcefully releases the lock which is being held by an older request.

RetryConnectionDelay

The time after which client will try to reconnect to the server.

Declaration
public TimeSpan? RetryConnectionDelay { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>

The time after which client will try to reconnect to the server.

RetryInterval

Time in seconds to wait between two connection retries.

Declaration
public TimeSpan? RetryInterval { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>

Time, in seconds, to wait between two connection retries.

ServerList

Gets/Sets list of servers provided by user.

Declaration
public IList<ServerInfo> ServerList { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<ServerInfo>

List of servers provided by user.

WriteExceptionsToEventLog

Gets/Sets WriteExceptionsToEventLog property. If set to true, any exceptions that occurred in the session state module will be reported to event log.

Declaration
public bool? WriteExceptionsToEventLog { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Returns a boolean value representing status of WriteExceptionsToEventLog property. If true is returned, any exceptions that occurred in the session state module will be reported to event log.