ControlChannelTrigger Class

Reference

Definition

Namespace:: Windows.Networking.Sockets

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Enables real time notifications to be received in the background for objects that establish a TCP connection and wish to be notified of incoming traffic.

Call **BackgroundExecutionManager.RequestAccessAsync** before using ControlChannelTrigger.

Note

This class is not supported on Windows Phone.

public ref class ControlChannelTrigger sealed : IClosable

/// [Windows.Foundation.Metadata.Activatable(Windows.Networking.Sockets.IControlChannelTriggerFactory, 65536, Windows.Networking.Sockets.ControlChannelTriggerContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Networking.Sockets.ControlChannelTriggerContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class ControlChannelTrigger final : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Networking.Sockets.ControlChannelTriggerContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.Activatable(Windows.Networking.Sockets.IControlChannelTriggerFactory, 65536, "Windows.Networking.Sockets.ControlChannelTriggerContract")]
class ControlChannelTrigger final : IClosable

[Windows.Foundation.Metadata.Activatable(typeof(Windows.Networking.Sockets.IControlChannelTriggerFactory), 65536, typeof(Windows.Networking.Sockets.ControlChannelTriggerContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Networking.Sockets.ControlChannelTriggerContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
public sealed class ControlChannelTrigger : System.IDisposable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Networking.Sockets.ControlChannelTriggerContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Networking.Sockets.IControlChannelTriggerFactory), 65536, "Windows.Networking.Sockets.ControlChannelTriggerContract")]
public sealed class ControlChannelTrigger : System.IDisposable

Public NotInheritable Class ControlChannelTrigger
Implements IDisposable

Inheritance: Object Platform::Object IInspectable ControlChannelTrigger

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements: IClosable IDisposable

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.10240.0) Windows Mobile Extension SDK (introduced in 10.0.10240.0)
API contract	Windows.Networking.Sockets.ControlChannelTriggerContract (introduced in v1.0)

Remarks

The ControlChannelTrigger class and related interfaces are used to enable your app to use the network when your app is not the foreground app. A Universal Windows app is normally suspended when it is no longer in the foreground app and moved to the background. There are some exceptions to suspending an app (actively printing, accessing an audio stream, and transferring files in the background, for example). The ControlChannelTrigger class allows a network app that has established a TCP connection to notify the system that an established network connection should be kept operational and the system should wake up the suspended app when network data is received for the app or the server keep-alive timer interval expires. Use control channel triggers when your app needs to maintain a network connection even if it is in the background.

While the ControlChannelTrigger class can be used with DatagramSocket, StreamSocket, or StreamSocketListener, Windows 10 provides an improved mechanism for apps that use those classes and want to maintain connections while in the background. See Network communications in the background for details about SocketActivityTrigger and the socket broker.

The ControlChannelTrigger class is recommended to be used by instances of the following that establish a TCP connection:

The HttpClient class in the Windows.Web.Http namespace.
The HttpClient and HttpClientHandler classes in the System.Net.Http namespace in the .NET Framework. Custom classes that derive from these classes are also supported.
The IXMLHTTPRequest2 interface. The IXMLHTTPRequest2 interface is an extension to XMLHttpRequest object defined in several working drafts published by the World Wide Web Consortium (W3C)

There are several types of keep-alive intervals that may relate to network apps. At the lowest level, an app can set a TCP keep-alive option to send TCP keep-alive packets between a client app and a server to maintain an established TCP connection that is not being used. The HttpClient class and the XMLHttpRequest JavaScript object do not have an option to enable TCP keep-alive and this option is disabled by default. The TCP keep-alive must be disabled in order to use the ControlChannelTrigger class to support background network notifications.

In the context of the ControlChannelTrigger class, there are two other keep-alive intervals that have an impact.

Server keep-alive interval - This refers to a keep-alive interval in minutes that the app registers with the system for how often to be woken up when the app has been suspended. The system will wake up the app based on the value set for this keep-alive interval. This value is represented by the ServerKeepAliveIntervalInMinutes property on a ControlChannelTrigger class and is set as an argument to the ControlChannelTrigger constructor. This value is considered a server keep-alive interval since a network app might normally set this based on known behavior of the server to which the app has established a TCP connection. For example, if it is known that a web server will disconnect and drop TCP connections if there is no data sent by the app for 30 minutes, the network app could set this server keep-alive interval to 25 minutes.
Network keep-alive interval - This refers to an internal keep-alive timer maintained by low-level network components in the TCP stack based on current network conditions. This value represents the value needed by network intermediaries to keep the TCP connection intact. These network intermediaries represent hardware and devices such as network proxies and network address translators. A network app cannot set this value, since this value is determined dynamically by low-level system components in the TCP stack. The internal calculation of the network keep-alive interval does take account of the server keep-alive interval. A network app can indicate to the system that the network keep-alive timer should be decreased if established TCP connections are regularly dropped by calling the DecreaseNetworkKeepAliveInterval method on a ControlChannelTrigger class.

Version history

Windows version	SDK version	Value added
1607	14393	IsWakeFromLowPowerSupported

Constructors

ControlChannelTrigger(String, UInt32, ControlChannelTriggerResourceType)	Creates a new ControlChannelTrigger object with a control channel trigger ID, a value for the server keep-alive interval, and the resource type requested for the control channel trigger. Note The ControlChannelTrigger class is not supported on Windows Phone.
ControlChannelTrigger(String, UInt32)	Creates a new ControlChannelTrigger object with a control channel trigger ID and a value for the server keep-alive interval. Note The ControlChannelTrigger class is not supported on Windows Phone.

Properties

ControlChannelTriggerId	Gets a string that can be used to differentiate various control channel triggers on the local computer. Note The ControlChannelTrigger class is not supported on Windows Phone.
CurrentKeepAliveIntervalInMinutes	Gets the network keep-alive interval, in minutes, maintained by low-level network components in the TCP stack based on current network conditions. Note The ControlChannelTrigger class is not supported on Windows Phone.
IsWakeFromLowPowerSupported	Gets a value indicating whether waking from low power states is supported.
KeepAliveTrigger	Gets an object that represents the keep-alive trigger associated with the ControlChannelTrigger object that an app should use to bind the activation class with the background broker infrastructure. Note The ControlChannelTrigger class is not supported on Windows Phone.
PushNotificationTrigger	Gets an object that represents the push notification trigger associated with the ControlChannelTrigger object that an app should use to bind the activation class with the background broker infrastructure. Note The ControlChannelTrigger class is not supported on Windows Phone.
ServerKeepAliveIntervalInMinutes	Get or set the server keep-alive interval, in minutes, registered with the system to indicate when the app and associated network connections used should wake up. Note The ControlChannelTrigger class is not supported on Windows Phone.
TransportObject	Gets the transport object that the system is using for the transport connection associated with the ControlChannelTrigger object. Note The ControlChannelTrigger class is not supported on Windows Phone.

Methods

Close()	Closes the ControlChannelTrigger object. Note This method is not supported on Windows Phone.
DecreaseNetworkKeepAliveInterval()	Provides a way for an app to indicate that the network keep-alive interval maintained by the system with network intermediaries to wake up was too long and should be decreased. This method applies to class elements in the Windows.Networking.Sockets and related namespaces. Note The ControlChannelTrigger class is not supported on Windows Phone.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
FlushTransport()	Flushes any networking data used by the transport connection associated with the ControlChannelTrigger to the networking stack. Note The ControlChannelTrigger class is not supported on Windows Phone.
UsingTransport(Object)	Sets the transport connection to be used by a control channel trigger by class elements in the Windows.Networking.Sockets and related namespaces. Note The ControlChannelTrigger class is not supported on Windows Phone.
WaitForPushEnabled()	Allows an app to notify the system that a connection has been established and the system should complete the internal configuration of the control channel trigger. Note The ControlChannelTrigger class is not supported on Windows Phone.

Applies to

Share via