SoapClientFormatterSinkProvider Class

SoapClientFormatterSinkProvider Class

Provides the implementation for a client formatter sink provider.

For a list of all members of this type, see SoapClientFormatterSinkProvider Members.


[Visual Basic]
Public Class SoapClientFormatterSinkProvider
   Implements IClientFormatterSinkProvider, _
public class SoapClientFormatterSinkProvider :
   IClientFormatterSinkProvider, IClientChannelSinkProvider
public __gc class SoapClientFormatterSinkProvider : public
   IClientFormatterSinkProvider, IClientChannelSinkProvider
public class SoapClientFormatterSinkProvider implements
   IClientFormatterSinkProvider, IClientChannelSinkProvider

Thread Safety

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


A SoapClientFormatterSinkProvider creates client formatter sinks that use the SoapFormatter to serialize messages for the client channel through which remoting messages flow.

The function of the formatter sink is to generate the necessary headers and serialize the message to the stream. After reaching the formatter sink, the IMessage is forwarded to all sinks in the channel sink chain through the ProcessMessage or AsyncProcessRequest calls. At this stage the message has already been serialized and is provided as information only. Sinks that need to create or modify the message must be placed in the sink chain before the formatter. This can be achieved by implementing both the IMessageSink and IClientChannelSink interfaces. The formatter sink can be placed in the sink chain later.

Formatter sinks use sink configuration properties to configure the channel at run time. Sink properties can be specified in a configuration file, or programmatically, inside of an IDictionary. In a configuration file all values are represented by strings, but when building a property IDictionary programmatically, value types can be specified with their native values or with strings.

The following table shows the sink configuration properties that can be specified for the current sink provider.

Property Description
includeVersions true or false. Specifies whether the formatter will include versioning information.


Namespace: System.Runtime.Remoting.Channels

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Assembly: System.Runtime.Remoting (in System.Runtime.Remoting.dll)

See Also

SoapClientFormatterSinkProvider Members | System.Runtime.Remoting.Channels Namespace | BinaryFormatter | Channel and Formatter Configuration Properties | Sinks and Sink Chains

© 2016 Microsoft