Export (0) Print
Expand All

ServiceThrottlingBehavior Class

Configures run-time throughput settings that enable you to tune service performance.


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

public ref class ServiceThrottlingBehavior : IServiceBehavior

The ServiceThrottlingBehavior type exposes the following members.

Public methodServiceThrottlingBehaviorInitializes a new instance of the ServiceThrottlingBehavior class.

Public propertyMaxConcurrentCallsGets or sets a value that specifies the maximum number of messages actively processing across a ServiceHost.
Public propertyMaxConcurrentInstancesGets or sets a value that specifies the maximum number of InstanceContext objects in the service that can execute at one time.
Public propertyMaxConcurrentSessionsGets or sets a value that specifies the maximum number of sessions a ServiceHost object can accept at one time.

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 the default hash function. (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.)

Explicit interface implemetationPrivate methodIServiceBehavior::AddBindingParametersConfigures the bindings to support the service behavior.
Explicit interface implemetationPrivate methodIServiceBehavior::ApplyDispatchBehaviorConfigures the service to support the service behavior.
Explicit interface implemetationPrivate methodIServiceBehavior::ValidateValidates that the service and host can support the service behavior.

Use the ServiceThrottlingBehavior class to control various throughput settings that help prevent your application from running out of memory.

The MaxConcurrentCalls property limits the number of messages that currently process across a ServiceHost.

The MaxConcurrentInstances property limits the number of InstanceContext objects that execute at one time across a ServiceHost.

The MaxConcurrentSessions property limits the number of sessions a ServiceHost object can accept.

Because run-time load balancing requires experience running the application, using the ServiceThrottlingBehavior through an application configuration file is the most common method of modifying execution to maximize service performance.


A trace is written every time the value of these properties is reached. The first trace is written as a warning.

You can also set the values of this attribute by using the <serviceThrottling> element in an application configuration file.

The following code example shows the use of ServiceThrottlingBehavior from an application configuration file that sets the MaxConcurrentSessions, MaxConcurrentCalls, and MaxConcurrentInstances properties to 1 as an example. Real-world experience determines what the optimal settings are for any particular application.

No code example is currently available or this language may not be supported.
    <!-- use appSetting to configure base address provided by host -->
    <add key="baseAddress" value="http://localhost:8080/ServiceMetadata" />
        behaviorConfiguration="Throttled" >
            <add baseAddress="http://localhost:8080/SampleService"/>
        <behavior  name="Throttled">

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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