ClientWebSocket 類別

定義

命名空間:

System.Net.WebSockets

組件:

System.Net.WebSockets.Client.dll

來源:

ClientWebSocket.cs

提供用於連線到 WebSocket 服務的用戶端。

public ref class ClientWebSocket sealed : System::Net::WebSockets::WebSocket

public sealed class ClientWebSocket : System.Net.WebSockets.WebSocket

type ClientWebSocket = class
    inherit WebSocket

Public NotInheritable Class ClientWebSocket
Inherits WebSocket

繼承

Object

WebSocket

ClientWebSocket

備註

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

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

建構函式

ClientWebSocket()

建立 ClientWebSocket 類別的執行個體。

屬性

CloseStatus	取得已在 ClientWebSocket 執行個體上起始關閉訊號交換的原因。
CloseStatusDescription	取得 ClientWebSocket 執行個體關閉原因的描述。
HttpResponseHeaders	如果 CollectHttpResponseDetails 設定) 或設定升級回應標頭，則取得 (。
HttpStatusCode	如果 CollectHttpResponseDetails 已設定，則取得升級回應狀態碼。
Options	取得 ClientWebSocket 執行個體的 WebSocket 選項。
State	取得 ClientWebSocket 執行個體的 WebSocket 狀態。
SubProtocol	取得 ClientWebSocket 執行個體受支援的 WebSocket 子通訊協定。

方法

Abort()	中止連接，並取消任何暫止的 IO 作業。
CloseAsync(WebSocketCloseStatus, String, CancellationToken)	以非同步作業方式關閉 ClientWebSocket 執行個體。
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)	以非同步作業方式關閉 ClientWebSocket 執行個體的輸出。
ConnectAsync(Uri, CancellationToken)	以非同步作業的方式連線到 WebSocket 伺服器。
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)	以非同步作業的方式連線到 WebSocket 伺服器。
Dispose()	釋放由 ClientWebSocket 執行個體使用的 Unmanaged 資源。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)	將 ClientWebSocket 上的資料當成非同步作業接收。
ReceiveAsync(Memory<Byte>, CancellationToken)	將 ClientWebSocket 上的資料當成非同步作業接收。
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)	以非同步作業傳送 ClientWebSocket 上的資料。
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)	以非同步作業從唯讀位元組記憶體範圍傳送 ClientWebSocket 上的資料。
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)	以非同步作業從唯讀位元組記憶體範圍傳送 ClientWebSocket 上的資料。
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)