Share via

SoapClientFormatterSinkProvider Class


Provides the implementation for a client formatter sink provider.

public ref class SoapClientFormatterSinkProvider : System::Runtime::Remoting::Channels::IClientFormatterSinkProvider
public class SoapClientFormatterSinkProvider : System.Runtime.Remoting.Channels.IClientFormatterSinkProvider
type SoapClientFormatterSinkProvider = class
    interface IClientFormatterSinkProvider
    interface IClientChannelSinkProvider
Public Class SoapClientFormatterSinkProvider
Implements IClientFormatterSinkProvider


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 a 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 Specifies whether the formatter will include versioning information. Values are true or false.


Using an instance of this object with untrusted data or across an unsecure channel is a security risk. Use this object only with trusted data and across a secure channel. For more information, see Validate All Inputs.



Initializes a new instance of the SoapClientFormatterSinkProvider class with default values.

SoapClientFormatterSinkProvider(IDictionary, ICollection)

Initializes a new instance of the SoapClientFormatterSinkProvider class with the given properties and provider data.



Gets or sets the next IClientChannelSinkProvider in the sink provider chain.


CreateSink(IChannelSender, String, Object)

Creates a sink chain.


Determines whether the specified object is equal to the current object.

(Inherited from Object)

Serves as the default hash function.

(Inherited from Object)

Gets the Type of the current instance.

(Inherited from Object)

Creates a shallow copy of the current Object.

(Inherited from Object)

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also