XboxLiveEndpointPairTemplate Class

Definition

Namespace:

Windows.Networking.XboxLive

Represents a pre-configured pattern for how to enable optimal and secure communication between two devices using sockets. The template defined by this class details how two endpoints are connected in an XboxLiveEndpointPair. Templates are statically declared in your app's network manifest, and are subsequently identified using unique name strings.

Note

Templates are declared only in the app's network manifest. You can't declare or modify a template at runtime.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

public ref class XboxLiveEndpointPairTemplate sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Networking.XboxLive.XboxLiveSecureSocketsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class XboxLiveEndpointPairTemplate final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Networking.XboxLive.XboxLiveSecureSocketsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class XboxLiveEndpointPairTemplate

Public NotInheritable Class XboxLiveEndpointPairTemplate

Inheritance

Object Platform::Object IInspectable XboxLiveEndpointPairTemplate

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Xbox One System Apps Extensions for the UWP (introduced in 10.0.0.1) Xbox Live Extension SDK (introduced in 10.0.10240.0) Xbox One Extensions for the UWP (introduced in 10.0.10240.0) Windows Desktop Extension SDK (introduced in 10.0.16299.0)
API contract	Windows.Networking.XboxLive.XboxLiveSecureSocketsContract (introduced in v1.0)

Remarks

Your code doesn't instantiate this class using a constructor. Instead, you create an instance of a particular predefined template by calling the static XboxLiveEndpointPairTemplate.GetTemplateByName method with the name of the template you want.

Properties

AcceptorBoundPortRangeLower	Gets the lower limit of the acceptor-bound port range, as defined in the app network manifest. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
AcceptorBoundPortRangeUpper	Gets the upper limit of the acceptor-bound port range, as defined in the app network manifest. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
EndpointPairs	Static property that gets a list of current XboxLiveEndpointPair objects that have been created using this template. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
InitiatorBoundPortRangeLower	Gets the lower limit of the initiator bound port range, as defined in the app network manifest. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
InitiatorBoundPortRangeUpper	Gets the upper limit of the initiator bound port range, as defined in the app network manifest. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
Name	Gets the name of the template (declared in the app network manifest) that was used to instantiate this object. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
SocketKind	Gets a value specifying the kind of socket declared by this template. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
Templates	Static property that lists all of the templates declared by the app. Templates are declared in the app's network manifest at build time, and cannot be declared or modified at runtime. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

Methods

CreateEndpointPairAsync(XboxLiveDeviceAddress, XboxLiveEndpointPairCreationBehaviors)	Creates an XboxLiveEndpointPair between the local device and a specified remote device, while specifying how the system should behave if an XboxLiveEndpointPair already exists for this template and remote device. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
CreateEndpointPairAsync(XboxLiveDeviceAddress)	Creates an XboxLiveEndpointPair between the local device and a specified remote device, based on the current template, with creation behavior XboxLiveEndpointPairCreationBehaviors.None. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress, String, String, XboxLiveEndpointPairCreationBehaviors)	Creates an endpoint pair between the local device and the specified remote device, specifying specific ports from the template's designated ranges of acceptable ports, and specifying how the system should behave if an XboxLiveEndpointPair already exists for this template, remote device, and port combination. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress, String, String)	Creates an endpoint pair between the local device and the specified remote device, specifying specific ports from the template's designated range of acceptable ports, with creation behavior XboxLiveEndpointPairCreationBehaviors.None. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
GetTemplateByName(String)	Static method that creates an XboxLiveEndpointPairTemplate for the named template. Templates are defined in the app network manifest. Each template in the manifest must have been given a unique name. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

Events

InboundEndpointPairCreated

Event raised when a remote device successfully creates an endpoint pair from itself to the local machine. Details about the new endpoint pair can be found in the event arguments. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.