Share via


Windows.Networking.XboxLive Namespace

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.

Classes

XboxLiveDeviceAddress

Represents the network location of a console or other authenticated device.

Objects of this class represent an opaque collection of connectivity information about a device (in particular, a list of IP addresses). You pass an XboxLiveDeviceAddress to one of the XboxLiveEndpointPairTemplate class's CreateEndpointPairAsync or CreateEndpointPairForPortsAsync methods in order to instantiate an XboxLiveEndpointPair between the local device and the device at the given XboxLiveDeviceAddress.

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.

XboxLiveEndpointPair

An XboxLiveEndpointPair is a security and network quality relationship established between two devices for socket-based communication.

The Windows.Networking.XboxLive API enables peer-to-peer (P2P) connectivity in varied environments, leveraging IPv4, IPv6, and Microsoft's Network Address Translation (NAT) traversal technologies and services (such as Teredo) to determine and configure the best available network path between endpoints. It also establishes encryption of traffic and protection against tampering, as a measure to reduce cheating. Additionally, it authenticates users and applications through the Xbox Live ecosystem&dmash;integrating connectivity information with other Xbox Live services. This information can then be used in matchmaking, to attempt to match players with similar connectivity stats against each other.

The Windows.Networking.XboxLive API complements and extends traditional networking transports such as TCP and UDP, and the available sockets APIs, WinSock and Windows.Networking.Sockets. You create an XboxLiveEndpointPair using this API, and then use your preferred transport API for actual data transmission. The XboxLiveEndpointPair concept itself is related to Windows.Networking.EndpointPair in that it can be interpreted as a set of local and remote IP addresses and ports; but with an XboxLiveEndpointPair, those properties are read-only (because the system negotiates them) and have an associated validity lifetime (because an XboxLiveEndpointPair represents an active security relationship that can be terminated for various reasons).

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.

XboxLiveEndpointPairCreationResult

Encapulates the results of an attempt to instantiate a new XboxLiveEndpointPair. Includes a status value specifying the result of the attempt and (when the creation was successful) details about the resulting endpoint pair.

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.

XboxLiveEndpointPairStateChangedEventArgs

An XboxLiveEndpointPairStateChangedEventArgs object encapsulates details about an XboxLiveEndpointPair.StateChanged event.

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.

XboxLiveEndpointPairTemplate

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.

XboxLiveInboundEndpointPairCreatedEventArgs

Encapsulates details about an InboundEndpointPairCreated event.

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.

XboxLiveQualityOfServiceMeasurement

Describes the operating parameters of a network Quality of Service (QoS) measurement, and provides access to the results of such measurements.

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.

XboxLiveQualityOfServiceMetricResult

An XboxLiveQualityOfServiceMetricResult object encapsulates data from a single measurement of a specific metric, to a 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.

XboxLiveQualityOfServicePrivatePayloadResult

Encapsulates the private payload from a Quality of Service (QoS) measurement when the XboxLiveQualityOfServiceMeasurement.ShouldRequestPrivatePayloads flag has been specified.

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.

Enums

XboxLiveEndpointPairCreationBehaviors

Defines constants that specify creation behavior options for an XboxLiveEndpointPair creation operation.

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.

XboxLiveEndpointPairCreationStatus

Defines constants that specify the status of an XboxLiveEndpointPair creation operation.

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.

XboxLiveEndpointPairState

Defines constants that specify the status of an XboxLiveEndpointPair instance.

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.

XboxLiveNetworkAccessKind

Defines constants that specify the different levels of peer-to-peer network access observed for XboxLiveEndpointPair communication. XboxLiveNetworkAccessKind is used to describe peer-to-peer connections established through the Xbox Live Multiplayer Networking API, and is not applicable to connections to Xbox Live web services or to peer-to-peer connections established outside of the Xbox Live Multiplayer Networking API.

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.

XboxLiveQualityOfServiceMeasurementStatus

Defines constants that specify the status of a Quality of Service (QoS) measurement.

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.

XboxLiveQualityOfServiceMetric

Defines constants that specify the different Quality of Service (QoS) metrics that can be measured in this API.

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.

XboxLiveSocketKind

Defines constants that specify the kinds of sockets recognized by this API.