WebSocketKeepAlive クラス

リファレンス

定義

名前空間:: Windows.Networking.Sockets

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

接続された 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

属性: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

実装: IBackgroundTask

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

注釈

WebSocketKeepAlive クラスは、StreamWebSocket クラスと MessageWebSocket クラスのリアルタイムネットワーク状態とトリガーを有効にするために、ControlChannelTrigger クラスおよび関連インターフェイスと組み合わせて使用されます。制御チャネルトリガーは、ネットワークとシステムリソースの使用量を最小限に抑えるために、実行時間の長いネットワークアプリによって使用されます。ネットワークトリガーを使用すると、確立されたネットワーク接続はそのままでも低電力状態を維持しながら、アプリを一定期間低電力モードにドロップできます。アプリは、アプリが起動して WebSocket キープアライブパケットを送信する必要があるときに、システムによって使用されるキープアライブトリガーを設定できます。

UWP アプリは通常、フォアグラウンドでなくなったときに中断されます。アプリを中断してはならない例外がいくつかあります (アクティブな印刷、オーディオストリームへのアクセス、バックグラウンドでのファイルの転送など)。 ControlChannelTrigger クラスを使用すると、WebSocket 接続を確立したネットワークアプリは、ネットワーク接続を動作状態に保ち、アプリのネットワークデータを受信したとき、または WebSocket キープアライブパケットを送信するときに、システムが中断されたアプリをウェイクアップする必要があることをシステムに通知できます。

WebSocketKeepAlive は、ControlChannelTrigger のキープアライブの TaskEntryPoint として使用されます。開発者は、データの受信を処理するコードを記述する必要があります。

アプリの中断とウェイクアップの詳細については、「バックグラウンド接続オプションを設定する方法」を参照してください。

WebSocket キープアライブコントロールフレームの詳細については、 WebSocket プロトコルに関するページを参照してください。

コンストラクター

WebSocketKeepAlive()

新しい WebSocketKeepAlive オブジェクトを作成します。

メソッド

Run(IBackgroundTaskInstance)

接続された WebSocket で WebSocket プロトコルキープアライブを送信します。

適用対象