This documentation is archived and is not being maintained.

SoapClientFormatterSink Class

Provides the implementation for a client formatter sink that uses the SoapFormatter.

System.Object
  System.Runtime.Remoting.Channels.SoapClientFormatterSink

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

public class SoapClientFormatterSink : IClientFormatterSink, 
	IMessageSink, IClientChannelSink, IChannelSinkBase

The SoapClientFormatterSink type exposes the following members.

  NameDescription
Public methodSoapClientFormatterSinkInitializes a new instance of the SoapClientFormatterSink class.
Top

  NameDescription
Public propertyNextChannelSinkGets the next IClientChannelSink in the sink chain.
Public propertyNextSinkGets the next IMessageSink in the sink chain.
Public propertyPropertiesGets a IDictionary of properties for the current channel sink.
Top

  NameDescription
Public methodAsyncProcessMessageAsynchronously processes the provided message.
Public methodAsyncProcessRequestRequests asynchronous processing of a method call on the current sink.
Public methodAsyncProcessResponseRequests asynchronous processing of a response to a method call on the current sink.
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 a hash function for a particular type. (Inherited from Object.)
Public methodGetRequestStreamReturns the Stream onto which the provided message is to be serialized.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodProcessMessageRequests message processing from the current sink.
Public methodSyncProcessMessageSynchronously processes the provided message.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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 need to 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.

Property

Description

includeVersions

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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: