This documentation is archived and is not being maintained.

StreamUpgradeInitiator Class

To implement a custom upgrade initiator, inherit from this abstract base class.


Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public abstract class StreamUpgradeInitiator

The StreamUpgradeInitiator type exposes the following members.

Protected methodStreamUpgradeInitiatorInitializes a new instance of the StreamUpgradeInitiator class.

Public methodBeginInitiateUpgradeThis abstract method can be implemented to do asynchronous processing that initiates an upgrade.
Public methodEndInitiateUpgradeThis method is the asynchronous callback method that is called after BeginInitiateUpgrade has completed.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetNextUpgradeReturns the content type of the next upgrade to be performed.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitiateUpgradeInitiates the upgrade of the stream by requesting the other end of its connection to upgrade the channel transport layer.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

An example of a stream upgrade is to build a compression stream directly on top of the transport stream. This class is used with StreamUpgradeAcceptor and StreamUpgradeProvider to implement a custom stream upgrade.

For a detailed description of the upgrade process, see StreamUpgradeProvider.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.