User Guide

XMLSocket.onConnect 1065
XMLSocket.onConnect
Availability
Flash Player 5.
Usage
myXMLSocket.onConnect = function(success:Boolean) {
// your statements here
}
Parameters
success
A Boolean value indicating whether a socket connection is successfully established
(
true or false).
Returns
Nothing.
Description
Event handler; invoked by Flash Player when a connection request initiated through
XMLSocket.connect() has succeeded or failed. If the connection succeeded, the
success
parameter is
true; otherwise the success parameter is false.
The default implementation of this method performs no actions. To override the default
implementation, you must assign a function containing custom actions.
Example
The following example illustrates the process of specifying a replacement function for the
onConnect method in a simple chat application.
After creating the XMLSocket object using the constructor method, the script defines the custom
function to be executed when the onConnect event handler is invoked. The function controls the
screen to which users are taken, depending on whether a connection is successfully established. If
the connection is successfully made, users are taken to the main chat screen on the frame labeled
startChat. If the connection is not successful, users go to a screen with troubleshooting
information on the frame labeled
connectionFailed.
var socket:XMLSocket = new XMLSocket();
socket.onConnect = function (success) {
if (success) {
gotoAndPlay("startChat");
} else {
gotoAndStop("connectionFailed");
}
}
Finally, the connection is initiated. If connect() returns false, the SWF file is sent directly to
the frame labeled
connectionFailed, and onConnect is never invoked. If connect() returns
true, the SWF file jumps to a frame labeled waitForConnection, which is the “Please wait”
screen. The SWF file remains on the
waitForConnection frame until the onConnect handler is
invoked, which happens at some point in the future depending on network latency.