语言

WebSocketKeepAlive 类

定义

提供在连接的 WebSocket 上发送 WebSocket 协议保持活动状态的功能。

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 要求

要求 说明
设备系列
Windows 10 (在 10.0.10240.0 中引入)
API contract
Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

注解

WebSocketKeepAlive 类与 ControlChannelTrigger 类和相关接口结合使用,为 StreamWebSocket 和 MessageWebSocket 类启用实时网络状态和触发器。 控制通道触发器由长时间运行的网络应用使用,以最大程度地减少网络和系统资源使用情况。 网络触发器允许应用在一段时间内下降到低功率模式,同时仍然保持建立的网络连接完好无损,但处于低功率状态。 应用可以设置系统用于何时唤醒并发送 WebSocket 保持活动数据包的保持活动触发器。

当 UWP 应用不再处于前台时,它通常会暂停。 在某些情况下,应用不应暂停(例如,主动打印、访问音频流和传输后台的文件)。 ControlChannelTrigger 类允许已建立 WebSocket 连接的网络应用通知系统网络连接应保持运行状态,并且当收到应用网络数据或发送 WebSocket 保持活动数据包时,系统应唤醒挂起的应用。

WebSocketKeepAlive 用作 ControlChannelTrigger 中保持活动状态的 TaskEntryPoint。 开发人员需要编写代码来处理接收数据。

有关暂停和唤醒应用的详细信息, 如何设置后台连接选项。

有关 WebSocket 保持活动控制帧的详细信息,请参阅 WebSocket 协议。

构造函数

名称 说明
WebSocketKeepAlive()

创建新的 WebSocketKeepAlive 对象。

方法

名称 说明
Run(IBackgroundTaskInstance)

在连接的 WebSocket 上发送 WebSocket 协议保持活动状态。

适用于