WebSocketKeepAlive クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 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
- 継承
- 属性
- 実装
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 プロトコルを参照してください。
コンストラクター
| Name | 説明 |
|---|---|
| WebSocketKeepAlive() |
新しい WebSocketKeepAlive オブジェクトを作成 します。 |
メソッド
| Name | 説明 |
|---|---|
| Run(IBackgroundTaskInstance) |
接続された WebSocket で WebSocket プロトコルキープアライブを送信します。 |