nn::nex::Session::GameOver Member Function

Syntax

qBool GameOver();

Parameters

None.

Return Values



Value Description
true This is returned once the end of the session has been reported to all participants.
false This is returned when a reference to the session is invalid. It is also returned if the function was called by a station that is not the session master.

Description

Notifies all session participants that the session is over.

This function can only be called by the session master. The session participants quit the game in response to the call from a system that thinks it is the master.

If the session master determines that the session should be shut down, call this RMC and turn on the game over flag for all session participants before shutting down the Net-Z instance. For child stations, check whether GameOver() was called by running CheckGameIsOver(), and then run the termination processes to end the NetZ session. If you use the GameOver function, migration does not occur.

When a large number of connected systems are all disconnected at the same time, the migration process takes longer and the process for ending NetZ objects is more likely to time out. To avoid these kinds of timeouts, immediately before you execute the process to end NetZ objects, be sure to call the Session::GameOver function to notify all stations that the session has ended.

The NetZ::SetTerminateImmediately function is automatically set to true for both the session master and session participants.

See Also

NetZ::SetTerminateImmediately()
CheckGameIsOver()

Revision History

2012/08/07
Added a note about the value automatically set to the NetZ::SetTerminateImmediately function. Added how this function relates to the CheckGameIsOver function.
2011/01/27
Initial version.

CONFIDENTIAL