StreamWebSocketControl.SupportedProtocols プロパティ

定義

接続ハンドシェイク中にサーバーにアドバタイズされるサポートされているサブプロトコルの一覧を追加するために使用できるコレクションを取得します。

public:
 property IVector<Platform::String ^> ^ SupportedProtocols { IVector<Platform::String ^> ^ get(); };
IVector<winrt::hstring> SupportedProtocols();
public IList<string> SupportedProtocols { get; }
var iVector = streamWebSocketControl.supportedProtocols;
Public ReadOnly Property SupportedProtocols As IList(Of String)

プロパティ値

IVector<String>

IList<String>

IVector<Platform::String>

IVector<winrt::hstring>

StreamWebSocket オブジェクトでサポートされている WebSocket サブプロトコルを含むコレクション。

実装

注釈

SupportedProtocols プロパティには、 StreamWebSocket オブジェクトでサポートされている WebSocket サブプロトコルのコレクションが含まれています。 ConnectAsync メソッドを呼び出す前に、サポートされているサブプロトコル文字列をこのコレクションに追加できます。この文字列は、WebSocket ハンドシェイク中に "Sec-WebSocket-Protocol" ヘッダーでサーバーに送信されます。 WebSocket サーバーによって選択されたプロトコルは、 Protocol プロパティで公開されます。

ConnectAsync メソッドの呼び出しが成功した後にこのコレクションにサブプロトコルを追加しようとすると、エラーは発生しませんが、新しい値は無視されます。 ただし、 ConnectAsync メソッドの呼び出しまたは接続操作がエラーで完了した場合、アプリは SupportedProtocols プロパティに格納されているコレクションを更新し、 ConnectAsync メソッド呼び出しを再試行すると、新しい値が適用されます。

適用対象

こちらもご覧ください