a575963da9
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
304 lines
19 KiB
XML
304 lines
19 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<Type Name="TransactionFlowBindingElement" FullName="System.ServiceModel.Channels.TransactionFlowBindingElement">
|
||
<TypeSignature Language="C#" Value="public class TransactionFlowBindingElement : System.ServiceModel.Channels.BindingElement" />
|
||
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TransactionFlowBindingElement extends System.ServiceModel.Channels.BindingElement" />
|
||
<AssemblyInfo>
|
||
<AssemblyName>System.ServiceModel</AssemblyName>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Base>
|
||
<BaseTypeName>System.ServiceModel.Channels.BindingElement</BaseTypeName>
|
||
</Base>
|
||
<Interfaces />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>This element allows you to enable or disable incoming transaction flow in an endpoint’s binding settings, as well as to specify the desired protocol format for incoming transactions. </para>
|
||
<block subset="none" type="note">
|
||
<para>When using the <see cref="P:System.ServiceModel.TransactionProtocol.OleTransactions" /> protocol to flow transactions from endpoint to endpoint, the transaction timeout can be lost if the destination endpoint attempts to flow again using any protocol other than <see cref="P:System.ServiceModel.TransactionProtocol.OleTransactions" />. This can cause all down-level nodes after the <see cref="P:System.ServiceModel.TransactionProtocol.OleTransactions" /> hop to timeout later than expected.</para>
|
||
</block>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Represents the configuration element that specifies transaction flow support for a binding. This class cannot be inherited.</para>
|
||
</summary>
|
||
</Docs>
|
||
<Members>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public TransactionFlowBindingElement ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig 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.TransactionFlowBindingElement" /> class.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public TransactionFlowBindingElement (System.ServiceModel.TransactionProtocol protocol);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.TransactionProtocol protocol) cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Parameters>
|
||
<Parameter Name="protocol" Type="System.ServiceModel.TransactionProtocol" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="protocol">To be added.</param>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>crabout choosing the protocol to be used, see <format type="text/html"><a href="31a6bc6a-4ef4-45ba-a753-1efa1a19d917">Enabling Transaction Flow</a></format>.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.Channels.TransactionFlowBindingElement" /> class with the specified protocol that is used to flow a transaction.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="BuildChannelFactory<TChannel>">
|
||
<MemberSignature Language="C#" Value="public override System.ServiceModel.Channels.IChannelFactory<TChannel> BuildChannelFactory<TChannel> (System.ServiceModel.Channels.BindingContext context);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.ServiceModel.Channels.IChannelFactory`1<!!TChannel> BuildChannelFactory<TChannel>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.ServiceModel.Channels.IChannelFactory<TChannel></ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="TChannel" />
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>This method creates a channel factory that can be used to make outgoing channels of the specified type. This method is called by the infrastructure when building the channel stack. You should use it in your code only when you implement a custom binding element.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a channel factory for producing channels of a specified type from a binding context.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.ServiceModel.Channels.IChannelFactory`1" /> of type <paramref name="TChannel" /> initialized from <paramref name="context" />.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that should be used to build the channel factory.</param>
|
||
<typeparam name="TChannel">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The channel type.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="BuildChannelListener<TChannel>">
|
||
<MemberSignature Language="C#" Value="public override System.ServiceModel.Channels.IChannelListener<TChannel> BuildChannelListener<TChannel> (System.ServiceModel.Channels.BindingContext context) where TChannel : class, System.ServiceModel.Channels.IChannel;" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.ServiceModel.Channels.IChannelListener`1<!!TChannel> BuildChannelListener<class (class System.ServiceModel.Channels.IChannel) TChannel>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.ServiceModel.Channels.IChannelListener<TChannel></ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="TChannel">
|
||
<Constraints>
|
||
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
|
||
<InterfaceName>System.ServiceModel.Channels.IChannel</InterfaceName>
|
||
</Constraints>
|
||
</TypeParameter>
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>This method creates a channel listener to receive messages for this binding.</para>
|
||
<para>This method is called by the infrastructure when building the channel. You should use it in your code only when you implement a custom binding element.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a channel listener for accepting channels of a specified type from the binding context.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.ServiceModel.Channels.IChannelListener`1" /> of type <paramref name="TChannel" /> initialized from <paramref name="context" />.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that should be used to build the channel listener.</param>
|
||
<typeparam name="TChannel">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The channel type.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="CanBuildChannelFactory<TChannel>">
|
||
<MemberSignature Language="C#" Value="public override bool CanBuildChannelFactory<TChannel> (System.ServiceModel.Channels.BindingContext context);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanBuildChannelFactory<TChannel>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="TChannel" />
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>You should call this method to check that the channel factory for channels of type <paramref name="TChannel" /> can be built for the specified <paramref name="context" />, before attempting to actually build the factory. Note that <see cref="M:System.ServiceModel.Channels.TransactionFlowBindingElement.BuildChannelFactory``1(System.ServiceModel.Channels.BindingContext)" /> throws an exception if it cannot build a channel factory for the specified channel type.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns a value that indicates whether the specified binding context can build a channel factory for producing channels of a specified type.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>true if a channel factory for the specified type of channel can be built from <paramref name="context" />; otherwise, false.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that should be used to determine if a channel factory can be built.</param>
|
||
<typeparam name="TChannel">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The channel type.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="CanBuildChannelListener<TChannel>">
|
||
<MemberSignature Language="C#" Value="public override bool CanBuildChannelListener<TChannel> (System.ServiceModel.Channels.BindingContext context) where TChannel : class, System.ServiceModel.Channels.IChannel;" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanBuildChannelListener<class (class System.ServiceModel.Channels.IChannel) TChannel>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="TChannel">
|
||
<Constraints>
|
||
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
|
||
<InterfaceName>System.ServiceModel.Channels.IChannel</InterfaceName>
|
||
</Constraints>
|
||
</TypeParameter>
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>You should call this method to check that the channel listener for channels of type of <paramref name="TChannel" /> can be built for the specified <paramref name="context" />, before attempting to actually build the listener. Note that <see cref="M:System.ServiceModel.Channels.TransactionFlowBindingElement.BuildChannelListener``1(System.ServiceModel.Channels.BindingContext)" /> throws an exception if it cannot build a channel listener for the specified channel type.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns a value that indicates whether the specified binding context can build a channel listener for accepting channels of a specified type.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>true if a channel listener for the specified type of channel can be built from <paramref name="context" />; otherwise, false.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that should be used to determine if a channel listener can be built.</param>
|
||
<typeparam name="TChannel">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The channel type.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Clone">
|
||
<MemberSignature Language="C#" Value="public override System.ServiceModel.Channels.BindingElement Clone ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.ServiceModel.Channels.BindingElement Clone() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.ServiceModel.Channels.BindingElement</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>This method creates a deep clone of this binding element. A deep clone of an object creates a copy of the object and a copy of everything directly or indirectly referenced by that object. (This is also called copying the entire object graph.) A shallow clone of an object, by contrast, is a copy of the object only. If the object contains references to other objects, the shallow copy does not create copies of the referred objects; instead, it copies only the references to the original objects.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Creates a duplicate of this element.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A <see cref="T:System.ServiceModel.Channels.BindingElement" /> that is a duplicate of this element.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="GetProperty<T>">
|
||
<MemberSignature Language="C#" Value="public override T GetProperty<T> (System.ServiceModel.Channels.BindingContext context) where T : class;" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance !!T GetProperty<class T>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>T</ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="T">
|
||
<Constraints>
|
||
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
|
||
</Constraints>
|
||
</TypeParameter>
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>You can use this method to retrieve capabilities, requirements and parameters from the binding element stack. If a binding element supports returning the requested object, it returns it. If not, it delegates the call down to the next binding element in the stack. If it gets to the bottom of the stack and no binding element supported the requested object, this method returns null.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets the typed object requested, if present, from the appropriate layer in the binding stack.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The typed object <paramref name="T" /> requested if it is present; null if it is not. </para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> </param>
|
||
<typeparam name="T">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The typed object for which the method is querying.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TransactionProtocol">
|
||
<MemberSignature Language="C#" Value="public System.ServiceModel.TransactionProtocol TransactionProtocol { get; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.TransactionProtocol TransactionProtocol" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.ServiceModel.TransactionProtocol</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>crabout choosing the protocol to be used, see <format type="text/html"><a href="31a6bc6a-4ef4-45ba-a753-1efa1a19d917">Enabling Transaction Flow</a></format>.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets or sets the transaction protocol used in flowing a transaction.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
</Members>
|
||
</Type> |