OperationBehaviorAttribute.ReleaseInstanceMode Property

 

Gets or sets a value that indicates when in the course of an operation invocation to recycle the service object.

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

member ReleaseInstanceMode : ReleaseInstanceMode with get, set

Property Value

Type: System.ServiceModel.ReleaseInstanceMode

One of the ReleaseInstanceMode values. The default is None.

Exception Condition
ArgumentOutOfRangeException

The value is not one of the ReleaseInstanceMode values.

Use the ReleaseInstanceMode property to specify when Windows Communication Foundation (WCF) recycles a service object in the course of executing a method. The default behavior is to recycle a service object according to the InstanceContextMode value. Setting the ReleaseInstanceMode property changes that default behavior.

The ReleaseInstanceMode makes no threading guarantees. If you must have a new, unmodified object when your service runs, set the InstanceContextMode property to PerCall.

In transaction scenarios, the ReleaseInstanceMode property is often used to ensure that old data associated with the service object is cleaned up prior to processing a method call. You can also ensure that service objects associated with transactions are recycled after the transaction successfully completes by setting the ReleaseServiceInstanceOnTransactionComplete property to true.

You can choose the following behaviors:

  • Recycle a service object before an operation is called.

  • Recycle a service object after an operation is called.

  • Recycle a service object both before and after an operation is called.

  • No recycling behavior.

You can also use OperationBehaviorAttribute to configure a callback contract operation in a duplex client application. When used on a callback operation, the ReleaseInstanceMode property must be None or an InvalidOperationException exception is thrown at runtime.

In addition, it is important to realize that if the service is created by passing a service object to the ServiceHost.ServiceHost(Object, Uri[]) constructor, the value of this property is treated as if it were None.

The following example code shows the use of ReleaseInstanceMode to recycle service objects both before and after a call.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top
Show: