LocalConnection.onStatus

Client-Side Communication ActionScript > LocalConnection.onStatus

Availability

Flash Player 6.

Flash Communication Server MX (not required).

Usage

sendingLC.onStatus = function(infoObject) {
	// Your code here
}

Parameters

infoObject A parameter defined according to the status message. For more information about this parameter, see the description below.

Returns

Nothing.

Description

Event handler; invoked after a sending LocalConnection object tries to send a command to a receiving LocalConnection object. If you want to respond to this event handler, you must create a function to process the information object sent by the LocalConnection object. For more information, see Client-Side Information Objects and LocalConnection information objects.

If the information object returned by this handler contains a level value of "status", Flash successfully sent the command to a receiving LocalConnection object. This does not mean that Flash successfully invoked the specified method of the receiving LocalConnection object, only that Flash was able to send the command. For example, the method is not invoked if the receiving LocalConnection object doesn't allow connections from the sending domain, or if the method does not exist. The only way to know for sure if the method was invoked is to have the receiving object send a reply to the sending object.

If the information object returned by this handler contains a level value of "error", Flash was unable to send the command to a receiving LocalConnection object, most likely because there is no receiving LocalConnection object connected whose name corresponds to the name specified in the sendingLC.send command that invoked this handler.

In most cases, you will implement this handler only to respond to error conditions, as shown in the following example.

Example

The following example displays information about a failed connection in a trace window.

sendingLC = new LocalConnection();
sendingLC.onStatus = function(infoObject)
{
	if (infoObject.level == "error")
	{
		trace("Connection failed.");
	}
}
sendingLC.send("receivingLC", "methodName");

See also

LocalConnection.send

	Flash Player 6.
	Flash Communication Server MX (not required).