SoapServerFormatterSinkProvider Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Provides the implementation for a server formatter channel sink provider that uses the SoapFormatter.

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


type SoapServerFormatterSinkProvider = 
        interface IServerFormatterSinkProvider
        interface IServerChannelSinkProvider


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

System_CAPS_pubmethodSoapServerFormatterSinkProvider(IDictionary, ICollection)

Initializes a new instance of the SoapServerFormatterSinkProvider class with the provided properties and provider data.


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


Gets or sets the TypeFilterLevel value of automatic deserialization the SoapServerFormatterSink performs.


Creates a sink chain.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Returns the channel data for the channel that the current sink is associated with.


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

Channel sinks are connected to a server channel through implementations of the IServerChannelSinkProvider interface. All the remoting server channels provide constructors that take a IServerChannelSinkProvider as a parameter.

Channel sink providers are stored in a chain, and the user is responsible for chaining all channel sink providers together before passing the outer one to the channel constructor. IServerChannelSinkProvider provides a property called Next for this purpose.

When multiple channel sink providers are specified in a configuration file, the remoting infrastructure will chain them together in the order they are found in the configuration file. The channel sink providers and the channels are created during the RemotingConfiguration.Configure call.

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.




Specifies whether the formatter will include versioning information. Values are true or false.

System_CAPS_security Security Note

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 Untrusted Data Security Risks.

.NET Framework
Available since 1.1

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

System.Runtime.Remoting.Channels Namespace

Return to top