Export (0) Print
Expand All

SoapClientFormatterSinkProvider Class

Provides the implementation for a client formatter sink provider.

System.Object
  System.Runtime.Remoting.Channels.SoapClientFormatterSinkProvider

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

public class SoapClientFormatterSinkProvider : IClientFormatterSinkProvider, 
	IClientChannelSinkProvider

The SoapClientFormatterSinkProvider type exposes the following members.

  NameDescription
Public methodSoapClientFormatterSinkProvider()Initializes a new instance of the SoapClientFormatterSinkProvider class with default values.
Public methodSoapClientFormatterSinkProvider(IDictionary, ICollection)Initializes a new instance of the SoapClientFormatterSinkProvider class with the given properties and provider data.
Top

  NameDescription
Public propertyNextGets or sets the next IClientChannelSinkProvider in the sink provider chain.
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 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

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.

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