This documentation is archived and is not being maintained.

IServerChannelSinkProvider Interface

Creates server channel sinks for the server channel through which remoting messages flow.

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

[ComVisibleAttribute(true)]
public interface IServerChannelSinkProvider

Channel sinks are connected to a server channel through implementations of the IServerChannelSinkProvider interface. All the remoting server channels provide constructors that take a 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 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 are created at the same time as the channel, during a RemotingConfiguration.Configure call.

After the IMethodCallMessage is generated, .NET Framework searches through the list of registered channels to find one that can process the call. Once an appropriate channel has been found, the channel sink is retrieved from the channel, and the IMethodCallMessage is forwarded to the sink for processing.

The following code example illustrates an implementation of this interface.

public class ServerSinkProvider : IServerChannelSinkProvider
{

    // The next provider in the chain. 
    private IServerChannelSinkProvider nextProvider;

    public IServerChannelSinkProvider Next
    {
        [SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.Infrastructure)]
        get
        {
            return(nextProvider);
        }
        [SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.Infrastructure)]
        set
        {
            nextProvider = value;
        }
    }

    [SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.Infrastructure)]
    public IServerChannelSink CreateSink (IChannelReceiver channel)
    {

        Console.WriteLine("Creating ServerSink");

        // Create the next sink in the chain.
        IServerChannelSink nextSink = nextProvider.CreateSink(channel);

        // Hook our sink up to it. 
        return( new ServerSink(nextSink) );
    }

    [SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.Infrastructure)]
    public void GetChannelData (IChannelDataStore channelData) {}

    // This constructor is required in order to use the provider in file-based configuration. 
    // It need not do anything unless you want to use the information in the parameters. 
    public ServerSinkProvider (IDictionary properties, ICollection providerData) {}

}
public __gc class ServerSinkProvider : public IServerChannelSinkProvider
{

    // The next provider in the chain.
private:
    IServerChannelSinkProvider* nextProvider;

public:
    __property IServerChannelSinkProvider* get_Next()
    {
        return(nextProvider);
    }

    __property void set_Next( IServerChannelSinkProvider* value )
    {
        nextProvider = value;
    }


public:
    IServerChannelSink* CreateSink (IChannelReceiver* channel)
    {

        Console::WriteLine(S"Creating ServerSink");

        // Create the next sink in the chain.
        IServerChannelSink* nextSink = nextProvider->CreateSink(channel);

        // Hook our sink up to it.
        return( new ServerSink(nextSink) );
    }

public:
    void GetChannelData (IChannelDataStore* /*channelData*/) {}

    // This constructor is required in order to use the provider in file-based configuration.
    // It need not do anything unless you want to use the information in the parameters.
public:
    ServerSinkProvider (IDictionary* /*properties*/, ICollection* /*providerData*/) {}

};

See the IServerChannelSink interface documentation for an example of the corresponding server sink implementation.

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

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

.NET Framework

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