Share via

SocketActivityTriggerDetails Class

  • Reference

Definition

Namespace:
Windows.Networking.Sockets
Edit

A object instantiated by the background broker infrastructure and used by an app to retrieve details when a SocketActivityTrigger occurs.

public ref class SocketActivityTriggerDetails sealed
/// [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 SocketActivityTriggerDetails final
[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 SocketActivityTriggerDetails
Public NotInheritable Class SocketActivityTriggerDetails
Inheritance
Object Platform::Object IInspectable SocketActivityTriggerDetails
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

The SocketActivityTriggerDetails object is used by an app to retrieve the SocketActivityInformation object for the socket that caused a SocketActivityTrigger to occur, and to get the reason that the trigger occurred.

A SocketActivityTriggerDetails instance is created when the background task for a socket signals a SocketActivityTrigger. (See the SocketActivityTrigger class page for details on how to create a background task and transfer ownership of a socket to a socket broker for background listening.)

Properties

Reason

Get the reason the SocketActivityTrigger occurred.
SocketInformation

Get the SocketActivityInformation object for socket that caused the SocketActivityTrigger to occur.

Applies to

See also