This documentation is archived and is not being maintained.

DispatchRuntime Class

Exposes properties that can be used to modify default service behavior as well as attach custom objects that can modify how incoming messages are transformed into objects and dispatched to operations. This class cannot be inherited.


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

public sealed class DispatchRuntime

The DispatchRuntime type exposes the following members.

Public propertyAutomaticInputSessionShutdownGets or sets a value that specifies whether the service closes an input session when the client closes an output session.
Public propertyCallbackClientRuntimeGets the ClientRuntime object that represents the installation point for extensions to for outbound calls to a duplex callback endpoint.
Public propertyChannelDispatcherGets the ChannelDispatcher for this dispatch run-time object.
Public propertyConcurrencyModeGets or sets whether an instance of a service processes messages sequentially or concurrently.
Public propertyEndpointDispatcherGets the EndpointDispatcher for this dispatch runtime.
Public propertyExternalAuthorizationPoliciesGets or sets the external authorization policies that define a set of rules for authorizing a user, given a set of claims.
Public propertyIgnoreTransactionMessagePropertyGets or sets whether to ignore the TransactionMessageProperty.
Public propertyImpersonateCallerForAllOperationsGets or sets a value that controls whether the service attempts to impersonate using the credentials provided by the incoming message.
Public propertyInputSessionShutdownHandlersGets a collection of IInputSessionShutdown objects that can be used to add a custom handler to control how input sessions are closed.
Public propertyInstanceContextInitializersGets a collection of IInstanceContextInitializer objects that can be used to inspect or modify an InstanceContext object when it is first created.
Public propertyInstanceContextProviderGets or sets the IInstanceContextProvider to be used by the DispatchRuntime.
Public propertyInstanceProviderGets or sets an IInstanceProvider object that you can use to control the creation and destruction of service objects.
Public propertyMessageAuthenticationAuditLevelGets or sets a value that specifies whether successful message authentication events are written to the event log specified by SecurityAuditLogLocation.
Public propertyMessageInspectorsGets a collection of IDispatchMessageInspector objects that can be used to attach a custom message inspector for all incoming and outgoing messages across the endpoint.
Public propertyOperationsGets a collection of DispatchOperation objects that can be used to control the execution behavior of a particular operation.
Public propertyOperationSelectorGets or sets the IDispatchOperationSelector object that controls the selection of a destination DispatchOperation for a particular message.
Public propertyPreserveMessageGets or sets whether the message is preserved.
Public propertyPrincipalPermissionModeGets or sets a value that specifies how the CurrentPrincipal property is set.
Public propertyReleaseServiceInstanceOnTransactionCompleteGets or sets a value that specifies whether the service object is recycled after the transaction successfully completes.
Public propertyRoleProviderGets or sets the custom RoleProvider that is used by the DispatchRuntime.
Public propertySecurityAuditLogLocationGets or sets the location of the audit log.
Public propertyServiceAuthenticationManagerGets or sets the object that manages an authentication process for service operations.
Public propertyServiceAuthorizationAuditLevelGets or sets a value that controls what service authorization events are audited.
Public propertyServiceAuthorizationManagerGets the ServiceAuthorizationManager that provides authorization checking for the DispatchRuntime.
Public propertySingletonInstanceContextGets or sets the singleton IInstanceContextProvider to be used by the DispatchRuntime.
Public propertySuppressAuditFailureGets or sets a value that specifies whether to suppress non-critical exceptions that occur during the logging process.
Public propertySynchronizationContextGets or sets the synchronization context that is used to invoke the service operations.
Public propertyTransactionAutoCompleteOnSessionCloseGets or sets a value that specifies whether to automatically complete the current transaction when the session closes.
Public propertyTypeGets or sets the contract type.
Public propertyUnhandledDispatchOperationGets or sets the operation to which unrecognized messages are dispatched.
Public propertyValidateMustUnderstandGets or sets the value of ValidateMustUnderstand.

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.)

Use the DispatchRuntime class either to modify the default behavior of a service or individual endpoint, or to insert objects that implement custom modifications to one or both of the following service processes:

  1. The transformation of incoming messages into objects and releasing those objects as method invocations on a service object.

  2. The transformation of objects received from the response to a service operation invocation into outbound messages.

In , the channel and endpoint dispatchers are the service components responsible for accepting new channels, receiving messages, method dispatch and invocation, and response processing. Each endpoint exposed by a ServiceHost object has one endpoint dispatcher and an associated channel dispatcher; in addition, each client that participates in duplex communication also has an endpoint dispatcher and channel dispatcher for each callback endpoint.

The DispatchRuntime enables you to intercept and extend the channel or endpoint dispatcher for all messages across a particular contract, even when a message is not recognized. When a message arrives that does not match any messages declared in the contract it is dispatched to the operation that was returned by the UnhandledDispatchOperation property. To intercept or extend across all messages for a particular operation, see the DispatchOperation class.

There are four main areas of dispatcher extensibility exposed by the DispatchRuntime class:

  1. Dispatch components use the properties of the DispatchRuntime and those of the associated channel dispatcher returned by the ChannelDispatcher property to customize how the channel dispatcher accepts and closes channels. This category includes the ChannelInitializers and InputSessionShutdownHandlers properties.

  2. Message components are customized for each message processed. This category includes the MessageInspectors, OperationSelector, Operations, and the ErrorHandlers properties.

  3. Instance components customize the creation, lifetime, and disposal of instances of the service type. For more information about service object lifetimes, see the InstanceContextMode property. This category includes the InstanceContextInitializers and the InstanceProvider properties.

  4. Security-related components can use the following properties:

Typically custom extension objects are assigned to a DispatchRuntime property or inserted into a collection by a service behavior (an object that implements IServiceBehavior), a contract behavior (an object that implements IContractBehavior), or an endpoint behavior (an object that implements IEndpointBehavior). Then the installing behavior object is added to the appropriate collection of behaviors either programmatically or by implementing a custom BehaviorExtensionElement object to enable the behavior to be inserted using an application configuration file.

.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.