MACROMEDIA FLASH MX 2004 - ACTIONSCRIPT, Reference Manual

Page: 439 / 816

LocalConnection.connect() 439
LocalConnection.connect()
Availability
Flash Player 6.
Usage
receiving_lc .connect( connectionName )
Parameters
connectionName
A string that corresponds to the connection name specified in the
LocalConnection.send()
command that wants to communicate with
receiving_lc
.
Returns
A Boolean value of
true
if no other process running on the same client machine has already
issued this command using the same value for the
connectionName
parameter,
false
otherwise.
Description
Method; prepares a LocalConnection object to receive commands from a
LocalConnection.send()
command (called the “sending LocalConnection object”). The object
used with this command is called the “receiving LocalConnection object.” The receiving and
sending objects must be running on the same client machine.
Be sure to define the methods attached to
receiving_lc
before calling this method, as shown in
all the examples in this section.
By default, the Flash Player resolves
connectionName
into a value of
" superdomain :connectionName"
, where
superdomain
is the superdomain of the SWF file
containing the
LocalConnection.connect()
command. For example, if the SWF file
containing the receiving LocalConnection object is located at www.someDomain.com,
connectionName
resolves to
"someDomain.com:connectionName"
. (If a SWF file is located on
the client machine, the value assigned to
superdomain
is
"localhost"
.)
Also by default, the Flash Player lets the receiving LocalConnection object accept commands only
from sending LocalConnection objects whose connection name also resolves into a value of
" superdomain :connectionName"
. In this way, Flash makes it very simple for SWF files located
in the same domain to communicate with each other.
If you are implementing communication only between SWF files in the same domain, specify a
string for
connectionName
that does not begin with an underscore (_) and that does not specify a
domain name (for example,
"myDomain:connectionName"
). Use the same string in the
LocalConnection.connect( connectionName )
command.
If you are implementing communication between SWF files located in different domains,
see the discussion of
connectionName
in
LocalConnection.send()
, and also the
LocalConnection.allowDomain
and
LocalConnection.domain()
entries.