XMLSocket.connect()

Availability

Flash Player 5; behavior changed in Flash Player 7.

Usage

myXMLSocket.connect(host, port)

Parameters

host A fully qualified DNS domain name, or an IP address in the form aaa.bbb.ccc.ddd. You can also specify null to connect to the host server on which the SWF file resides. If the SWF file issuing this call is running in a web browser, url must be in the same domain as the SWF file; for details, see "Description," below.

port The TCP port number on the host used to establish a connection. The port number must be 1024 or higher.

Returns

A Boolean value.

Description

Method; establishes a connection to the specified Internet host using the specified TCP port (must be 1024 or higher), and returns true or false depending on whether a connection is successfully established. If you don't know the port number of your Internet host machine, contact your network administrator.

If you specify null for the host parameter, the host contacted will be the host where the SWF file calling XMLSocket.connect() resides. For example, if the SWF file was downloaded from http://www.yoursite.com,specifying null for the host parameter is the same as entering the IP address for www.yoursite.com.

In SWF files running in a version of the player earlier than Flash Player 7, url must be in the same superdomain as the SWF file that is issuing this call. For example, a SWF file at www.someDomain.com can load variables from a SWF file at store.someDomain.com, because both files are in the same superdomain of someDomain.com.

In SWF files of any version running in Flash Player 7 or later, url must be in exactly the same domain (see Flash Player security features). For example, a SWF file at www.someDomain.com can load variables only from SWF files that are also at www.someDomain.com. If you want to load variables from a different domain, you can place a cross-domain policy file on the server hosting the SWF file that is being accessed (it must be placed on the HTTP server running on port 80 in the same domain as the socket server). For more information, see About allowing cross-domain data loading.

When load() is executed, the XML object property loaded is set to false. When the XML data finishes downloading, the loaded property is set to true, and the onLoad() method is invoked. The XML data is not parsed until it is completely downloaded. If the XML object previously contained any XML trees, they are discarded.

If XMLSocket.connect() returns a value of true, the initial stage of the connection process is successful; later, the XMLSocket.onConnect method is invoked to determine whether the final connection succeeded or failed. If XMLSocket.connect() returns false, a connection could not be established.

Example

The following example uses XMLSocket.connect() to connect to the host where the SWF file resides, and uses trace to display the return value indicating the success or failure of the connection.

function myOnConnect(success) {
  if (success) {
    trace ("Connection succeeded!")
  } else {
    trace ("Connection failed!")
  }
}
socket = new XMLSocket()
socket.onConnect = myOnConnect
if (!socket.connect(null, 2000)) {
  trace ("Connection failed!")
}

See also

function, XMLSocket.onConnect()