System.Runtime.Remoting.Channels.SoapServerFormatterSink Class

Summary

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

C# Syntax:

public class SoapServerFormatterSink : IServerChannelSink, IChannelSinkBase

The request stream propagates from the server transport sink through the server channel sinks until it reaches the appropriate formatter sink. The formatter sink deserializes the message and passes it through the pipeline. A special dispatch sink is inserted at the end of the channel sink chain by ChannelServices.CreateServerChannelSinkChain method, that is called by server channels to create the server channel sink chains. When the message reaches the dispatch sink, the dispatch sink passes the message to the remoting infrastructure.

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

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

Public Constructors

ctor #1

Initializes a new instance of the SoapServerFormatterSink class.

Public Properties

NextChannelSink	Read-only Gets the next IServerChannelSink in the sink chain.
Properties	Read-only Gets an IDictionary of properties for the current channel sink.

Public Methods

AsyncProcessResponse	Requests processing from the current sink of the response from a method call sent asynchronously.
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 provided response 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.
ProcessMessage	Requests message processing from the current sink.
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.SoapServerFormatterSink

System.Runtime.Remoting.Channels.SoapServerFormatterSink Member Details

Summary

Initializes a new instance of the SoapServerFormatterSink class.

C# Syntax:

public SoapServerFormatterSink(SoapServerFormatterSink(    SoapServerFormatterSink.Protocol protocol,    IServerChannelSink nextSink,    IChannelReceiver receiver );

protocol

The BinaryServerFormatterSink.Protocol that will be used with the current instance of BinaryServerFormatterSink.

nextSink

The next sink in the channel sink chain.

receiver

Indicates the channel that will receive the messages serialized by the new instance of BinaryServerFormatterSink.

Return to top

Summary

Gets the next IServerChannelSink in the sink chain.

C# Syntax:

public IServerChannelSink NextChannelSink {get;}

Implements:

IServerChannelSink.NextChannelSink

Return to top

Summary

Gets an IDictionary of properties for the current channel sink.

C# Syntax:

public IDictionary Properties {get;}

Implements:

IChannelSinkBase.Properties

Return to top

Summary

Requests processing from the current sink of the response from a method call sent asynchronously.

C# Syntax:

public void AsyncProcessResponse(    IServerResponseChannelSinkStack sinkStack,    object state,    IMessage msg,    ITransportHeaders headers,    Stream stream );

sinkStack

A stack of sinks leading back to the server transport sink.

state

Information associated with the current sink, generated on the request side, and needed on the response side.

msg

The response message.

headers

The headers to add to the return message heading to the client.

stream

The stream heading back to the transport sink.

Implements:

IServerChannelSink.AsyncProcessResponse

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:

~SoapServerFormatterSink();

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.GetHashCode

C# Syntax:

public virtual int GetHashCode();

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

Return to top

Summary

Returns the Stream onto which the provided response message is to be serialized.

C# Syntax:

public Stream GetResponseStream(    IServerResponseChannelSinkStack sinkStack,    object state,    IMessage msg,    ITransportHeaders headers );

sinkStack

A stack of sinks leading back to the server transport sink.

state

Information associated with the current sink, generated on the request side, and needed on the response side.

msg

The response message that is to be serialized.

headers

The headers to put in the response stream to the client.

Return Value:

The Stream onto which the provided response message is to be serialized.

Implements:

IServerChannelSink.GetResponseStream

This method is called when a response stream needs to be created.

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

Summary

Requests message processing from the current sink.

C# Syntax:

public ServerProcessing ProcessMessage(    IServerChannelSinkStack sinkStack,    IMessage requestMsg,    ITransportHeaders requestHeaders,    Stream requestStream,    out IMessage responseMsg,    out ITransportHeaders responseHeaders,    out Stream responseStream );

sinkStack

The stack of sinks that transports the message.

requestMsg

The message that contains the request.

requestHeaders

Headers retrieved from the incoming message from the client.

requestStream

The stream that needs to be processed and passed on to the deserialization sink.

responseMsg

When this method returns, contains an IMessage that holds the response message. This parameter is passed uninitialized.

responseHeaders

When this method returns, contains an ITransportHeaders that holds the headers to add to the return message heading to the client. This parameter is passed uninitialized.

responseStream

When this method returns, contains a Stream that is heading back to the transport sink. This parameter is passed uninitialized.

Return Value:

A ServerProcessing status value that provides information about how the message was processed.

Implements:

IServerChannelSink.ProcessMessage

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