WebSocket WebSocket WebSocket WebSocket Class

Definition

WebSocket のアップグレードが完了した後、WebSocket クラスにより、アプリケーションがデータを送受信できるようになります。 The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed.

public ref class WebSocket abstract : IDisposable
public abstract class WebSocket : IDisposable
type WebSocket = class
    interface IDisposable
Public MustInherit Class WebSocket
Implements IDisposable
Inheritance
WebSocketWebSocketWebSocketWebSocket
Derived
Implements

Remarks

一部のクラスで、System.Net.WebSockets名前空間は、Windows 7、Windows Vista SP2、および Windows Server 2008 でサポートされます。Some of the classes in the System.Net.WebSockets namespace are supported on Windows 7, Windows Vista SP2, and Windows Server 2008. ただし、クライアントとサーバーの Websocket の唯一のパブリックの実装は、Windows 8 および Windows Server 2012 でサポートされます。However, the only public implementations of client and server WebSockets are supported on Windows 8 and Windows Server 2012. クラスとクラスの要素、 System.Net.WebSockets Windows 7、Windows Vista SP2、および Windows Server 2008 でサポートされている名前空間は抽象クラス。The classes and class elements in the System.Net.WebSockets namespace that are supported on Windows 7, Windows Vista SP2, and Windows Server 2008 are abstract classes. これにより、アプリケーション開発者を継承し、クライアント Websocket の実際の実装で、これらの抽象クラスを拡張できます。This allows an application developer to inherit and extend these abstract classes with an actual implementation of client WebSockets.

Constructors

WebSocket() WebSocket() WebSocket() WebSocket()

WebSocket クラスのインスタンスを作成します。 Creates an instance of the WebSocket class.

Properties

CloseStatus CloseStatus CloseStatus CloseStatus

リモート エンドポイントが終了ハンドシェイクを開始した理由を示します。 Indicates the reason why the remote endpoint initiated the close handshake.

CloseStatusDescription CloseStatusDescription CloseStatusDescription CloseStatusDescription

リモート エンドポイントが接続の終了理由を記述できるようにします。 Allows the remote endpoint to describe the reason why the connection was closed.

DefaultKeepAliveInterval DefaultKeepAliveInterval DefaultKeepAliveInterval DefaultKeepAliveInterval

WebSocket プロトコルの既定の keep-alive 間隔をミリ秒単位で取得します。 Gets the default WebSocket protocol keep-alive interval in milliseconds.

State State State State

WebSocket 接続の現在の状態を返します。 Returns the current state of the WebSocket connection.

SubProtocol SubProtocol SubProtocol SubProtocol

開始ハンドシェイクでネゴシエートされたサブプロトコル。 The subprotocol that was negotiated during the opening handshake.

Methods

Abort() Abort() Abort() Abort()

WebSocket 接続を中止し、保留中の IO 操作を取り消します。 Aborts the WebSocket connection and cancels any pending IO operations.

CloseAsync(WebSocketCloseStatus, String, CancellationToken) CloseAsync(WebSocketCloseStatus, String, CancellationToken) CloseAsync(WebSocketCloseStatus, String, CancellationToken) CloseAsync(WebSocketCloseStatus, String, CancellationToken)

WebSocket プロトコル仕様 セクション 7 で定義されている終了ハンドシェイクを使用して、非同期操作で WebSocket 接続を閉じます。 Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the WebSocket protocol specification section 7.

CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)

WebSocket プロトコル仕様のセクション 7 で定義されている終了ハンドシェイクを開始または完了します。 Initiates or completes the close handshake defined in the WebSocket protocol specification section 7.

CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32)

この WebSocket インスタンスを使用するようにクライアント バッファーを作成します。 Create client buffers to use with this WebSocket instance.

CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>) CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>) CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>) CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)

この API は、.NET Framework インフラストラクチャをサポートします。独自に作成したコードから直接使用するためのものではありません。 This API supports the .NET Framework infrastructure and is not intended to be used directly from your code. WSPC がフレーム化に使用するクライアント側の WebSocket クラスを呼び出し元が作成できるようにします。 Allows callers to create a client side WebSocket class which will use the WSPC for framing purposes.

CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan)
CreateServerBuffer(Int32) CreateServerBuffer(Int32) CreateServerBuffer(Int32) CreateServerBuffer(Int32)

WebSocket サーバー バッファーを作成します。 Creates a WebSocket server buffer.

Dispose() Dispose() Dispose() Dispose()

ASP.NET および自己ホスト型の実装のアンマネージ リソースをクリーンアップするために使用します。 Used to clean up unmanaged resources for ASP.NET and self-hosted implementations.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。 Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。 Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。 Gets the Type of the current instance.

(Inherited from Object)
IsApplicationTargeting45() IsApplicationTargeting45() IsApplicationTargeting45() IsApplicationTargeting45()

WebSocket インスタンスのターゲットが .NET Framework 4.5.NET Framework 4.5 であることを示す値を返します。 Returns a value that indicates if the WebSocket instance is targeting .NET Framework 4.5.NET Framework 4.5.

IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState)

WebSocket インスタンスの状態が終了または中止の場合、状態を示す値を返します。 Returns a value that indicates if the state of the WebSocket instance is closed or aborted.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。 Creates a shallow copy of the current Object.

(Inherited from Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken)

WebSocket 接続からデータを非同期的に受信します。 Receives data from the WebSocket connection asynchronously.

ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken)
RegisterPrefixes() RegisterPrefixes() RegisterPrefixes() RegisterPrefixes()

この API は、.NET Framework インフラストラクチャをサポートします。独自に作成したコードから直接使用するためのものではありません。 This API supports the .NET Framework infrastructure and is not intended to be used directly from your code. WebSocket 要求のプレフィックス (ws および wss) を呼び出し元が登録できるようにします。 Allows callers to register prefixes for WebSocket requests (ws and wss).

SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)

WebSocket 接続でデータを非同期的に送信します。 Sends data over the WebSocket connection asynchronously.

SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)
ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[])

接続が予期された状態であることを確認します。 Verifies that the connection is in an expected state.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。 Returns a string that represents the current object.

(Inherited from Object)

Applies to