This documentation is archived and is not being maintained.

ClientRuntime Class

The insertion point for classes that extend the functionality of Windows Communication Foundation (WCF) client objects for all messages handled by a client application.

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

Public NotInheritable Class ClientRuntime
Dim instance As ClientRuntime

WCF client objects, whether an extension of ClientBase(Of TChannel) or of IClientChannel, are used by Windows Communication Foundation (WCF) client applications to convert method calls into outbound messages and convert incoming messages to objects and pass them to the results of client methods.

The ClientRuntime class is an extensibility point to which you can add extension objects that intercept messages and extend client behavior across all operations. Interception objects can process all messages in a particular contract, process only messages for particular operations, perform custom channel initialization, and implement other custom client application behavior. For an overview of client architecture, see Client Architecture. For more information about client programming, see Consuming Services Using a Client. For details about customizations and how to perform them, see Extending Clients.

  • The CallbackDispatchRuntime property returns the dispatch run-time object for service-initiated callback operations.

  • The OperationSelector property accepts a custom operation selector object to control the routing of client messages.

  • The ChannelInitializers property enables the addition of a channel initializer that can inspect or modify the client channel.

  • The InteractiveChannelInitializers property can be used to display a visual prompt to enable a user to select credentials prior to opening the channel.

  • The Operations property gets a collection of ClientOperation objects to which you can add custom message interceptors that provide functionality specific to the messages of that operation.

  • The ManualAddressing property enables an application to turn off some automatic addressing headers to directly control addressing.

  • The MaxFaultSize property enables the client to limit the size of fault messages that the client accepts.

  • The MessageInspectors property gets a collection of IClientMessageInspector objects to which you can add custom message interceptors for all messages traveling through a client.

  • The UnhandledClientOperation property returns the operation to which unexpected messages are passed.

  • The ValidateMustUnderstand property informs the system whether it should confirm that SOAP headers marked as MustUnderstand have, in fact, been understood.

  • The Via property sets the value of the destination of the message at the transport level to support intermediaries and other scenarios.

In addition, there are a number of other properties that retrieve the client contract information:

If the client is a duplex client, the following properties also retrieve the client callback type and runtime:

In the following code example an System.ServiceModel.Description.IEndpointBehavior inserts a System.ServiceModel.Dispatcher.IClientMessageInspector into the client runtime by adding it to the MessageInspectors property.

#region IEndpointBehavior Members
public void AddBindingParameters(
  ServiceEndpoint endpoint, BindingParameterCollection bindingParameters
) { return; }

public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
  clientRuntime.MessageInspectors.Add(new Inspector());
  foreach (ClientOperation op in clientRuntime.Operations)
    op.ParameterInspectors.Add(new Inspector());

public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher)
  endpointDispatcher.DispatchRuntime.MessageInspectors.Add(new Inspector());
  foreach (DispatchOperation op in endpointDispatcher.DispatchRuntime.Operations)
    op.ParameterInspectors.Add(new Inspector());

public void Validate(ServiceEndpoint endpoint){ return; }

The following code example shows a configuration file that loads the endpoint behavior into the client endpoint.

    <behavior name="clientInspectorsAdded">
      <clientInterceptors />
      type="Microsoft.WCF.Documentation.InspectorInserter, HostApplication, Version=, Culture=neutral, PublicKeyToken=null"


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

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0