BinaryClientFormatterSink 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 client formatter sink that uses the BinaryFormatter.

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


Public Class BinaryClientFormatterSink
	Implements IClientFormatterSink, IMessageSink, IClientChannelSink,


Initializes a new instance of the BinaryClientFormatterSink class.


Gets the next IClientChannelSink in the sink chain.


Gets the next IMessageSink in the sink chain.


Gets a IDictionary of properties for the current channel sink.

System_CAPS_pubmethodAsyncProcessMessage(IMessage, IMessageSink)

Asynchronously processes the provided message.

System_CAPS_pubmethodAsyncProcessRequest(IClientChannelSinkStack, IMessage, ITransportHeaders, Stream)

Requests asynchronous processing of a method call on the current sink.

System_CAPS_pubmethodAsyncProcessResponse(IClientResponseChannelSinkStack, Object, ITransportHeaders, Stream)

Requests asynchronous processing of a response to a method call on the current sink.


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


Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetRequestStream(IMessage, ITransportHeaders)

Returns the Stream onto which the provided message is to be serialized.


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodProcessMessage(IMessage, ITransportHeaders, Stream, ITransportHeaders, Stream)

Requests message processing from the current sink.


Synchronously processes the provided message.


Returns a string that represents the current object.(Inherited from Object.)

The function of the formatter sink is to generate the necessary headers and serialize the message to the stream. After the formatter sink, the IMessage is forwarded to all sinks in the 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 is easily achieved by implementing the IClientFormatterSink interface, which gives the impression of having a reference to the formatter sink. The real formatter sink can then be placed later in the sink chain.




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.

Return to top