Type: System.Runtime.Remoting.Channels.ClientChannelSinkStack

System.Runtime.Remoting.Channels.ClientChannelSinkStack Class

Assembly: Mscorlib.dll
Namespace: System.Runtime.Remoting.Channels

Summary: Holds the stack of client channel sinks that must be invoked during an asynchronous message response decoding.

C# Syntax:


        public class ClientChannelSinkStack : IClientChannelSinkStack, IClientResponseChannelSinkStack

System.Runtime.Remoting.Channels.ClientChannelSinkStack 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 ClientChannelSinkStack class with default values.
ctor #2	Overloaded: `.ctor(IMessageSink replySink)` Initializes a new instance of the ClientChannelSinkStack class with the specified reply sink.

Public Methods

AsyncProcessResponse	Requests asynchronous processing of a method call on the sinks in the current sink stack.
DispatchException	Dispatches the specified exception on the reply sink.
DispatchReplyMessage	Dispatches the specified reply message on the reply sink.
Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
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.
Pop	Pops the information associated with all the sinks from the sink stack up to and including the specified sink.
Push	Pushes the specified sink and information associated with it onto the sink stack.
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.ClientChannelSinkStack

System.Runtime.Remoting.Channels.ClientChannelSinkStack Member Details

Overloaded ctor #1

Summary: Initializes a new instance of the ClientChannelSinkStack class with default values.

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

C# Syntax:


            public ClientChannelSinkStack();

Return to top

Overloaded ctor #2

Summary: Initializes a new instance of the ClientChannelSinkStack class with the specified reply sink.

C# Syntax:


            public ClientChannelSinkStack(
   IMessageSink replySink
);

Parameters:

replySink

The IMessageSink that the current stack can use to reply to messages.

Return to top

Method: AsyncProcessResponse(
ITransportHeaders headers,
Stream stream
)

Summary: Requests asynchronous processing of a method call on the sinks in the current sink stack.

C# Syntax:


            public void AsyncProcessResponse(
   ITransportHeaders headers,
   Stream stream
);

Parameters:

headers

The headers retrieved from the server response stream.

stream

The stream returning from the transport sink.

Exceptions

Exception Type	Condition
RemotingException	The current sink stack is empty.

Implements:: IClientResponseChannelSinkStack.AsyncProcessResponse

Remarks

The ClientChannelSinkStack.AsyncProcessResponse method initializes asynchronous processing on the top sink in the current sink stack. For additional information, see IClientChannelSink.AsyncProcessResponse.

Return to top

Method: DispatchException(
Exception e
)

Summary: Dispatches the specified exception on the reply sink.

C# Syntax:


            public void DispatchException(
   Exception e
);

Parameters:

The exception to dispatch to the server.

Implements:: IClientResponseChannelSinkStack.DispatchException

Remarks

The ClientChannelSinkStack.DispatchException method dispatches the specified exception to the server through the reply sink specified in the constructor of the current sink stack. If the current sink stack was created without a reply sink, the exception is not transmitted, and no new exception is thrown.

Return to top

Method: DispatchReplyMessage(
IMessage msg
)

Summary: Dispatches the specified reply message on the reply sink.

C# Syntax:


            public void DispatchReplyMessage(
   IMessage msg
);

Parameters:

msg

The IMessage to dispatch.

Implements:: IClientResponseChannelSinkStack.DispatchReplyMessage

Remarks

The ClientChannelSinkStack.DispatchReplyMessage method dispatches the specified message to the server through the reply sink specified in the constructor of the current sink stack. If the current sink stack was created without a reply sink, the message is not transmitted, and no new exception is thrown.

Return to top

Method: Equals(
object obj
)

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

Method: Finalize()

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

C# Syntax:


            ~ClientChannelSinkStack();

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

Return to top

Method: GetHashCode()

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

Method: GetType()

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

Method: MemberwiseClone()

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

Method: Pop(
IClientChannelSink sink
)

Summary: Pops the information associated with all the sinks from the sink stack up to and including the specified sink.

C# Syntax:


            public object Pop(
   IClientChannelSink sink
);

Parameters:

sink

The sink to remove and return from the sink stack.

Return Value:: Information generated on the request side and associated with the specified sink.

Exceptions

Exception Type	Condition
RemotingException	The current sink stack is empty, or the specified sink was never pushed onto the current stack.

Implements:: IClientChannelSinkStack.Pop

Return to top

Method: Push(
IClientChannelSink sink,
object state
)

Summary: Pushes the specified sink and information associated with it onto the sink stack.

C# Syntax:


            public void Push(
   IClientChannelSink sink,
   object state
);

Parameters:

sink

The sink to push onto the sink stack.

state

Information generated on the request side that is needed on the response side.

Implements:: IClientChannelSinkStack.Push

Remarks

Note The information generated on the request side and specified in the state parameter is returned in the state parameter of the IClientChannelSink.AsyncProcessResponse method on the corresponding sink.

Return to top

Method: ToString()

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.