Export (0) Print
Expand All

SoapServerFormatterSinkProvider Class

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

System.Object
  System.Runtime.Remoting.Channels.SoapServerFormatterSinkProvider

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

public class SoapServerFormatterSinkProvider : IServerFormatterSinkProvider, 
	IServerChannelSinkProvider

The SoapServerFormatterSinkProvider type exposes the following members.

  NameDescription
Public methodSoapServerFormatterSinkProvider()Initializes a new instance of the SoapServerFormatterSinkProvider class with default values.
Public methodSoapServerFormatterSinkProvider(IDictionary, ICollection)Initializes a new instance of the SoapServerFormatterSinkProvider class with the provided properties and provider data.
Top

  NameDescription
Public propertyNextGets or sets the next IServerChannelSinkProvider in the sink provider chain.
Public propertyTypeFilterLevelGets or sets the TypeFilterLevel value of automatic deserialization the SoapServerFormatterSink performs.
Top

  NameDescription
Public methodCreateSinkCreates a sink chain.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetChannelDataReturns the channel data for the channel that the current sink is associated with.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

Property

Description

includeVersions

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

Security noteSecurity 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

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.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.

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