Permalink
Fetching contributors…
Cannot retrieve contributors at this time
232 lines (232 sloc) 15.2 KB
<Type Name="NetTcpRelayBinding" FullName="Microsoft.ServiceBus.NetTcpRelayBinding">
<TypeSignature Language="C#" Value="public class NetTcpRelayBinding : Microsoft.ServiceBus.NetTcpRelayBindingBase, System.ServiceModel.Channels.IBindingRuntimePreferences" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NetTcpRelayBinding extends Microsoft.ServiceBus.NetTcpRelayBindingBase implements class System.ServiceModel.Channels.IBindingRuntimePreferences" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.NetTcpRelayBinding" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ServiceBus.NetTcpRelayBindingBase</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ServiceModel.Channels.IBindingRuntimePreferences</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Provides a secure, reliable binding suitable for cross-computer communication.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NetTcpRelayBinding ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.ServiceBus.NetTcpRelayBinding" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NetTcpRelayBinding (string configurationName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string configurationName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.#ctor(System.String)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="configurationName" Type="System.String" />
</Parameters>
<Docs>
<param name="configurationName">The configuration to use.</param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.NetTcpRelayBinding" /> class with a specified XML configuration. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NetTcpRelayBinding (Microsoft.ServiceBus.EndToEndSecurityMode securityMode, Microsoft.ServiceBus.RelayClientAuthenticationType relayClientAuthenticationType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.ServiceBus.EndToEndSecurityMode securityMode, valuetype Microsoft.ServiceBus.RelayClientAuthenticationType relayClientAuthenticationType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.#ctor(Microsoft.ServiceBus.EndToEndSecurityMode,Microsoft.ServiceBus.RelayClientAuthenticationType)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="securityMode" Type="Microsoft.ServiceBus.EndToEndSecurityMode" />
<Parameter Name="relayClientAuthenticationType" Type="Microsoft.ServiceBus.RelayClientAuthenticationType" />
</Parameters>
<Docs>
<param name="securityMode">The type of security used with the binding. </param>
<param name="relayClientAuthenticationType">The type of client authentication used on the relay. </param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.NetTcpRelayBinding" /> class with the type of security used and relay client authentication specified.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NetTcpRelayBinding (Microsoft.ServiceBus.EndToEndSecurityMode securityMode, Microsoft.ServiceBus.RelayClientAuthenticationType relayClientAuthenticationType, bool reliableSessionEnabled);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.ServiceBus.EndToEndSecurityMode securityMode, valuetype Microsoft.ServiceBus.RelayClientAuthenticationType relayClientAuthenticationType, bool reliableSessionEnabled) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.#ctor(Microsoft.ServiceBus.EndToEndSecurityMode,Microsoft.ServiceBus.RelayClientAuthenticationType,System.Boolean)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="securityMode" Type="Microsoft.ServiceBus.EndToEndSecurityMode" />
<Parameter Name="relayClientAuthenticationType" Type="Microsoft.ServiceBus.RelayClientAuthenticationType" />
<Parameter Name="reliableSessionEnabled" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="securityMode">The type of security used with the Azure Service Bus binding.</param>
<param name="relayClientAuthenticationType">The type of client authentication used on the relay. </param>
<param name="reliableSessionEnabled">true if reliable sessions are enabled; otherwise, false.</param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.NetTcpRelayBinding" /> class with the type of security used, the type of client authentication, and a value that indicates whether reliable sessions are explicitly enabled. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected NetTcpRelayBinding (Microsoft.ServiceBus.TcpRelayTransportBindingElement transport, System.ServiceModel.Channels.BinaryMessageEncodingBindingElement encoding, System.ServiceModel.Channels.ReliableSessionBindingElement session, Microsoft.ServiceBus.NetTcpRelaySecurity security);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.ServiceBus.TcpRelayTransportBindingElement transport, class System.ServiceModel.Channels.BinaryMessageEncodingBindingElement encoding, class System.ServiceModel.Channels.ReliableSessionBindingElement session, class Microsoft.ServiceBus.NetTcpRelaySecurity security) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.#ctor(Microsoft.ServiceBus.TcpRelayTransportBindingElement,System.ServiceModel.Channels.BinaryMessageEncodingBindingElement,System.ServiceModel.Channels.ReliableSessionBindingElement,Microsoft.ServiceBus.NetTcpRelaySecurity)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="transport" Type="Microsoft.ServiceBus.TcpRelayTransportBindingElement" />
<Parameter Name="encoding" Type="System.ServiceModel.Channels.BinaryMessageEncodingBindingElement" />
<Parameter Name="session" Type="System.ServiceModel.Channels.ReliableSessionBindingElement" />
<Parameter Name="security" Type="Microsoft.ServiceBus.NetTcpRelaySecurity" />
</Parameters>
<Docs>
<param name="transport">To be added.</param>
<param name="encoding">To be added.</param>
<param name="session">To be added.</param>
<param name="security">To be added.</param>
<summary>Provides a secure, reliable binding suitable for cross-computer communication.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApplyConfiguration">
<MemberSignature Language="C#" Value="protected override void ApplyConfiguration (string configurationName);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void ApplyConfiguration(string configurationName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.ApplyConfiguration(System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="configurationName" Type="System.String" />
</Parameters>
<Docs>
<param name="configurationName">The name of the configuration element to take the settings from.</param>
<summary>Applies the settings from the configuration element that corresponds to
the specified name to the current instance of this binding element.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateBindingElements">
<MemberSignature Language="C#" Value="public override System.ServiceModel.Channels.BindingElementCollection CreateBindingElements ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.ServiceModel.Channels.BindingElementCollection CreateBindingElements() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.CreateBindingElements" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.BindingElementCollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a collection with the binding elements for the binding. </summary>
<returns>Returns a
<see cref="T:System.ServiceModel.Channels.BindingElementCollection" /> that contains the ordered stack of binding elements.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateMessageSecurity">
<MemberSignature Language="C#" Value="protected override System.ServiceModel.Channels.SecurityBindingElement CreateMessageSecurity ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance class System.ServiceModel.Channels.SecurityBindingElement CreateMessageSecurity() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.CreateMessageSecurity" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.SecurityBindingElement</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates the message security token for the current instance. </summary>
<returns>Returns <see cref="T:System.ServiceModel.Channels.SecurityBindingElement" />.Contains the message security token. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsBindingElementsMatch">
<MemberSignature Language="C#" Value="protected bool IsBindingElementsMatch (Microsoft.ServiceBus.TcpRelayTransportBindingElement transport, System.ServiceModel.Channels.BinaryMessageEncodingBindingElement encoding, System.ServiceModel.Channels.ReliableSessionBindingElement session);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance bool IsBindingElementsMatch(class Microsoft.ServiceBus.TcpRelayTransportBindingElement transport, class System.ServiceModel.Channels.BinaryMessageEncodingBindingElement encoding, class System.ServiceModel.Channels.ReliableSessionBindingElement session) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.NetTcpRelayBinding.IsBindingElementsMatch(Microsoft.ServiceBus.TcpRelayTransportBindingElement,System.ServiceModel.Channels.BinaryMessageEncodingBindingElement,System.ServiceModel.Channels.ReliableSessionBindingElement)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="transport" Type="Microsoft.ServiceBus.TcpRelayTransportBindingElement" />
<Parameter Name="encoding" Type="System.ServiceModel.Channels.BinaryMessageEncodingBindingElement" />
<Parameter Name="session" Type="System.ServiceModel.Channels.ReliableSessionBindingElement" />
</Parameters>
<Docs>
<param name="transport"> The transport to match. </param>
<param name="encoding"> The encoding to match. </param>
<param name="session"> The session to match. </param>
<summary>Returns a value that determines whether the specified objects have matching binding elements. </summary>
<returns>Returns<see cref="T:System.Boolean" />.true if the objects match; otherwise, false. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReliableSession">
<MemberSignature Language="C#" Value="public System.ServiceModel.OptionalReliableSession ReliableSession { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.OptionalReliableSession ReliableSession" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.NetTcpRelayBinding.ReliableSession" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.OptionalReliableSession</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets an object that indicates whether a reliable session is established between Azure Service Bus channel endpoints. </summary>
<value>Returns
<see cref="T:System.ServiceModel.OptionalReliableSession" />.Indicates whether a WS-RM reliable session is established between channel endpoints. The default is false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>