169 lines
8.7 KiB
XML
169 lines
8.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="StreamUpgradeAcceptor" FullName="System.ServiceModel.Channels.StreamUpgradeAcceptor">
|
|
<TypeSignature Language="C#" Value="public abstract class StreamUpgradeAcceptor" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit StreamUpgradeAcceptor extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.ServiceModel</AssemblyName>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An example of a stream upgrade is to build a compression stream directly on top of the transport stream. </para>
|
|
<para>This class is used with <see cref="T:System.ServiceModel.Channels.StreamUpgradeInitiator" /> and <see cref="T:System.ServiceModel.Channels.StreamUpgradeProvider" /> to implement a custom stream upgrade. </para>
|
|
<para>For a detailed description of the upgrade process, see <see cref="T:System.ServiceModel.Channels.StreamUpgradeProvider" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>To implement a custom upgrade acceptor, inherited from this abstract base class. </para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected StreamUpgradeAcceptor ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.Channels.StreamUpgradeAcceptor" /> class. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AcceptUpgrade">
|
|
<MemberSignature Language="C#" Value="public virtual System.IO.Stream AcceptUpgrade (System.IO.Stream stream);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.IO.Stream AcceptUpgrade(class System.IO.Stream stream) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.IO.Stream</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="System.IO.Stream" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method can be used to wrap the existing transport stream by providing additional capabilities; for example, a compressing stream.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Upgrades the transport stream and returns the upgraded stream.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns the upgraded stream.</para>
|
|
</returns>
|
|
<param name="stream">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The stream to be upgraded.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="BeginAcceptUpgrade">
|
|
<MemberSignature Language="C#" Value="public abstract IAsyncResult BeginAcceptUpgrade (System.IO.Stream stream, AsyncCallback callback, object state);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.IAsyncResult BeginAcceptUpgrade(class System.IO.Stream stream, class System.AsyncCallback callback, object state) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.IAsyncResult</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="System.IO.Stream" />
|
|
<Parameter Name="callback" Type="System.AsyncCallback" />
|
|
<Parameter Name="state" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For more information, see the remarks for <see cref="M:System.ServiceModel.Channels.StreamUpgradeAcceptor.AcceptUpgrade(System.IO.Stream)" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Asynchronous version of <see cref="M:System.ServiceModel.Channels.StreamUpgradeAcceptor.AcceptUpgrade(System.IO.Stream)" />.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a result code that is passed into EndAcceptUpgrade to access the upgraded stream.</para>
|
|
</returns>
|
|
<param name="stream">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The stream to be upgraded.</param>
|
|
<param name="callback">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The method to be called when the AcceptUpgrade call has completed.</param>
|
|
<param name="state">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />State information for the AcceptUpgrade call.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CanUpgrade">
|
|
<MemberSignature Language="C#" Value="public abstract bool CanUpgrade (string contentType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool CanUpgrade(string contentType) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="contentType" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The developer can inspect the requested content type and determine whether the resulting upgrade can be performed by this upgrade acceptor. This content type comes from the GetNextUpgrade method on the matching upgrade initiator.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Determines whether the upgrade requested is supported by this upgrade acceptor.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if this kind of upgrade is supported; otherwise, false. </para>
|
|
</returns>
|
|
<param name="contentType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of content to be checked. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="EndAcceptUpgrade">
|
|
<MemberSignature Language="C#" Value="public abstract System.IO.Stream EndAcceptUpgrade (IAsyncResult result);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.IO.Stream EndAcceptUpgrade(class System.IAsyncResult result) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.IO.Stream</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="result" Type="System.IAsyncResult" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For more information, see the remarks in <see cref="M:System.ServiceModel.Channels.StreamUpgradeAcceptor.AcceptUpgrade(System.IO.Stream)" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Asynchronous version of <see cref="M:System.ServiceModel.Channels.StreamUpgradeAcceptor.AcceptUpgrade(System.IO.Stream)" />.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns the upgraded stream.</para>
|
|
</returns>
|
|
<param name="result">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The IAsyncResult returned from BeginAcceptUpgrade.</param>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |