This documentation is archived and is not being maintained.

BaseChannelSinkWithProperties Class

Provides a base implementation for channel sinks that want to expose a dictionary interface to their properties.

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

'Declaration
<ComVisibleAttribute(True)> _
<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.Infrastructure)> _
<SecurityPermissionAttribute(SecurityAction.InheritanceDemand, Flags := SecurityPermissionFlag.Infrastructure)> _
Public MustInherit Class BaseChannelSinkWithProperties _
	Inherits BaseChannelObjectWithProperties
'Usage
Dim instance As BaseChannelSinkWithProperties

Channel sinks provide a plug-in point that allows access to the underlying messages that are flowing through the channel as well as the stream that is used by the transport mechanism to send messages to a remote object. Channel sinks are linked together in a chain of channel sink providers, and all channel messages flow through this chain of sinks before the message is serialized and transported.

This class makes a link demand and an inheritance demand at the class level. A SecurityException is thrown when either the immediate caller or the derived class does not have infrastructure permission. For details about security demands, see Link Demands and Inheritance Demands.

Notes to Inheritors:

When you inherit from BaseChannelSinkWithProperties, you must implement the Keys property and the Item property.

<PermissionSet(SecurityAction.Demand, Name:="FullTrust")> _
Friend Class MyClientFormatterChannelSink
   Inherits BaseChannelSinkWithProperties
   Implements IClientChannelSink, IMessageSink
   Private nextClientSink As IClientChannelSink = Nothing 
   Private nextMessageSink As IMessageSink = Nothing 

   Public Sub New(nextSink As IClientChannelSink, nextMsgSink As IMessageSink)
      MyBase.New()
      nextClientSink = nextSink
      nextMessageSink = nextMsgSink
   End Sub 'New 

   Public Sub ProcessMessage(msg As IMessage, requestHeaders As ITransportHeaders, _
               requestStream As Stream, ByRef responseHeaders As ITransportHeaders, _
               ByRef responseStream As Stream) _
               Implements IClientChannelSink.ProcessMessage
      nextClientSink.ProcessMessage(msg, requestHeaders, requestStream, _
                                    responseHeaders, responseStream)
   End Sub 'ProcessMessage

   Public Sub AsyncProcessRequest(sinkStack As IClientChannelSinkStack, _
            msg As IMessage, headers As ITransportHeaders, myStream As Stream) _
            Implements IClientChannelSink.AsyncProcessRequest
      sinkStack.Push(Me, Nothing)
      nextClientSink.AsyncProcessRequest(sinkStack, msg, headers, myStream)
   End Sub 'AsyncProcessRequest

   Public Sub AsyncProcessResponse(sinkStack As IClientResponseChannelSinkStack, _
            state As Object, headers As ITransportHeaders, myStream As Stream) _
            Implements IClientChannelSink.AsyncProcessResponse
      sinkStack.AsyncProcessResponse(headers, myStream)
   End Sub 'AsyncProcessResponse

   Public Function GetRequestStream(msg As IMessage, headers As ITransportHeaders) As Stream _
         Implements IClientChannelSink.GetRequestStream
      Return Nothing 
   End Function 'GetRequestStream

   Public ReadOnly Property NextChannelSink() As IClientChannelSink _
         Implements IClientChannelSink.NextChannelSink
      Get 
         Return nextClientSink
      End Get 
   End Property 

   Public ReadOnly Property NextSink() As IMessageSink _
         Implements IMessageSink.NextSink
      Get 
         Return nextMessageSink
      End Get 
   End Property 

   Public Overrides ReadOnly Property Properties() As Collections.IDictionary _
            Implements IClientChannelSink.Properties
      Get 
      End Get 
   End Property 

   Public Function AsyncProcessMessage(msg As IMessage, replySink As IMessageSink) As IMessageCtrl _
            Implements IMessageSink.AsyncProcessMessage
      Return Nothing 
   End Function 'AsyncProcessMessage

   Public Function SyncProcessMessage(msg As IMessage) As IMessage _
            Implements IMessageSink.SyncProcessMessage
      Return nextMessageSink.SyncProcessMessage(msg)
   End Function 'SyncProcessMessage

   Default Public Overrides Property Item(key As Object) As Object
      Get 
         If key Is GetType(MyKey) Then 
            Return Me 
         End If 
         Return Nothing 
      End Get 
      Set 
         Throw New NotSupportedException()
      End Set 
   End Property 

   Public Overrides ReadOnly Property Keys() As ICollection
      Get 
         Dim myKeys As New ArrayList(0)
         myKeys.Add(GetType(MyKey))
         Return myKeys
      End Get 
   End Property 
End Class 'MyClientFormatterChannelSink

Public Class MyKey
End Class 'MyKey
public __gc class MyKey
{
};

private __gc class MyClientFormatterChannelSink :
    public BaseChannelSinkWithProperties, public IClientChannelSink, public IMessageSink
{
private:
    IClientChannelSink* nextClientSink;
    IMessageSink* nextMessageSink;

public:
    MyClientFormatterChannelSink() : nextClientSink(0), nextMessageSink(0) {}

    MyClientFormatterChannelSink(IClientChannelSink* nextSink,
        IMessageSink* nextMsgSink) : BaseChannelSinkWithProperties()
    {
        nextClientSink = nextSink;
        nextMessageSink = nextMsgSink;
    }

    void ProcessMessage(IMessage* msg,
        ITransportHeaders* requestHeaders, Stream* requestStream,
        [Out]ITransportHeaders** responseHeaders, [Out]Stream** responseStream)
    {
        nextClientSink->ProcessMessage(msg, requestHeaders, requestStream,
            responseHeaders, responseStream);
    }

    void AsyncProcessRequest(IClientChannelSinkStack* sinkStack,
        IMessage* msg, ITransportHeaders* headers, Stream* myStream)
    {
        sinkStack->Push(this, 0);
        nextClientSink->AsyncProcessRequest(sinkStack,msg,headers,myStream);
    }

    void AsyncProcessResponse(IClientResponseChannelSinkStack* sinkStack,
        Object* /*state*/, ITransportHeaders* headers, Stream* myStream)
    {
        sinkStack->AsyncProcessResponse(headers, myStream);
    }

    Stream* GetRequestStream(IMessage* /*msg*/,ITransportHeaders* /*headers*/)
    {
        return 0;
    }

    __property IClientChannelSink* get_NextChannelSink()
    {
        return nextClientSink;
    }

    __property IMessageSink* get_NextSink()
    {
        return nextMessageSink;
    }

    IMessageCtrl* AsyncProcessMessage(IMessage* /*msg*/,
        IMessageSink* /*replySink*/)
    {
        return 0;
    }

    IMessage* SyncProcessMessage(IMessage* msg)
    {
        return nextMessageSink->SyncProcessMessage(msg);
    }

    __property Object* get_Item( Object* key )
    {
        if (key == __typeof(MyKey))
            return this;
        return 0;
    }

    __property void set_Item( Object* /*value*/, Object* /*key*/ )
    {
        throw new NotSupportedException();
    }

    __property ICollection* get_Keys()
    {
        ArrayList* myKeys = new ArrayList(1);
        myKeys->Add(__typeof(MyKey));
        return myKeys;
    }

};

public __gc class MyClientFormatterProvider : public IClientChannelSinkProvider
{
private:
    IClientChannelSinkProvider* nextProvider;
public:
    MyClientFormatterProvider() : nextProvider(0)
    {
    }

    IClientChannelSink* CreateSink(IChannelSender* channel,
        String* myUrl, Object* remoteChannelData)
    {
        IClientChannelSink* nextSink = 0;
        IMessageSink* nextMsgSink = 0;
        if (nextProvider!=0)
        {
            Console::WriteLine(S"Next client sink provider is: {0}", nextProvider);
            // Create a sink chain calling the next sink provider's
            // 'CreateSink' method.
            nextSink=nextProvider->CreateSink(channel,myUrl,remoteChannelData);
            nextMsgSink=dynamic_cast<IMessageSink*>(nextSink);
        }
        return new MyClientFormatterChannelSink(nextSink,nextMsgSink);
    }

    __property IClientChannelSinkProvider* get_Next()
    {
        return nextProvider;
    }

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

};

System.Object
  System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties
    System.Runtime.Remoting.Channels.BaseChannelSinkWithProperties

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 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: