MultiplayerManagedInitialization Class

Reference

Definition

Namespace:: Microsoft.Xbox.Services.Multiplayer

Assembly:: Microsoft.Xbox.Services.dll

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.

Represents managed initialization for a session.

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Version(1)]
public sealed class MultiplayerManagedInitialization

type MultiplayerManagedInitialization = class
    interface __IMultiplayerManagedInitializationPublicNonVirtuals

Public NotInheritable Class MultiplayerManagedInitialization

Inheritance: Object
MultiplayerManagedInitialization

Attributes: Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.VersionAttribute

Examples

The following example shows the format of the JSON object that represents this class:

"managedInitialization": {
    "joinTimeout": 4000,
    "measurementTimeout" : 5000,
    "evaluationTimeout" : 5000,
    "autoEvaluate" : true,
    "membersNeededToStart" : 2
},

Remarks

If using managed initialization, the session expects the system or the title to perform initialization following the session creation and/or as new members join the session. The session automatically tracks the timeouts and initialization stages, including QoS measurements if any metrics are set. These timeouts override the session's reservation and ready timeouts for members that have the MultiplayerSessionMember.InitializationEpisode Property set.

In managed initialization, the initialization stage goes from "joining" to "measuring" to "evaluating". If the MultiplayerManagedInitialization.AutoEvaluate Property is set to true, the evaluating stage is skipped. If metrics are not set for the session, the measuring stage is skipped. If the stage is set to "failed", the session cannot be initialized.

Properties

AutoEvaluate	A value that indicates if the system should auto-evaluate during managed initialization. This is an optional evaluate stage for a title. The title can do evaluation when set to false.
EvaluationTimeout	The period of time that the Xbox system waits for evaluation to occur during managed initialization. Returns the timeout for the evaluation stage of the QoS process.
JoinTimeout	The period of time that the system waits for a member to join a session during the joining stage of managed initialization. This stage is the first stage of the QoS process.
ManagedInitializationSet	Indicates if the ManagedInitializion object is set, which means that the session is using managed initialization.
MeasurementTimeout	The period of time that the system waits for a measuring operation to occur during managed initialization. This stage is the measurement stage of the QoS process.
MembersNeededToStart	The number of session members needed to start a session, during managed initialization episode 0 only. Defaults to 2. This number must be between 1 and maxMemberCount.

Applies to

Share via