HttpListenerContext.AcceptWebSocketAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
WebSocket 接続を非同期操作として受け入れます。
オーバーロード
| AcceptWebSocketAsync(String) |
WebSocket 接続を非同期操作として受け入れます。 |
| AcceptWebSocketAsync(String, TimeSpan) |
サポートされている WebSocket サブプロトコルと WebSocket のキープアライブ間隔を指定する WebSocket 接続を、非同期操作として受け入れます。 |
| AcceptWebSocketAsync(String, Int32, TimeSpan) |
サポートされている WebSocket サブプロトコル受信バッファー サイズと WebSocket のキープアライブ間隔を指定する WebSocket 接続を、非同期操作として受け入れます。 |
| AcceptWebSocketAsync(String, Int32, TimeSpan, ArraySegment<Byte>) |
サポートされている WebSocket サブプロトコル受信バッファー サイズ、WebSocket のキープアライブ間隔、内部バッファーを指定する WebSocket 接続を、非同期操作として受け入れます。 |
AcceptWebSocketAsync(String)
WebSocket 接続を非同期操作として受け入れます。
public:
System::Threading::Tasks::Task<System::Net::WebSockets::HttpListenerWebSocketContext ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol);public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string subProtocol);public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string? subProtocol);member this.AcceptWebSocketAsync : string -> System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext>Public Function AcceptWebSocketAsync (subProtocol As String) As Task(Of HttpListenerWebSocketContext)パラメーター
- subProtocol
- String
サポートされている WebSocket サブプロトコル。
戻り値
非同期操作を表すタスク オブジェクト。 タスク オブジェクトの Result プロパティは、HttpListenerWebSocketContext オブジェクトを返します。
例外
WebSocket ハンドシェイクを完了するために応答を送信中にエラーが発生しました。
注釈
この操作はブロックされません。 返された Task<TResult> オブジェクトは、WebSocket 接続が受け入れられた後に完了します。
受信バッファーのサイズは 16,385 バイトです。 WebSocket のキープアライブ間隔は、既定値の 30,000 (30 秒) に設定されます。
こちらもご覧ください
適用対象
AcceptWebSocketAsync(String, TimeSpan)
サポートされている WebSocket サブプロトコルと WebSocket のキープアライブ間隔を指定する WebSocket 接続を、非同期操作として受け入れます。
public:
System::Threading::Tasks::Task<System::Net::WebSockets::HttpListenerWebSocketContext ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol, TimeSpan keepAliveInterval);public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string subProtocol, TimeSpan keepAliveInterval);public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string? subProtocol, TimeSpan keepAliveInterval);member this.AcceptWebSocketAsync : string * TimeSpan -> System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext>Public Function AcceptWebSocketAsync (subProtocol As String, keepAliveInterval As TimeSpan) As Task(Of HttpListenerWebSocketContext)パラメーター
- subProtocol
- String
サポートされている WebSocket サブプロトコル。
- keepAliveInterval
- TimeSpan
WebSocket プロトコルのキープ アライブ間隔 (ミリ秒単位)。
戻り値
非同期操作を表すタスク オブジェクト。 タスク オブジェクトの Result プロパティは、HttpListenerWebSocketContext オブジェクトを返します。
例外
keepAliveInterval が小さすぎます。
WebSocket ハンドシェイクを完了するために応答を送信中にエラーが発生しました。
注釈
この操作はブロックされません。 返された Task<TResult> オブジェクトは、WebSocket 接続が受け入れられた後に完了します。
受信バッファーのサイズは 16,385 バイトです。
こちらもご覧ください
適用対象
AcceptWebSocketAsync(String, Int32, TimeSpan)
サポートされている WebSocket サブプロトコル受信バッファー サイズと WebSocket のキープアライブ間隔を指定する WebSocket 接続を、非同期操作として受け入れます。
public:
System::Threading::Tasks::Task<System::Net::WebSockets::HttpListenerWebSocketContext ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval);public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval);public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string? subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval);member this.AcceptWebSocketAsync : string * int * TimeSpan -> System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext>Public Function AcceptWebSocketAsync (subProtocol As String, receiveBufferSize As Integer, keepAliveInterval As TimeSpan) As Task(Of HttpListenerWebSocketContext)パラメーター
- subProtocol
- String
サポートされている WebSocket サブプロトコル。
- receiveBufferSize
- Int32
受信バッファーのサイズ (バイト単位)。
- keepAliveInterval
- TimeSpan
WebSocket プロトコルのキープ アライブ間隔 (ミリ秒単位)。
戻り値
非同期操作を表すタスク オブジェクト。 タスク オブジェクトの Result プロパティは、HttpListenerWebSocketContext オブジェクトを返します。
例外
keepAliveInterval が小さすぎます。
- または -
receiveBufferSizeが 16 バイト未満です - または -
receiveBufferSizeが 64K バイトを超えています。
WebSocket ハンドシェイクを完了するために応答を送信中にエラーが発生しました。
注釈
この操作はブロックされません。 返された Task<TResult> > オブジェクトは、WebSocket 接続が受け入れられた後に完了します。
こちらもご覧ください
適用対象
AcceptWebSocketAsync(String, Int32, TimeSpan, ArraySegment<Byte>)
サポートされている WebSocket サブプロトコル受信バッファー サイズ、WebSocket のキープアライブ間隔、内部バッファーを指定する WebSocket 接続を、非同期操作として受け入れます。
public:
System::Threading::Tasks::Task<System::Net::WebSockets::HttpListenerWebSocketContext ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<System::Byte> internalBuffer);public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<byte> internalBuffer);public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync (string? subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<byte> internalBuffer);member this.AcceptWebSocketAsync : string * int * TimeSpan * ArraySegment<byte> -> System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext>Public Function AcceptWebSocketAsync (subProtocol As String, receiveBufferSize As Integer, keepAliveInterval As TimeSpan, internalBuffer As ArraySegment(Of Byte)) As Task(Of HttpListenerWebSocketContext)パラメーター
- subProtocol
- String
サポートされている WebSocket サブプロトコル。
- receiveBufferSize
- Int32
受信バッファーのサイズ (バイト単位)。
- keepAliveInterval
- TimeSpan
WebSocket プロトコルのキープ アライブ間隔 (ミリ秒単位)。
- internalBuffer
- ArraySegment<Byte>
この操作で使用する内部バッファー。
戻り値
非同期操作を表すタスク オブジェクト。 タスク オブジェクトの Result プロパティは、HttpListenerWebSocketContext オブジェクトを返します。
例外
keepAliveInterval が小さすぎます。
- または -
receiveBufferSizeが 16 バイト未満です - または -
receiveBufferSizeが 64K バイトを超えています。
WebSocket ハンドシェイクを完了するために応答を送信中にエラーが発生しました。
注釈
この操作はブロックされません。 返された Task<TResult> オブジェクトは、WebSocket 接続が受け入れられた後に完了します。