NetworkSession.BeginCreate Method (NetworkSessionType, Int32, Int32, AsyncCallback, Object)

Starts hosting a new multiplayer session. The creation operation is performed asynchronously.

Namespace: Microsoft.Xna.Framework.Net
Assembly: Microsoft.Xna.Framework.Net (in microsoft.xna.framework.net.dll)

Syntax

public static IAsyncResult BeginCreate (
         NetworkSessionType sessionType,
         int maxLocalGamers,
         int maxGamers,
         AsyncCallback callback,
         Object asyncState
)

Parameters

• sessionType
  Type: NetworkSessionType
  Type of session being created.
• maxLocalGamers
  Type: Int32
  Maximum number of local players on the same gaming machine in this network session.
• maxGamers
  Type: Int32
  Maximum number of players allowed in this network session. For games based on Windows or Xbox 360, this value must be between 2 and 31; 31 is the maximum number of players supported in a session.
• callback
  Type: AsyncCallback
  The method to be called once the asynchronous operation is finished.
• asyncState
  Type: Object
  State of the asynchronous operation.

Return Value

An IAsyncResult used to track the progress of the method.

Exceptions

Exception type	Condition
ArgumentOutOfRangeException	One of the following conditions is true: maxGamers is not in the range of gamers that are supported in a network session. The XNA Framework supports multiplayer sessions between two and 31 players in a session for a Windows or an Xbox 360 game. privateGamerSlots is less than 0 or greater than maximumGamers.
InvalidOperationException	One of the following conditions is true: A different session already exists. There can be only one NetworkSession or AvailableNetworkSessionCollection in use at a time. You must dispose any previous session before you create a new one. One of the following methods has been called, but has not yet returned results: NetworkSession.Create NetworkSession.BeginCreate NetworkSession.Find NetworkSession.BeginFind NetworkSession.Join NetworkSession.BeginJoin Note that you must wait for any of these methods to return before you can create a new network session. To support this, you may use the asynchronous methods BeginCreate, BeginFind, BeginJoin, and the corresponding EndCreate, EndFind, EndJoin methods to detect when the operation is complete.
ObjectDisposedException	This NetworkSession is disposed.

Remarks

Call EndCreate to get results of the call to BeginCreate.

Windows Specific Information
For Windows-based games, maxGamers must be between 2 and 31; 31 is the maximum number of players supported in a session.

Xbox 360 Specific Information
For Xbox 360-based games, maxGamers must be between 2 and 31; 31 is the maximum number of players supported in a session.

See Also

Overview

Working with Asynchronous Methods in XNA Game Studio

Reference

NetworkSession Class
NetworkSession Members
Microsoft.Xna.Framework.Net Namespace

Platforms

Xbox 360, Windows 7, Windows Vista, Windows XP