nn::nex::Session::JoinSession Member Function

Syntax

static qBool JoinSession(
     const qList< StationURL > & lstURLs
);

Parameters

Name Description
in lstURLs Specifies a reference to the list of stations for the session to be accessed. Pass the URL list obtained with the MatchMakingClient::GetSessionURLs function without modifying it.

Return Values



Value Description
true Returned when the call starts correctly. (Check the state of pCallContext to determine whether it actually succeeded.)
false The Join process failed. The NetZ instance stores the local session object. You must create the NetZ instance again to rejoin the session.
Also, when using NAT traversal with Internet communication, you must perform the NAT transversal again using StopNATSession and StartNATSession.
If a UDS master calls this function, an assertion error is generated or false is returned.

Description

Joins a session.

For Internet communication, there are many cases in which multiple URLs are assigned to a single station. By using this overload, connectable URLs can be automatically selected and connected to.

For Internet communication, before calling this function, you must set a signature key distributed from the game server by using the Network::SetP2PDataPacketSessionSignatureKey function. Pass the URL list obtained with the MatchMakingClient::GetSessionURLs function without modifying it.

If a UDS master calls this function, an assertion error is generated or false is returned.

Revision History

2012/10/23
Added how to handle the URL list.
2012/09/04
Added that if a UDS master calls this functions, an assertion error is generated or false is returned.
2011/09/14
Added a rough guide for CallContext timeouts.
2011/01/27
Initial version.

CONFIDENTIAL