Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
299 lines (299 sloc) 18.8 KB
<Type Name="ServiceBusConnection" FullName="Microsoft.Azure.ServiceBus.ServiceBusConnection">
<TypeSignature Language="C#" Value="public class ServiceBusConnection" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceBusConnection extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.ServiceBus.ServiceBusConnection" />
<TypeSignature Language="VB.NET" Value="Public Class ServiceBusConnection" />
<TypeSignature Language="F#" Value="type ServiceBusConnection = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Connection object to service bus namespace
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusConnection (Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder connectionStringBuilder);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder connectionStringBuilder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.#ctor(Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionStringBuilder As ServiceBusConnectionStringBuilder)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.ServiceBusConnection : Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder -&gt; Microsoft.Azure.ServiceBus.ServiceBusConnection" Usage="new Microsoft.Azure.ServiceBus.ServiceBusConnection connectionStringBuilder" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="connectionStringBuilder" Type="Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder" />
</Parameters>
<Docs>
<param name="connectionStringBuilder">
<see cref="T:Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder" /> having namespace information.</param>
<summary>
Creates a new connection to service bus.
</summary>
<remarks>It is the responsibility of the user to close the connection after use through <see cref="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.CloseAsync" /></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusConnection (string namespaceConnectionString);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string namespaceConnectionString) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (namespaceConnectionString As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.ServiceBusConnection : string -&gt; Microsoft.Azure.ServiceBus.ServiceBusConnection" Usage="new Microsoft.Azure.ServiceBus.ServiceBusConnection namespaceConnectionString" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="namespaceConnectionString" Type="System.String" />
</Parameters>
<Docs>
<param name="namespaceConnectionString">Namespace connection string</param>
<summary>
Creates a new connection to service bus.
</summary>
<remarks>It is the responsibility of the user to close the connection after use through <see cref="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.CloseAsync" /></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusConnection (string namespaceConnectionString, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = null);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string namespaceConnectionString, class Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.#ctor(System.String,Microsoft.Azure.ServiceBus.RetryPolicy)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.ServiceBusConnection : string * Microsoft.Azure.ServiceBus.RetryPolicy -&gt; Microsoft.Azure.ServiceBus.ServiceBusConnection" Usage="new Microsoft.Azure.ServiceBus.ServiceBusConnection (namespaceConnectionString, retryPolicy)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="namespaceConnectionString" Type="System.String" />
<Parameter Name="retryPolicy" Type="Microsoft.Azure.ServiceBus.RetryPolicy" />
</Parameters>
<Docs>
<param name="namespaceConnectionString">Namespace connection string.</param>
<param name="retryPolicy">Retry policy for operations. Defaults to <see cref="P:Microsoft.Azure.ServiceBus.RetryPolicy.Default" /></param>
<summary>
Creates a new connection to service bus.
</summary>
<remarks>It is the responsibility of the user to close the connection after use through <see cref="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.CloseAsync" /></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusConnection (string endpoint, Microsoft.Azure.ServiceBus.TransportType transportType, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = null);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string endpoint, valuetype Microsoft.Azure.ServiceBus.TransportType transportType, class Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.#ctor(System.String,Microsoft.Azure.ServiceBus.TransportType,Microsoft.Azure.ServiceBus.RetryPolicy)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.ServiceBusConnection : string * Microsoft.Azure.ServiceBus.TransportType * Microsoft.Azure.ServiceBus.RetryPolicy -&gt; Microsoft.Azure.ServiceBus.ServiceBusConnection" Usage="new Microsoft.Azure.ServiceBus.ServiceBusConnection (endpoint, transportType, retryPolicy)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.String" />
<Parameter Name="transportType" Type="Microsoft.Azure.ServiceBus.TransportType" />
<Parameter Name="retryPolicy" Type="Microsoft.Azure.ServiceBus.RetryPolicy" />
</Parameters>
<Docs>
<param name="endpoint">Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net</param>
<param name="transportType">Transport type.</param>
<param name="retryPolicy">Retry policy for operations. Defaults to <see cref="P:Microsoft.Azure.ServiceBus.RetryPolicy.Default" /></param>
<summary>
Creates a new connection to service bus.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusConnection (string namespaceConnectionString, TimeSpan operationTimeout, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = null);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string namespaceConnectionString, valuetype System.TimeSpan operationTimeout, class Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.#ctor(System.String,System.TimeSpan,Microsoft.Azure.ServiceBus.RetryPolicy)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.ServiceBusConnection : string * TimeSpan * Microsoft.Azure.ServiceBus.RetryPolicy -&gt; Microsoft.Azure.ServiceBus.ServiceBusConnection" Usage="new Microsoft.Azure.ServiceBus.ServiceBusConnection (namespaceConnectionString, operationTimeout, retryPolicy)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("This constructor is obsolete. Use ServiceBusConnection(string namespaceConnectionString, RetryPolicy retryPolicy) constructor instead, providing operationTimeout in the connection string.")</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="namespaceConnectionString" Type="System.String" />
<Parameter Name="operationTimeout" Type="System.TimeSpan" />
<Parameter Name="retryPolicy" Type="Microsoft.Azure.ServiceBus.RetryPolicy" />
</Parameters>
<Docs>
<param name="namespaceConnectionString">Namespace connection string.</param>
<param name="operationTimeout">Duration after which individual operations will timeout.</param>
<param name="retryPolicy">Retry policy for operations. Defaults to <see cref="P:Microsoft.Azure.ServiceBus.RetryPolicy.Default" /></param>
<summary>
Creates a new connection to service bus.
</summary>
<remarks>It is the responsibility of the user to close the connection after use through <see cref="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.CloseAsync" /></remarks>
</Docs>
</Member>
<Member MemberName="CloseAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CloseAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task CloseAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.ServiceBusConnection.CloseAsync" />
<MemberSignature Language="VB.NET" Value="Public Function CloseAsync () As Task" />
<MemberSignature Language="F#" Value="member this.CloseAsync : unit -&gt; System.Threading.Tasks.Task" Usage="serviceBusConnection.CloseAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Closes the connection.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Endpoint">
<MemberSignature Language="C#" Value="public Uri Endpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri Endpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.ServiceBusConnection.Endpoint" />
<MemberSignature Language="VB.NET" Value="Public Property Endpoint As Uri" />
<MemberSignature Language="F#" Value="member this.Endpoint : Uri with get, set" Usage="Microsoft.Azure.ServiceBus.ServiceBusConnection.Endpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
Fully qualified domain name for Service Bus.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsClosedOrClosing">
<MemberSignature Language="C#" Value="public bool IsClosedOrClosing { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsClosedOrClosing" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.ServiceBusConnection.IsClosedOrClosing" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsClosedOrClosing As Boolean" />
<MemberSignature Language="F#" Value="member this.IsClosedOrClosing : bool" Usage="Microsoft.Azure.ServiceBus.ServiceBusConnection.IsClosedOrClosing" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns true if the Service Bus Connection is closed or closing.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OperationTimeout">
<MemberSignature Language="C#" Value="public TimeSpan OperationTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan OperationTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.ServiceBusConnection.OperationTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property OperationTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.OperationTimeout : TimeSpan with get, set" Usage="Microsoft.Azure.ServiceBus.ServiceBusConnection.OperationTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
OperationTimeout is applied in erroneous situations to notify the caller about the relevant <see cref="T:Microsoft.Azure.ServiceBus.ServiceBusException" /></summary>
<value>To be added.</value>
<remarks>Defaults to 1 minute.</remarks>
</Docs>
</Member>
<Member MemberName="RetryPolicy">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ServiceBus.RetryPolicy RetryPolicy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.ServiceBus.RetryPolicy RetryPolicy" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.ServiceBusConnection.RetryPolicy" />
<MemberSignature Language="VB.NET" Value="Public Property RetryPolicy As RetryPolicy" />
<MemberSignature Language="F#" Value="member this.RetryPolicy : Microsoft.Azure.ServiceBus.RetryPolicy with get, set" Usage="Microsoft.Azure.ServiceBus.ServiceBusConnection.RetryPolicy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ServiceBus.RetryPolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>
Retry policy for operations performed on the connection.
</summary>
<value>To be added.</value>
<remarks>Defaults to <see cref="P:Microsoft.Azure.ServiceBus.RetryPolicy.Default" /></remarks>
</Docs>
</Member>
<Member MemberName="TokenProvider">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ServiceBus.Primitives.ITokenProvider TokenProvider { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.ServiceBus.Primitives.ITokenProvider TokenProvider" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.ServiceBusConnection.TokenProvider" />
<MemberSignature Language="VB.NET" Value="Public Property TokenProvider As ITokenProvider" />
<MemberSignature Language="F#" Value="member this.TokenProvider : Microsoft.Azure.ServiceBus.Primitives.ITokenProvider with get, set" Usage="Microsoft.Azure.ServiceBus.ServiceBusConnection.TokenProvider" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ServiceBus.Primitives.ITokenProvider</ReturnType>
</ReturnValue>
<Docs>
<summary>
Token provider for authentication. <see cref="P:Microsoft.Azure.ServiceBus.ServiceBusConnection.TokenProvider" /></summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TransportType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ServiceBus.TransportType TransportType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.ServiceBus.TransportType TransportType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.ServiceBusConnection.TransportType" />
<MemberSignature Language="VB.NET" Value="Public Property TransportType As TransportType" />
<MemberSignature Language="F#" Value="member this.TransportType : Microsoft.Azure.ServiceBus.TransportType with get, set" Usage="Microsoft.Azure.ServiceBus.ServiceBusConnection.TransportType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>3.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ServiceBus.TransportType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get the transport type from the connection string.
<remarks>Available options: Amqp and AmqpWebSockets.</remarks></summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.