System.Runtime.Remoting.Channels.ServerChannelSinkStack Class

Assembly: Mscorlib.dll
Namespace: System.Runtime.Remoting.Channels
Summary
Holds the stack of server channel sinks.
C# Syntax:
public class ServerChannelSinkStack : IServerChannelSinkStack, IServerResponseChannelSinkStack
See also:
System.Runtime.Remoting.Channels Namespace

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

Public Constructors
ctor #1 Default constructor. This constructor is called by derived class constructors to initialize state in this type.
Public Methods
AsyncProcessResponse Requests asynchronous processing of a method call on the sinks in the current sink stack.
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.
GetResponseStream Returns the Stream onto which the specified message is to be serialized.
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.
ServerCallback Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
Store Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
StoreAndDispatch Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
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.Runtime.Remoting.Channels.ServerChannelSinkStack Member Details

ctor #1
Summary:
Default constructor. This constructor is called by derived class constructors to initialize state in this type.
C# Syntax:
public ServerChannelSinkStack();

Return to top


Method: AsyncProcessResponse(
   IMessage msg,
   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(
   IMessage msg,
   ITransportHeaders headers,
   Stream stream
);
Parameters:

msg

headers

The headers retrieved from the server response stream.

stream

The stream coming back from the transport sink.

Exceptions
Exception Type Condition
RemotingException The current sink stack is empty.
Implements:
IServerResponseChannelSinkStack.AsyncProcessResponse
Remarks
This method initializes asynchronous processing on the top sink in the current sink stack. For additional information, see IServerChannelSink.AsyncProcessResponse.

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:
~ServerChannelSinkStack();

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: GetResponseStream(
   IMessage msg,
   ITransportHeaders headers
)
Summary
Returns the Stream onto which the specified message is to be serialized.
C# Syntax:
public Stream GetResponseStream(
   IMessage msg,
   ITransportHeaders headers
);
Parameters:

msg

The message to be serialized onto the requested stream.

headers

The headers retrieved from the server response stream.

Return Value:
The Stream onto which the specified message is to be serialized.
Exceptions
Exception Type Condition
RemotingException The sink stack is empty.
Implements:
IServerResponseChannelSinkStack.GetResponseStream
Remarks
This method returns the stream returned by the IServerChannelSink.GetResponseStream called with the msg and headers parameters ( IServerChannelSink.GetResponseStream (msg, headers) ) on the top sink in the current sink stack. The top sink in the sink stack remains unchanged.

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(
   IServerChannelSink 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(
   IServerChannelSink 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:
IServerChannelSinkStack.Pop

Return to top


Method: Push(
   IServerChannelSink sink,
   object state
)
Summary
Pushes the specified sink and information associated with it onto the sink stack.
C# Syntax:
public void Push(
   IServerChannelSink 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:
IServerChannelSinkStack.Push
Remarks


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

Return to top


Method: ServerCallback(
   IAsyncResult ar
)
Summary
Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
C# Syntax:
public void ServerCallback(
   IAsyncResult ar
);
Parameters:

ar

Implements:
IServerChannelSinkStack.ServerCallback

Return to top


Method: Store(
   IServerChannelSink sink,
   object state
)
Summary
Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
C# Syntax:
public void Store(
   IServerChannelSink sink,
   object state
);
Parameters:

sink

state

Exceptions
Exception Type Condition
RemotingException The current sink stack is empty, or the specified sink was never pushed onto the current stack.
Implements:
IServerChannelSinkStack.Store

Return to top


Method: StoreAndDispatch(
   IServerChannelSink sink,
   object state
)
Summary
Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
C# Syntax:
public void StoreAndDispatch(
   IServerChannelSink sink,
   object state
);
Parameters:

sink

state

Implements:
IServerChannelSinkStack.StoreAndDispatch

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.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.