System.Runtime.Remoting.Channels.SoapClientFormatterSink Class

Summary

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

C# Syntax:

public class SoapClientFormatterSink : IClientFormatterSink, IMessageSink, IClientChannelSink, IChannelSinkBase

The function of the formatter sink is to generate the necessary headers and serialize the message to the stream. After reaching the formatter sink, the IMessage is forwarded to all sinks in the channel sink chain through the IClientChannelSink.ProcessMessage or IClientChannelSink.AsyncProcessRequest calls. At this stage the message has already been serialized and is provided as information only. Sinks that need to create or modify the message need to be placed in the sink chain before the formatter. This can be achieved by implementing both the IMessageSink and IClientChannelSink interfaces. The formatter sink can be placed in the sink chain later.

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

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

Public Constructors

ctor #1

Initializes a new instance of the SoapClientFormatterSink class.

Public Properties

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

Public Methods

AsyncProcessMessage	Asynchronously processes the provided message.
AsyncProcessRequest	Requests asynchronous processing of a method call on the current sink.
AsyncProcessResponse	Requests asynchronous processing of a response to a method call on the current 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.
GetRequestStream	Returns the Stream onto which the provided 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.
SyncProcessMessage	Synchronously processes the provided message.
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.SoapClientFormatterSink

System.Runtime.Remoting.Channels.SoapClientFormatterSink Member Details

Summary

Initializes a new instance of the SoapClientFormatterSink class.

C# Syntax:

public SoapClientFormatterSink(    IClientChannelSink nextSink );

nextSink

The next sink in the channel sink chain.

Return to top

Summary

Gets the next IClientChannelSink in the sink chain.

C# Syntax:

public IClientChannelSink NextChannelSink {get;}

Implements:

IClientChannelSink.NextChannelSink

Return to top

Summary

Gets the next IMessageSink in the sink chain.

C# Syntax:

public IMessageSink NextSink {get;}

Implements:

IMessageSink.NextSink

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

Asynchronously processes the provided message.

C# Syntax:

public IMessageCtrl AsyncProcessMessage(    IMessage msg,    IMessageSink replySink );

msg

The message to process.

replySink

The sink that will receive the reply to the provided message.

Return Value:

An IMessageCtrl that provides a way to control the asynchronous message after it has been dispatched.

Implements:

IMessageSink.AsyncProcessMessage

Return to top

Summary

Requests asynchronous processing of a method call on the current sink.

C# Syntax:

public void AsyncProcessRequest(    IClientChannelSinkStack sinkStack,    IMessage msg,    ITransportHeaders headers,    Stream stream );

sinkStack

A stack of channel sinks that called the current sink.

msg

The message to process.

headers

The headers to add to the outgoing message heading to the server.

stream

The stream headed to the transport sink.

Implements:

IClientChannelSink.AsyncProcessRequest

Return to top

Summary

Requests asynchronous processing of a response to a method call on the current sink.

C# Syntax:

public void AsyncProcessResponse(    IClientResponseChannelSinkStack sinkStack,    object state,    ITransportHeaders headers,    Stream stream );

sinkStack

A stack of sinks that called the current sink.

state

The state associated with the current sink.

headers

The headers retrieved from the server response stream.

stream

The stream coming back from the transport sink.

Implements:

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

~SoapClientFormatterSink();

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 message is to be serialized.

C# Syntax:

public Stream GetRequestStream(    IMessage msg,    ITransportHeaders headers );

msg

The IMethodCallMessage containing details about the method call.

headers

The headers to add to the outgoing message heading to the server.

Return Value:

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

Implements:

IClientChannelSink.GetRequestStream

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 void ProcessMessage(    IMessage msg,    ITransportHeaders requestHeaders,    Stream requestStream,    out ITransportHeaders responseHeaders,    out Stream responseStream );

msg

The message to process.

requestHeaders

The headers to add to the outgoing message heading to the server.

requestStream

The stream headed toward the transport sink.

responseHeaders

When this method returns, contains an ITransportHeaders interface that holds the headers that the server returned. This parameter is passed uninitialized.

responseStream

When this method returns, contains a Stream coming back from the transport sink. This parameter is passed uninitialized.

Implements:

IClientChannelSink.ProcessMessage

Return to top

Summary

Synchronously processes the provided message.

C# Syntax:

public IMessage SyncProcessMessage(    IMessage msg );

msg

The message to process.

Return Value:

The response to the processed message.

Implements:

IMessageSink.SyncProcessMessage

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