nn::nex::Station::KickStation Member Function

Syntax

qBool KickStation();

Parameters

None.

Return Values



Value Description
true Returned when sending the signal to leave the session has succeeded.
false Is returned when sending of the signal to leave fails, such as when there is no partner to kick or when a local station is specified.

Description

Makes the specified station leave the session. The specified station is disconnected by being handled as a fault from the surrounding stations, and the Session::CheckGameIsOver function becomes true.

This method is normally executed on the session master (with the Session::GetRole function, the station for which SESSION_ROLE_MASTER is returned). Also, local stations cannot be specified. Use the KickMe function to have a local station leave.

When the loss rate is high, the signal indicating a specified station is leaving may not arrive properly. In that case, the specified station is cut off and isolated from the surrounding stations.

See Also

Session::CheckGameIsOver, KickMe

Revision History

2012/10/30
Formally supported. Can now check with the Session::CheckGameIsOver function.
2012/01/26
Initial version.

CONFIDENTIAL