語言

WebSocketKeepAlive 類別

定義

提供在連接的 WebSocket 上傳送 keep-alive 協定的能力。

public ref class WebSocketKeepAlive sealed : IBackgroundTask
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class WebSocketKeepAlive final : IBackgroundTask
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class WebSocketKeepAlive final : IBackgroundTask
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class WebSocketKeepAlive : IBackgroundTask
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class WebSocketKeepAlive : IBackgroundTask
Public NotInheritable Class WebSocketKeepAlive
Implements IBackgroundTask
繼承
Object Platform::Object IInspectable WebSocketKeepAlive
屬性
實作

Windows 需求

規格需求 Description
裝置系列
Windows 10 (已於 10.0.10240.0 引進)
API contract
Windows.Foundation.UniversalApiContract (已於 v1.0 引進)

備註

WebSocketKeepAlive 類別與 ControlChannelTrigger 類別及相關介面結合使用,以啟用 StreamWebSocket 與 MessageWebSocket 類別的即時網路狀態與觸發器。 控制通道觸發器被長期運行的網路應用程式用來減少網路與系統資源的使用。 網路觸發器允許應用程式在一段時間內切換到低功耗模式,同時保持既有的網路連線完整,但處於低功耗狀態。 應用程式可以設定系統用來啟動的 keep-alive 觸發器,決定何時喚醒並發送 WebSocket 的 keep-alive 封包。

UWP 應用程式通常在不再處於前景時會被暫停。 有些例外情況下,應用程式不應該被暫停(例如正在列印、存取音訊串流、背景傳輸檔案等)。 ControlChannelTrigger 類別允許已建立 WebSocket 連線的網路應用程式通知系統,該網路連線應保持運作,並在收到應用程式的網路資料時喚醒暫停的應用程式,或發送 WebSocket 保持生命封包。

WebSocketKeepAlive 被用作 ControlChannelTrigger 中 keep-alive 的 TaskEntryPoint。 開發者需要撰寫程式碼來處理接收資料。

關於暫停與喚醒應用程式的更多資訊,請參考 如何設定背景連線選項。

欲了解更多關於 WebSocket 保持生命控制框架的資訊,請參閱 WebSocket 協定。

建構函式

名稱 Description
WebSocketKeepAlive()

建立一個新的 WebSocketKeepAlive 物件。

方法

名稱 Description
Run(IBackgroundTaskInstance)

在連接的 WebSocket 上傳送一個 keep alive 協定。

適用於