WebSocket 類別

定義

命名空間:

System.Net.WebSockets

組件:

System.Net.WebSockets.dll

來源:

WebSocket.cs

WebSocket 類別允許應用程式在 WebSocket 升級完成之後傳送和接收資料。

public ref class WebSocket abstract : IDisposable

public abstract class WebSocket : IDisposable

type WebSocket = class
    interface IDisposable

Public MustInherit Class WebSocket
Implements IDisposable

繼承

Object

WebSocket

衍生

System.Net.WebSockets.ClientWebSocket

System.Web.WebSockets.AspNetWebSocket

實作

IDisposable

備註

Windows 7、Windows Vista SP2 和 Windows Server 2008 支援命名空間中的 System.Net.WebSockets 某些類別。 不過，Windows 8 和 Windows Server 2012 僅支援用戶端和伺服器WebSockets的公用實作。 Windows 7、Windows Vista SP2 和 Windows Server 2008 所支援的命名空間中的類別和類別專案 System.Net.WebSockets 是抽象類。 這可讓應用程式開發人員透過用戶端 WebSockets 的實際實作來繼承和擴充這些抽象類。

每個 WebSocket 物件都支援一個傳送和一個接收。 不支援同時發出多個傳送或多個接收 (，例如，不需要等候，或從多個線程發出同步處理 ) ，且 會導致 未定義的行為。 在發出下一個作業之前，請確定先前的作業會等候 (或已完成) 。 透過最適合您的任何機制串行化存取，例如使用鎖定或旗號。

建構函式

WebSocket()

建立 WebSocket 類別的執行個體。

屬性

CloseStatus	表示遠端端點已起始關閉訊號交換的原因。
CloseStatusDescription	允許遠端端點描述此連接關閉的原因。
DefaultKeepAliveInterval	取得預設 WebSocket 通訊協定保持連接間隔。
State	傳回 WebSocket 連線的目前狀態。
SubProtocol	取得開始信號交握期間所交涉的子通訊協定。

方法

Abort()	中止 WebSocket 連線並取消任何暫止 IO 作業。
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	以非同步作業使用 WebSocket 通訊協定規格第 7 節中所定義的關閉信號交換，關閉 WebSocket 連接。
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	啟始或完成 WebSocket 通訊協定規格第 7 節中定義的關閉信號交換。
CreateClientBuffer(Int32, Int32)	建立要與這個 WebSocket 執行個體搭配使用的用戶端緩衝區。
CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)	此 API 支援此產品基礎結構，但無法直接用於程式碼之中。 允許呼叫端建立使用 WSPC 進行框架處理的用戶端 WebSocket 類別。
CreateFromStream(Stream, Boolean, String, TimeSpan)	建立新的 WebSocket 物件，其會在指定的資料流上運作，表示 Web 通訊端連線。
CreateFromStream(Stream, WebSocketCreationOptions)	WebSocket建立 ，在代表Web套接字連線的上Stream運作。
CreateServerBuffer(Int32)	建立 WebSocket 伺服器緩衝區。
Dispose()	用來清除 Unmanaged 資源，適用於 ASP.NET 和自我裝載的實作。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
IsApplicationTargeting45()	已淘汰. 傳回值，指出 WebSocket 實例是否以 .NET Framework 4.5 為目標。
IsStateTerminal(WebSocketState)	傳回值，指出 WebSocket 執行個體的狀態是關閉或中止。
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	以非同步方式從 WebSocket 連接接收資料。
ReceiveAsync(Memory<Byte>, CancellationToken)	以非同步方式從 WebSocket 連接接收資料。
RegisterPrefixes()	此 API 支援此產品基礎結構，但無法直接用於程式碼之中。 已淘汰. 允許呼叫端註冊 WebSocket 要求 (ws 和 wss) 的前置詞。
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	以非同步的方式透過 WebSocket 連線傳送資料。
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	以非同步的方式透過 WebSocket 連線傳送資料。
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	以非同步的方式透過 WebSocket 連線傳送資料。
ThrowOnInvalidState(WebSocketState, WebSocketState[])	確認連接處於預期的狀態。
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)