IInstanceContextProvider Interface


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Implement to participate in the creation or choosing of a System.ServiceModel.InstanceContext object, especially to enable shared sessions.

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

public interface IInstanceContextProvider

System_CAPS_pubmethodGetExistingInstanceContext(Message, IContextChannel)

Called when a new message is received.

System_CAPS_pubmethodInitializeInstanceContext(InstanceContext, Message, IContextChannel)

Called when null is returned from the GetExistingInstanceContext method.


Called when all InstanceContext activities have completed to enable implementers to prevent the InstanceContext from being recycled.

System_CAPS_pubmethodNotifyIdle(InstanceContextIdleCallback, InstanceContext)

Called when the IsIdle method returns false to enable implementers to provide a callback to notify WCF when the InstanceContext object is finished.

Implement the IInstanceContextProvider interface to provide the appropriate System.ServiceModel.InstanceContext object to the system. Typically, this interface is implemented to support shared sessions, enable service instance pooling, control lifetimes of service instances, or to group contexts among clients.

For example, to implement sharing, insert a custom IInstanceContextProvider to decide which session or call from a client is associated with which InstanceContext object. For an example that demonstrates the sharing of instance contexts, see InstanceContextSharing.


When an IInstanceContextProvider is inserted into Windows Communication Foundation (WCF), the normal property that controls the creation of InstanceContext objects (the ServiceBehaviorAttribute.InstanceContextMode property) is no longer checked and has no effect.

A more generic mechanism by which you can initialize InstanceContext objects when created (for example, to attach custom extensions to each InstanceContext) is the System.ServiceModel.Dispatcher.IInstanceContextInitializer.

.NET Framework
Available since 3.0
Return to top