X-Z > XMLSocket.onXML

XMLSocket.onXML

Syntax

myXMLSocket.onXML(object);

Argument

object An instance of the XML object containing a parsed XML document received from a server.

Description

Method; a callback function invoked by the Flash Player when the specified XML object containing an XML document arrives over an open XMLSocket connection. An XMLSocket connection may be used to transfer an unlimited number of XML documents between the client and the server. Each document is terminated with a zero byte. When the Flash Player receives the zero byte, it parses all of the XML received since the previous zero byte, or since the connection was established if this is the first message received. Each batch of parsed XML is treated as a single XML document and passed to the onXML method.

The default implementation of this method performs no actions. To override the default implementation, you must assign a function containing actions that you define.

Player

Flash 5 or later.

Example

The following function overrides the default implementation of the onXML method in a simple chat application. The function myOnXML instructs the chat application to recognize a single XML element, MESSAGE, in the following format:

<MESSAGE USER="John" TEXT="Hello, my name is John!" />. 

The onXML handler must first be installed in the XMLSocket object as follows:

socket.onXML = myOnXML;

The function displayMessage is assumed to be a user-defined function that displays the message received to the user.

function myOnXML(doc) {
	var e = doc.firstChild;
	if (e != null && e.nodeName == "MESSAGE") {
		displayMessage(e.attributes.user, e.attributes.text);
	}
}

See also

function