Export (0) Print
Expand All

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)

public interface class IDispatchMessageInspector

The IDispatchMessageInspector type exposes the following members.

Public methodAfterReceiveRequestCalled after an inbound message has been received but before the message is dispatched to the intended operation.
Public methodBeforeSendReplyCalled after the operation has returned but before the reply message is sent.

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 Service Model Layer.

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


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

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

No code example is currently available or this language may not be supported.

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

No code example is currently available or this language may not be supported.

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

No code example is currently available or this language may not be supported.
            <add baseAddress="http://localhost:8080/SampleService" />

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

© 2014 Microsoft