WebSocketKeepAlive 类

定义

命名空间:

Windows.Networking.Sockets

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

public ref class WebSocketKeepAlive sealed : 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.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

属性

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

实现

IBackgroundTask

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 keep-alive 控件帧的详细信息，请参阅 WebSocket 协议。

构造函数

WebSocketKeepAlive()

创建新的 WebSocketKeepAlive 对象。

方法

Run(IBackgroundTaskInstance)

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