BinaryClientFormatterSinkProvider Class
Collapse the table of content
Expand the table of content

BinaryClientFormatterSinkProvider Class

Provides the implementation for the binary client formatter sink provider.

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

public class BinaryClientFormatterSinkProvider : IClientFormatterSinkProvider, IClientChannelSinkProvider
public class BinaryClientFormatterSinkProvider implements IClientFormatterSinkProvider, IClientChannelSinkProvider
public class BinaryClientFormatterSinkProvider implements IClientFormatterSinkProvider, IClientChannelSinkProvider

A BinaryClientFormatterSinkProvider creates client formatter sinks that use the BinaryFormatter 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 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. You can do this by implementing both the IMessageSink and IClientChannelSink interfaces. The formatter sink can then 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.




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


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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

© 2016 Microsoft