qBool TestConnectivity( ProtocolCallContext * pContext );
Name | Description | |
---|---|---|
in | pContext |
The call context. |
Value | Description |
---|---|
true |
Call to asynchronous process was successful. |
false |
Call to asynchronous process failed. (Passed an invalid CallContext . Not logged in.) |
Runs a test of Internet connectivity.
Runs an Internet connectivity test by communicating with the game server. If you can communicate with a normally-operating game server, this function's asynchronous process always returns success. There is no need to wait for this function's asynchronous process to complete. It causes no problem to treat the connectivity test as failed if it does not complete within the time specified by the application (roughly 2 or 3 seconds).
Making periodic calls to this function is prohibited. Use this function to determine whether the disconnection was caused by the remote client or the local client during peer-to-peer communications. To check whether communications with the server are maintained, use the NgsFacade::IsConnected
function. To check whether communications with the access point are maintained, use the ac::
function (or disconnection event handling).
This function can only be used when logged in to the game server.
CONFIDENTIAL