672 lines
38 KiB
XML
672 lines
38 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="ReliableSessionBindingElement" FullName="System.ServiceModel.Channels.ReliableSessionBindingElement">
|
|
<TypeSignature Language="C#" Value="public sealed class ReliableSessionBindingElement : System.ServiceModel.Channels.BindingElement, System.ServiceModel.Description.IPolicyExportExtension" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ReliableSessionBindingElement extends System.ServiceModel.Channels.BindingElement implements class System.ServiceModel.Description.IPolicyExportExtension" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.ServiceModel</AssemblyName>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.ServiceModel.Channels.BindingElement</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.ServiceModel.Description.IPolicyExportExtension</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides sessions and optionally provides ordered message delivery. This implemented session can cross SOAP and transport intermediaries.</para>
|
|
<para>Each binding element represents a processing step when sending or receiving messages. At runtime, binding elements create the channel factories and listeners that are necessary to build outgoing and incoming channel stacks required to send and receive messages. The <see cref="T:System.ServiceModel.Channels.ReliableSessionBindingElement" /> provides an optional layer in the stack that can establish a reliable session between endpoints and configure the behavior of this session.</para>
|
|
<para>The <see cref="T:System.ServiceModel.Channels.ReliableSessionBindingElement" /> is provided on the standard bindings in the following table.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Binding</para>
|
|
</term>
|
|
<description>
|
|
<para>Default</para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.ServiceModel.NetTcpBinding" />
|
|
</para>
|
|
</term>
|
|
<description>
|
|
<para>Off</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.ServiceModel.WSHttpBinding" />
|
|
</para>
|
|
</term>
|
|
<description>
|
|
<para>Off</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.ServiceModel.WSDualHttpBinding" />
|
|
</para>
|
|
</term>
|
|
<description>
|
|
<para>On (required)</para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents the binding element that can produce the sending and receiving channels required for a reliable session between endpoints.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ReliableSessionBindingElement ();" />
|
|
<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.ReliableSessionBindingElement" /> class. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ReliableSessionBindingElement (bool ordered);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool ordered) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="ordered" Type="System.Boolean" />
|
|
</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.ReliableSessionBindingElement" /> class that specifies whether message delivery must preserve the order in which messages are sent.</para>
|
|
</summary>
|
|
<param name="ordered">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true if messages must be delivered in the order in which they are sent; otherwise, false. The default value is true.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AcknowledgementInterval">
|
|
<MemberSignature Language="C#" Value="public TimeSpan AcknowledgementInterval { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan AcknowledgementInterval" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The destination that receives messages on a reliable channel groups the acknowledgments for these messages together into a single message to reduce network traffic and to increase information density on messages. Grouping scales better as traffic increases. It does not attempt to send an acknowledgment for every message it receives as soon as possible, but rather waits for an interval of time, groups together the acknowledgments that have arrived during that interval, and then sends them all together. The first message that is received is the exception; it is acknowledged as soon as it is delivered. Also, if reliable sessions are used with single HTTP connections, as is the case for example with the <see cref="T:System.ServiceModel.WsHttpBinding" /> but not <see cref="T:System.ServiceModel.WsDualHttpBinding" />, then this setting is not used.</para>
|
|
<para>The value that is set with the <see cref="P:System.ServiceModel.Channels.ReliableSessionBindingElement.AcknowledgementInterval" /> property is a recommendation to the infrastructure and not a hard limit. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the interval of time that a destination waits before sending an acknowledgment to the message source on reliable channels that are created by the factory. </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>The <see cref="T:System.ServiceModel.Channels.IChannel" /> produced by the factory is of type <paramref name="TChannel" />. The types of <paramref name="TChannel" /> supported on the client is dependent of the types of underlying channels that connect to the service. The following table indicates what reliable session channel types are supported as a function of the underlying channels.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Support for Reliable Session TChannel Types by Underlying Channel Types</para>
|
|
</term>
|
|
<description>
|
|
<para>IRequestChannel</para>
|
|
</description>
|
|
<description>
|
|
<para>IRequestSessionChannel</para>
|
|
</description>
|
|
<description>
|
|
<para>IDuplexChannel</para>
|
|
</description>
|
|
<description>
|
|
<para>IDuplexSessionChannel</para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>IOutputSessionChannel</para>
|
|
</term>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>IRequestSessionChannel</para>
|
|
</term>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>No</para>
|
|
</description>
|
|
<description>
|
|
<para>No</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>IDuplexSessionChannel</para>
|
|
</term>
|
|
<description>
|
|
<para>No</para>
|
|
</description>
|
|
<description>
|
|
<para>No</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a factory that creates a channel of a specified type that supports a reliable session.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A <see cref="T:System.ServiceModel.Channels.IChannelFactory`1" /> of type <see cref="T:System.ServiceModel.Channels.IChannel" /> initialized from the <paramref name="context" />.</para>
|
|
</returns>
|
|
<param name="context">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that contains the information required to build the factories that can produce channels of type <paramref name="TChannel" />.</param>
|
|
<typeparam name="TChannel">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of channel the factory builds.</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>The <see cref="T:System.ServiceModel.Channels.IChannel" /> accepted by the listener is of type <paramref name="TChannel" />. The types of <paramref name="TChannel" /> supported on the server that hosts the service is dependent of the types of underlying channels used to connect to the client. The following table indicates what reliable session channel types are supported as a function of the underlying channels.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Support for Reliable Session TChannel Types by Underlying Channel Types</para>
|
|
</term>
|
|
<description>
|
|
<para>IReplyChannel</para>
|
|
</description>
|
|
<description>
|
|
<para>IReplySessionChannel</para>
|
|
</description>
|
|
<description>
|
|
<para>IDuplexChannel</para>
|
|
</description>
|
|
<description>
|
|
<para>IDuplexSessionChannel</para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>IInputSessionChannel</para>
|
|
</term>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>IReplySessionChannel</para>
|
|
</term>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>No</para>
|
|
</description>
|
|
<description>
|
|
<para>No</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>IDuplexSessionChannel</para>
|
|
</term>
|
|
<description>
|
|
<para>No</para>
|
|
</description>
|
|
<description>
|
|
<para>No</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
<description>
|
|
<para>Yes</para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a listener that accepts a channel of a specified type that supports a reliable session.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.ServiceModel.Channels.IChannelListener`1" /> of type <see cref="T:System.ServiceModel.Channels.IChannel" /> initialized from the <paramref name="context" />.</para>
|
|
</returns>
|
|
<param name="context">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that contains the information required to build the listeners that can accept channels of type <paramref name="TChannel" />.</param>
|
|
<typeparam name="TChannel">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.IChannel" /> that the listener is built to accept.</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>This method returns true or false for a <paramref name="TChannel" /> in accordance with the table of values provided in <see cref="M:System.ServiceModel.Channels.ReliableSessionBindingElement.BuildChannelFactory``1(System.ServiceModel.Channels.BindingContext)" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a value that indicates whether the channel factory can be built for the channel and context provided that can support a reliable session.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if the <see cref="T:System.ServiceModel.Channels.IChannelFactory`1" /> of type <paramref name="TChannel" /> can be built; otherwise, false.</para>
|
|
</returns>
|
|
<param name="context">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that contains the information required to build the factories that can produce channels of type <paramref name="TChannel" />.</param>
|
|
<typeparam name="TChannel">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of channel the factory builds.</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>Channel stacks are typically created using a factory pattern where a binding creates the channel stack. When sending messages, a binding is used to build a channel factory which in turn builds a channel stack and returns a reference to the top channel in the stack. The application can then use this channel to send messages. Similarly when receiving messages, a binding is used to build a channel listener which listens for incoming messages. The channel listener provides messages to the listening application by creating channel stacks and handing the application a reference to the top channel.</para>
|
|
<para>This method returns true or false for a <paramref name="TChannel" /> in accordance with the table of values provided in <see cref="M:System.ServiceModel.Channels.ReliableSessionBindingElement.BuildChannelListener``1(System.ServiceModel.Channels.BindingContext)" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a value that indicates whether the channel listener can be built for the channel and context provided that can support a reliable session.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if the <see cref="T:System.ServiceModel.Channels.ChannelListenerBase`1" /> that can produce an <see cref="T:System.ServiceModel.Channels.IChannel" /> of type <paramref name="TChannel" /> can be built by the binding element; otherwise, false.</para>
|
|
</returns>
|
|
<param name="context">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that contains the information required to build the listeners that can accept channels of type <paramref name="TChannel" />.</param>
|
|
<typeparam name="TChannel">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.IChanne" />l that the channel listener, if build, accepts.</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>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a copy of the current reliable session binding element.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A <see cref="T:System.ServiceModel.Channels.BindingElement" /> that is a clone of the current binding element.</para>
|
|
</returns>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FlowControlEnabled">
|
|
<MemberSignature Language="C#" Value="public bool FlowControlEnabled { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool FlowControlEnabled" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Flow control is a mechanism that reliable sessions implement to ensure that senders do not send more messages than a receiver can handle. Receivers have a buffer of messages that is used to accommodate message bursts and out-of-order messages. Receivers advertise to senders the amount of space that remains in this buffer in each of their acknowledgements. Senders can use this information to stop sending new messages whenever the receiver has no buffer space left.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that indicates whether the reliable session has flow control enabled.</para>
|
|
</summary>
|
|
</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>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a property of the specified type from its binding context.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The property of type <paramref name="T" /> with the specified <paramref name="context" /> or null if no property of type <paramref name="T" /> is found.</para>
|
|
</returns>
|
|
<param name="context">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that contains the information required to retrieve the channel of type <paramref name="T" />.</param>
|
|
<typeparam name="T">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of property retrieved.</typeparam>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="InactivityTimeout">
|
|
<MemberSignature Language="C#" Value="public TimeSpan InactivityTimeout { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan InactivityTimeout" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Activity on a channel is defined as receiving an application or infrastructure message. The inactivity timeout parameter controls the maximum amount of time to keep an inactive session alive. If more than <see cref="P:System.ServiceModel.Channels.ReliableSessionBindingElement.InactivityTimeout" /> time interval passes with no activity, the session is aborted by the infrastructure and the channel faults. The reliable session is torn down unilaterally.</para>
|
|
<para>If the sending application has no messages to send then the reliable session is normally not faulted because of inactivity; instead a keep-alive mechanism keeps the session active indefinitely. Note that the dispatcher can independently abort the reliable session if no application messages are sent or received. Thus, the inactivity timeout typically expires if network conditions are such that no messages are received or if there is a failure on the sender. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets an interval of time that a service remains inactive before closing.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MaxPendingChannels">
|
|
<MemberSignature Language="C#" Value="public int MaxPendingChannels { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxPendingChannels" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Channels are pending when they are waiting to be accepted. Once that limit is reached, no channels are created and put in pending mode until this number goes down (by accepting pending channels). This is a limit for each listener. </para>
|
|
<para>When the threshold is reached and a remote application tries to establish a new reliable session, the request is denied and the open operation that prompted this faults. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the largest number of channels that can be pending during the reliable session.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MaxRetryCount">
|
|
<MemberSignature Language="C#" Value="public int MaxRetryCount { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxRetryCount" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A message is considered to be transferred if its delivery at the recipient has been acknowledged by the recipient.</para>
|
|
<para>If an acknowledgment has not been received within a certain amount of time for a message that has been transmitted, the infrastructure automatically retransmits the message. The infrastructure tries to send the message for, at most, a <see cref="P:System.ServiceModel.Channels.ReliableSessionBindingElement.MaxRetryCount" /> number of times. Not receiving an acknowledgment before this limit is reached is considered a fatal communication failure and causes the channel faulted event to be raised. </para>
|
|
<para>The infrastructure uses an exponential back-off algorithm to determine when to retransmit, based on a computed average round-trip time. The initial retry time is computed based on the measured roundtrip time of establishing the session. The retransmission algorithm doubles the delay with every attempt, which results in approximately 8.5 minutes passing between the first transmission attempt and the last retransmission attempt. The time for the first retransmission attempt is adjusted according to the calculated round-trip time and the resulting stretch of time that those attempts take varies accordingly. This allows the retransmission time to dynamically adapt to varying network conditions. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum number of times that a message attempts to be transferred during the reliable session.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MaxTransferWindowSize">
|
|
<MemberSignature Language="C#" Value="public int MaxTransferWindowSize { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxTransferWindowSize" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The value of the <see cref="P:System.ServiceModel.Channels.ReliableSessionBindingElement.MaxTransferWindowSize" /> property can be set on both the sender and the receiver. This value is included in the binding policy of the WSDL, so if you use the <format type="text/html"><a href="1abf3d9f-b420-46f1-b628-df238751f308">ServiceModel Metadata Utility Tool (Svcutil.exe)</a></format> to construct your client, it has the same value. Otherwise this value is whatever you set it to be on the client.</para>
|
|
<para>When this limit is reached on the sender, additional calls to send are blocked. When this limit is reached on the receiver, new messages that arrive on the underlying channel are not accepted. </para>
|
|
<para>A reliable session uses a windowing protocol to help improve network utilization. The amount of buffering required is directly derived from the size of the transmission window. When tuning this value, note that the optimal transmission window is related to the bandwidth and the latency in a straight-forward way. The ideal maximum window size is the bandwidth times the latency. Anything smaller yields less than 100% network utilization; anything larger is just wasted space.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the largest number of messages that can exist in either the send buffer or the receive buffer.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Ordered">
|
|
<MemberSignature Language="C#" Value="public bool Ordered { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Ordered" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>To get messages dispatched in order, you also must set the <see cref="T:System.ServiceModel.ConcurrencyMode" /> to <see cref="F:System.ServiceModel.ConcurrencyMode.Single" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that indicates whether message delivery must preserve the order in which messages are sent.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ReliableMessagingVersion">
|
|
<MemberSignature Language="C#" Value="public System.ServiceModel.ReliableMessagingVersion ReliableMessagingVersion { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.ReliableMessagingVersion ReliableMessagingVersion" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.ServiceModel.ReliableMessagingVersion</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>There are currently two versions of the WS-ReliableMessaging protocol supported by indigo1: WS-ReliableMessaging1.1 and WS-ReliableMessagingFebruary2005. The default version is WS-ReliableMessagingFebruary2005. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the version of WS-ReliableMessaging specified by the binding element.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.ServiceModel.Description.IPolicyExportExtension.ExportPolicy">
|
|
<MemberSignature Language="C#" Value="void IPolicyExportExtension.ExportPolicy (System.ServiceModel.Description.MetadataExporter exporter, System.ServiceModel.Description.PolicyConversionContext context);" />
|
|
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.ServiceModel.Description.IPolicyExportExtension.ExportPolicy(class System.ServiceModel.Description.MetadataExporter exporter, class System.ServiceModel.Description.PolicyConversionContext context) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="exporter" Type="System.ServiceModel.Description.MetadataExporter" />
|
|
<Parameter Name="context" Type="System.ServiceModel.Description.PolicyConversionContext" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Maps the information contained in the reliable session binding element into the WSDL elements that enable a remote endpoint to access the service with a reliable session.</para>
|
|
</summary>
|
|
<param name="exporter">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Description.MetadataExporter" /> that exports the binding information in the reliable session binding element to the WSDL elements. </param>
|
|
<param name="context">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Description.PolicyConversionContext" /> that provides the mapping from exported WSDL elements to the endpoint description.</param>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |