HybridConnectionListener クラス

定義

リモート クライアントから HybridConnections を受け入れるためのリスナーを提供します。

public class HybridConnectionListener : Microsoft.Azure.Relay.IConnectionStatus
type HybridConnectionListener = class
    interface IConnectionStatus
Public Class HybridConnectionListener
Implements IConnectionStatus
継承
HybridConnectionListener
実装

コンストラクター

HybridConnectionListener(String)

指定した接続文字列を使用して の HybridConnectionListener 新しいインスタンスを作成します。 このオーバーロードは、AAD が認証方法ではない場合にのみ使用します。

HybridConnectionListener(String, String)

接続文字列と指定した HybridConection パスから の HybridConnectionListener 新しいインスタンスを作成します。 接続文字列で プロパティが使用されておらず、AAD が認証方法ではない場合にのみ、このオーバーロードを使用 EntityPath します。

HybridConnectionListener(Uri, TokenProvider)

HybridConnections を受け入れるための新しい HybridConnectionListener インスタンスを作成します。

プロパティ

AcceptHandler

要求ヘッダーを検査し、応答ヘッダーを制御し、Web ソケットアップグレード要求を受け入れるか拒否するかを決定し、拒否する場合は状態コード/説明を制御できるカスタム ハンドラーのインストールを許可します。 AcceptHandler は、クライアント要求を受け入れる場合は true を返し、拒否する場合は false を返す必要があります。

Address

HybridConnections をリッスンするアドレスを取得します。 このアドレスは、"sb://contoso.servicebus.windows.net/yourhybridconnection" の形式にする必要があります。

ClientWebSocketFactory

カスタム ClientWebSocket の実装。

IsOnline

接続がオンラインかどうかを決定する値を取得します。

KeepAliveInterval

Websocket のキープアライブ間隔。

LastError

オフライン状態から接続を再確立しようとしたときに発生した最後のエラーを取得します。

Proxy

ServiceBus に接続するためのプロキシ情報を取得または設定します。

RequestHandler

ハイブリッド Http 要求のハンドラーをインストールします。

TokenProvider

この HybridConnection リスナーを認証するための TokenProvider を取得します。

TrackingContext

このリスナーの TrackingContext を取得します。

UseBuiltInClientWebSocket

.NET Core の ClientWebSocket を使用するか、カスタム実装を使用するかを制御します。 カスタム ClientWebSocketFactory が構成されている場合、このプロパティは無視されます。

メソッド

AcceptConnectionAsync()

リモート クライアントによって開始された新しい HybridConnection を受け入れ、Stream を返します。

CloseAsync()

既定のタイムアウトを HybridConnectionListener 使用して を閉じます。 接続文字列で指定しない限り、既定値は 1 分です。

CloseAsync(CancellationToken)

指定された CancellationToken を使用して を HybridConnectionListener 閉じます。

CloseAsync(TimeSpan)

指定されたタイムアウトを HybridConnectionListener 使用して を閉じます。

GetRuntimeInformationAsync()

既定のタイムアウトを HybridConnectionRuntimeInformation 使用して、この HybridConnection エンティティの を取得します。 接続文字列で指定しない限り、既定値は 1 分です。

GetRuntimeInformationAsync(CancellationToken)

指定された CancellationToken を HybridConnectionRuntimeInformation 使用して、この HybridConnection エンティティの を取得します。

OpenAsync()

HybridConnectionListener 開き、ServiceBus でリスナーとして登録します。 接続文字列で指定しない限り、既定値は 1 分です。

OpenAsync(CancellationToken)

HybridConnectionListener 開き、ServiceBus でリスナーとして登録します。

OpenAsync(TimeSpan)

HybridConnectionListener 開き、ServiceBus でリスナーとして登録します。

ToString()

現在のオブジェクトを表す文字列を返します。 エンドツーエンドの関連付け用の TrackingId が含まれます。

イベント

Connecting

リスナーが接続損失後に ServiceBus との再接続を試みるときに発生します。 詳細については、LastError を確認してください。

Offline

リスナーが ServiceBus との再接続を試みなくなったときに発生します。 理由としては、ユーザーが開始したリスナーが閉じるか、HybridConnection 管理オブジェクトが削除された (ポータルや ARM など) などがあります。 このイベントが予期せず発生した場合の詳細については、LastError を確認してください。

Online

リスナーが ServiceBus に正常に接続または再接続したときに発生します。 この時点では LastError は null になります。

適用対象