System.Runtime.Remoting.Channels.SoapServerFormatterSinkProvider Class

Summary

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

C# Syntax:

public class SoapServerFormatterSinkProvider : IServerFormatterSinkProvider, IServerChannelSinkProvider

Channel sinks are connected to a server channel through implementations of the IServerChannelSinkProvider interface. All the remoting server channels provide constructors that take an 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 IServerChannelSinkProvider.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 an 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	true or false . Specifies whether the formatter will include versioning information.

System.Runtime.Remoting.Channels Namespace See also:
MSDN: channelformatterconfigurationproperties | MSDN: sinkssinkchains

System.Runtime.Remoting.Channels.SoapServerFormatterSinkProvider Member List:

Public Constructors

ctor #1	Overloaded: .ctor() Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the SoapServerFormatterSinkProvider class with default values.
ctor #2	Overloaded: .ctor(IDictionary properties, ICollection providerData) Initializes a new instance of the SoapServerFormatterSinkProvider class with the provided properties and provider data.

Public Properties

Next	Read-write Gets or sets the next IServerChannelSinkProvider in the sink provider chain.

Public Methods

CreateSink	Creates a sink chain.
Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetChannelData	Returns the channel data for the channel that the current sink is associated with.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

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

System.Runtime.Remoting.Channels.SoapServerFormatterSinkProvider Member Details

Summary

Initializes a new instance of the SoapServerFormatterSinkProvider class with default values.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

public SoapServerFormatterSinkProvider();

Return to top

Summary

Initializes a new instance of the SoapServerFormatterSinkProvider class with the provided properties and provider data.

C# Syntax:

public SoapServerFormatterSinkProvider(    IDictionary properties,    ICollection providerData );

properties

An IDictionary of configuration properties to use with the new instance of SoapClientFormatterSinkProvider.

providerData

An ICollection of provider data to use with the new instance of SoapClientFormatterSinkProvider.

Return to top

Summary

Gets or sets the next IServerChannelSinkProvider in the sink provider chain.

C# Syntax:

public IServerChannelSinkProvider Next {get; set;}

Implements:

IServerChannelSinkProvider.Next

Return to top

Summary

Creates a sink chain.

C# Syntax:

public IServerChannelSink CreateSink(    IChannelReceiver channel );

channel

The channel for which to create the channel sink chain.

Return Value:

The first sink of the newly formed channel sink chain.

Implements:

IServerChannelSinkProvider.CreateSink

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~SoapServerFormatterSinkProvider();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns the channel data for the channel that the current sink is associated with.

C# Syntax:

public void GetChannelData(    IChannelDataStore channelData );

channelData

An IChannelDataStore object in which the channel data is to be returned.

Implements:

IServerChannelSinkProvider.GetChannelData

Return to top

Inherited
See base class member description: System.Object.GetHashCode

C# Syntax:

public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page