ClientRuntime Class

Definition

Namespace:

System.ServiceModel.Dispatcher

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Source:

ClientRuntime.cs

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

public ref class ClientRuntime sealed

public sealed class ClientRuntime

type ClientRuntime = class

Public NotInheritable Class ClientRuntime

Inheritance

Object

ClientRuntime

Examples

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; }

#Region "IEndpointBehavior Members"
    Public Sub AddBindingParameters(ByVal endpoint As ServiceEndpoint, ByVal bindingParameters _
                                    As BindingParameterCollection) Implements IEndpointBehavior.AddBindingParameters
        Return
    End Sub

    Public Sub ApplyClientBehavior(ByVal endpoint As ServiceEndpoint, ByVal clientRuntime As ClientRuntime) _
    Implements IEndpointBehavior.ApplyClientBehavior
        clientRuntime.MessageInspectors.Add(New Inspector())
        For Each op As ClientOperation In clientRuntime.Operations
            op.ParameterInspectors.Add(New Inspector())
        Next op
    End Sub

    Public Sub ApplyDispatchBehavior(ByVal endpoint As ServiceEndpoint, ByVal endpointDispatcher As  _
                                     EndpointDispatcher) Implements IEndpointBehavior.ApplyDispatchBehavior
        endpointDispatcher.DispatchRuntime.MessageInspectors.Add(New Inspector())
        For Each op As DispatchOperation In endpointDispatcher.DispatchRuntime.Operations
            op.ParameterInspectors.Add(New Inspector())
        Next op
    End Sub

Public Sub Validate(ByVal endpoint As ServiceEndpoint) Implements IEndpointBehavior.Validate
    Return
End Sub

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

  <client>
      <endpoint 
        address="http://localhost:8080/SampleService" 
        behaviorConfiguration="clientInspectorsAdded" 
        binding="wsHttpBinding"
        bindingConfiguration="WSHttpBinding_ISampleService" 
        contract="ISampleService"
        name="WSHttpBinding_ISampleService"
      >
      </endpoint>
  </client>
<behaviors>
  <endpointBehaviors>
    <behavior name="clientInspectorsAdded">
      <clientInterceptors />
    </behavior>
  </endpointBehaviors>
</behaviors>
<extensions>
  <behaviorExtensions>
    <add 
      name="clientInterceptors" 
      type="Microsoft.WCF.Documentation.InspectorInserter, HostApplication, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null"
  />
  </behaviorExtensions>
</extensions>

Remarks

WCF client objects, whether an extension of ClientBase<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 WCF Client Architecture. For more information about client programming, see Accessing Services Using a WCF 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:

• ContractName

• ContractNamespace

• ContractClientType

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

• CallbackClientType

• CallbackDispatchRuntime

Properties

CallbackDispatchRuntime	Gets the dispatch run-time that dispatches service-initiated operations.
ChannelInitializers	Gets a collection of channel initializer objects used to customize the channel associated with a client.
ClientMessageInspectors	Gets a collection of message inspector objects used to view or modify messages of a particular service operation.
ClientOperations	Gets a collection of client operation objects used to attach extension objects that inspect or modify messages and behavior of a particular service operation.
ContractClientType	Gets or sets the type of the contract associated with a client.
ContractName	Gets the name of the contract associated with a client.
ContractNamespace	Gets the namespace of the contract associated with a client.
InteractiveChannelInitializers	Gets a collection of an interactive channel initializer.
ManualAddressing	Gets or sets a value that indicates whether the client adds addressing headers to request-reply messages.
MaxFaultSize	Gets or sets the maximum fault size.
OperationSelector	Gets or sets an IClientOperationSelector implementation that can be used to select a ClientOperation.
UnhandledClientOperation	Gets the client operation for methods that do not have a corresponding ClientOperation in the Operations collection.
Via	Gets or sets the transport address that is used to send messages through the client.

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)