nn::nex::Session::DestroySession Member Function

Syntax

void DestroySession();

Parameters

None.

Return Values

None.

Description

Leaves the session forcibly without performing fault processing, when disconnected from the network.

This function can only be used under the following conditions.

• When stations other than the local host remain in the session, but are clearly disconnected from the network.
• When the only station is the local host.

Fault processing is not run when this function is used. Because fault processing is omitted, information that should be common among stations can become inconsistent, and this can make continuation of the peer-to-peer session difficult.

To forcibly end entire peer-to-peer sessions that include parent and child nodes, use the GameOver function.

The benefit of using this function when fault processing is not required is that JobTerminateDOCore ends quickly, with no time spent for JobTerminateDOCoreSyncTermination.

Host migration is no longer possible after this function is used.

The NetZ::SetTerminateImmediately function is automatically set to TRUE.

See Also

GameOver
NetZ::SetTerminateImmediately

Revision History

2012/08/02
Added a note about the value automatically set to the NetZ::SetTerminateImmediately function.
2012/04/19
Changed name from Session::LeaveSession to Session::DestroySession.
2012/01/26
Initial version.

CONFIDENTIAL