HybridConnectionClient Class

Definition

Namespace:

Microsoft.Azure.Relay

Assembly:

Microsoft.Azure.Relay.dll

Package:

Microsoft.Azure.Relay v2.0.15596

Provides a client for initiating new send-side HybridConnections.

public class HybridConnectionClient

type HybridConnectionClient = class

Public Class HybridConnectionClient

Inheritance

Object

HybridConnectionClient

Constructors

HybridConnectionClient(String, String)	Creates a new instance of HybridConnectionClient from a connection string and the specified HybridConection path. Use this overload only when the connection string does not use the EntityPath property.
HybridConnectionClient(String)	Creates a new instance of HybridConnectionClient using the specified connection string.
HybridConnectionClient(Uri, TokenProvider)	Create a new HybridConnectionClient instance for initiating HybridConnections with client authentication.
HybridConnectionClient(Uri)	Create a new HybridConnectionClient instance for initiating HybridConnections where no client authentication is required.

Properties

Address	Gets the address of this HybridConnection to connect through. The address on which to listen for HybridConnections. This address should be of the format "sb://contoso.servicebus.windows.net/yourhybridconnection".
ClientWebSocketFactory	Custom ClientWebSocketFactory Implementation.
KeepAliveInterval	Websocket's keep-alive interval.
OperationTimeout	Gets or sets the timeout used when connecting a HybridConnection. Default value is 70 seconds.
Proxy	Gets or sets proxy information for connecting to ServiceBus.
TokenProvider	Gets the TokenProvider for authenticating HybridConnections.
UseBuiltInClientWebSocket	Controls whether the ClientWebSocket from .NET Core or a custom implementation is used. If a custom ClientWebSocketFactory is configured then this property is ignored.

Methods

CreateConnectionAsync()	Establishes a new send-side HybridConnection and returns the Stream.
CreateConnectionAsync(IDictionary<String,String>)	Establishes a new send-side HybridConnection and returns the Stream.
GetRuntimeInformationAsync()	Gets the HybridConnectionRuntimeInformation for this HybridConnection entity using the default timeout. Unless specified in the connection string the default is 1 minute.
GetRuntimeInformationAsync(CancellationToken)	Gets the HybridConnectionRuntimeInformation for this HybridConnection entity using the provided CancellationToken.