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

Syntax

static qBool JoinSession(
     const StationURL & refStationURL
);

Parameters

Name Description
in refStationURL Specifies a reference to the StationURL objects of stations in the session to be joined.

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.

This function can be used only with local communications. If used with Internet communications, it stops as a result of an assert or fails.

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

Revision History

2012/10/23
It can no longer be used except with local communications.
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