MultiplayerSession.SetManagedInitialization Method

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.

Configures managed initialization parameters for a session.

[Windows.Foundation.Metadata.Deprecated("Call SetMemberInitialization instead", Windows.Foundation.Metadata.DeprecationType.Deprecate, 0)]
public void SetManagedInitialization (Windows.Foundation.TimeSpan joinTimeout, Windows.Foundation.TimeSpan measurementTimeout, Windows.Foundation.TimeSpan evaluationTimeout, bool autoEvalute, uint membersNeededToStart);

abstract member SetManagedInitialization : Windows.Foundation.TimeSpan * Windows.Foundation.TimeSpan * Windows.Foundation.TimeSpan * bool * uint32 -> unit
override this.SetManagedInitialization : Windows.Foundation.TimeSpan * Windows.Foundation.TimeSpan * Windows.Foundation.TimeSpan * bool * uint32 -> unit

Public Sub SetManagedInitialization (joinTimeout As TimeSpan, measurementTimeout As TimeSpan, evaluationTimeout As TimeSpan, autoEvalute As Boolean, membersNeededToStart As UInteger)

Parameters

joinTimeout: Windows.Foundation.TimeSpan

The period of time, in milliseconds, that the system waits for a member to join the session. This value overrides the value of the memberReservedTimeout parameter for the MultiplayerSession.SetTimeouts Method for the initial session members.

measurementTimeout: Windows.Foundation.TimeSpan

The period of time, in milliseconds, that the system waits for a measuring operation during managed initialization. Note: During matchmaking, a 45-second timeout for QoS measurements is enforced. Therefore we recommend the use of a measurement timeout that is less than or equal to 30 seconds during matchmaking.

evaluationTimeout: Windows.Foundation.TimeSpan

The period of time, in milliseconds, that the system waits for an evaluation.

autoEvalute: Boolean

True if the system should auto-evaluate the session service, and false if the title performs the evaluation.

membersNeededToStart: UInt32

The number of members needed to start the session, for initialization episode zero only.

Implements

Microsoft.Xbox.Services.Multiplayer.__IMultiplayerSessionPublicNonVirtuals.SetManagedInitialization(Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,Windows.Foundation.TimeSpan,System.Boolean,System.UInt32)

Attributes: Windows.Foundation.Metadata.DeprecatedAttribute

Remarks

This can only be set when creating a new session.

If a 'managedInitialization' object is set, the session expects the client system or title to perform initialization following session creation and/or as new members join the session.

The timeouts and initialization stages are automatically tracked by the session, including QoS measurements if any metrics are set. These timeouts override the session's reservation and ready timeouts for members that have 'initializationEpisode' set.

After calling this method, the caller must use MultiplayerService.WriteSessionAsync to write batched local changes to the service.

Applies to

Share via