IDispatchMessageInspector Interface (System.ServiceModel.Dispatcher)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

IDispatchMessageInspector Interface

Defines the methods that enable custom inspection or modification of inbound and outbound application messages in service applications.

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

Syntax

Visual Basic (Declaration)

Public Interface IDispatchMessageInspector

Visual Basic (Usage)

Dim instance As IDispatchMessageInspector

public interface IDispatchMessageInspector

Visual C++

public interface class IDispatchMessageInspector

JScript

public interface IDispatchMessageInspector

Remarks

Implement IDispatchMessageInspector to inspect or modify inbound or outbound application messages either prior to dispatching a request message to an operation or before returning a reply message to a caller. There are a large number of scenarios that require intercepting messages prior to invoking the operation for which it is destined. For example, you can log incoming application messages or perform some feature based on a message header.

Typically, message inspectors are inserted by a service behavior (System.ServiceModel.Description..::.IServiceBehavior), an endpoint behavior (System.ServiceModel.Description..::.IEndpointBehavior), or a contract behavior (System.ServiceModel.Description..::.IContractBehavior). The behavior then adds the message inspector to the DispatchRuntime..::.MessageInspectors collection. For more information about extending the runtime using behaviors, see Extending ServiceHost and the Dispatcher.

The AfterReceiveRequest method enables custom behavior after receiving the message but before dispatching it to the intended operation.
The BeforeSendReply method enables custom behavior after the operation returns but before the reply is sent.

Note:
IDispatchMessageInspector objects are always called at the same point during message dispatch regardless of whether an operation is one-way or request-reply.

Examples

The following code example shows a basic IDispatchMessageInspector that writes a string to the console when it is invoked.

#region IDispatchMessageInspector Members
public object AfterReceiveRequest(ref System.ServiceModel.Channels.Message request, IClientChannel channel, InstanceContext instanceContext)
{
  Console.WriteLine("IDispatchMessageInspector.AfterReceiveRequest called.");
  return null;
}

public void BeforeSendReply(ref System.ServiceModel.Channels.Message reply, object correlationState)
{
  Console.WriteLine("IDispatchMessageInspector.BeforeSendReply called.");
}
#endregion

The following code example shows the implementation of an IServiceBehavior that adds the InspectorIDispatchMessageInspector to the DispatchRuntime..::.MessageInspectors collection.

#region IServiceBehavior Members
public void AddBindingParameters(
  ServiceDescription serviceDescription, 
  ServiceHostBase serviceHostBase, 
  System.Collections.ObjectModel.Collection<ServiceEndpoint> endpoints, 
  BindingParameterCollection bindingParameters
)
{ return; }

public void ApplyDispatchBehavior(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
{
  foreach (ChannelDispatcher chDisp in serviceHostBase.ChannelDispatchers)
  {
    foreach (EndpointDispatcher epDisp in chDisp.Endpoints)
    {
      epDisp.DispatchRuntime.MessageInspectors.Add(new Inspector());
      foreach (DispatchOperation op in epDisp.DispatchRuntime.Operations)
        op.ParameterInspectors.Add(new Inspector());
    }
  }
}

The following code example shows the use of an application configuration file to load the service behavior that inserts the InspectorIDispatchMessageInspector.

xml

<configuration>
  <system.serviceModel>
    <services>
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="inspectorBehavior">
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/SampleService" />
          </baseAddresses>
        </host>
        <endpoint
          address=""
          binding="wsHttpBinding"
          contract="Microsoft.WCF.Documentation.ISampleService"
        />

      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <behavior name="inspectorBehavior">
          <serviceInspectors />
        </behavior>
      </serviceBehaviors>
    </behaviors>
    <extensions>
      <behaviorExtensions>
        <add 
          name="serviceInspectors" 
          type="Microsoft.WCF.Documentation.InspectorInserter, HostApplication, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null"
        />
      </behaviorExtensions>
    </extensions>
  </system.serviceModel>
</configuration>

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

IDispatchMessageInspector Members

System.ServiceModel.Dispatcher Namespace