This documentation is archived and is not being maintained.

ChannelPoolSettings Class

Specifies quotas for channels that belong to a pool of channels used by a service endpoint.


Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public class ChannelPoolSettings

The ChannelPoolSettings type exposes the following members.

Public methodChannelPoolSettingsInitializes a new instance of the ChannelPoolSettings class.

Public propertyIdleTimeoutGet or sets the maximum interval of time for which the channels in the pool can be idle before being closed.
Public propertyLeaseTimeoutGets or sets the lifetime of a channel, after which it is closed.
Public propertyMaxOutboundChannelsPerEndpointGets or sets the maximum number of channels connecting to remote endpoints that can be initiated by the service.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Quotas are used as a policy mechanism to prevent the consumption of excessive resources. They prevent Denial of Service (DOS) attacks that are either malicious or unintentional. Use this class when setting channel quotas on a custom channel.

ChannelPoolSettings specifies three quotas:

  • IdleTimeout to specify the maximum interval of time for which the channels in the pool can be idle before being closed.

  • LeaseTimeout to specify the interval of time after which a channel, when returned to the pool, is closed.

  • MaxOutboundChannelsPerEndpoint to specify the maximum number of channels that can be stored in the pool for each remote endpoint.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.