ServiceThrottlingBehavior Class

Reference

Definition

Namespace:: System.ServiceModel.Description

Assembly:: System.ServiceModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class ServiceThrottlingBehavior : System::ServiceModel::Description::IServiceBehavior

public class ServiceThrottlingBehavior : System.ServiceModel.Description.IServiceBehavior

type ServiceThrottlingBehavior = class
    interface IServiceBehavior

Public Class ServiceThrottlingBehavior
Implements IServiceBehavior

Inheritance: Object
ServiceThrottlingBehavior

Implements: IServiceBehavior

Examples

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.

<configuration>
  <appSettings>
    <!-- use appSetting to configure base address provided by host -->
    <add key="baseAddress" value="http://localhost:8080/ServiceMetadata" />
  </appSettings>
  <system.serviceModel>
    <services>
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="Throttled" >
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/SampleService"/>
          </baseAddresses>
        </host>
        <endpoint
          address=""
          binding="wsHttpBinding"
          contract="Microsoft.WCF.Documentation.ISampleService"
         />
        <endpoint
          address="mex"
          binding="mexHttpBinding"
          contract="IMetadataExchange"
         />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <behavior  name="Throttled">
          <serviceThrottling 
            maxConcurrentCalls="1" 
            maxConcurrentSessions="1" 
            maxConcurrentInstances="1"
          />
          <serviceMetadata 
            httpGetEnabled="true" 
            httpGetUrl=""
          />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Remarks

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.

Note

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.

Constructors

ServiceThrottlingBehavior()

Initializes a new instance of the ServiceThrottlingBehavior class.

Properties

MaxConcurrentCalls	Gets or sets a value that specifies the maximum number of messages actively processing across a ServiceHost.
MaxConcurrentInstances	Gets or sets a value that specifies the maximum number of InstanceContext objects in the service that can execute at one time.
MaxConcurrentSessions	Gets or sets a value that specifies the maximum number of sessions a ServiceHost object can accept at one time.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IServiceBehavior.AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)	Configures the bindings to support the service behavior.
IServiceBehavior.ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)	Configures the service to support the service behavior.
IServiceBehavior.Validate(ServiceDescription, ServiceHostBase)	Validates that the service and host can support the service behavior.

Applies to

Deila með