User manual MACROMEDIA FLASH COMMUNICATION SERVER MX-SERVER-SIDE COMMUNICATION ACTIONSCRIPT DICTIONARY

[. . . ] Server-Side Communication ActionScript Dictionary Macromedia Flash Communication Server MX TM TM macromedia ® Trademarks Afterburner, AppletAce, Attain, Attain Enterprise Learning System, Attain Essentials, Attain Objects for Dreamweaver, Authorware, Authorware Attain, Authorware Interactive Studio, Authorware Star, Authorware Synergy, Backstage, Backstage Designer, Backstage Desktop Studio, Backstage Enterprise Studio, Backstage Internet Studio, Design in Motion, Director, Director Multimedia Studio, Doc Around the Clock, Dreamweaver, Dreamweaver Attain, Drumbeat, Drumbeat 2000, Extreme 3D, Fireworks, Flash, Fontographer, FreeHand, FreeHand Graphics Studio, Generator, Generator Developer's Studio, Generator Dynamic Graphics Server, Knowledge Objects, Knowledge Stream, Knowledge Track, Lingo, Live Effects, Macromedia, Macromedia M Logo & Design, Macromedia Flash, Macromedia Xres, Macromind, Macromind Action, MAGIC, Mediamaker, Object Authoring, Power Applets, Priority Access, Roundtrip HTML, Scriptlets, SoundEdit, ShockRave, Shockmachine, Shockwave, Shockwave Remote, Shockwave Internet Studio, Showcase, Tools to Power Your Ideas, Universal Media, Virtuoso, Web Design 101, Whirlwind and Xtra are trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words or phrases mentioned within this publication may be trademarks, servicemarks, or tradenames of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. [. . . ] The NetConnection. call method on the server works the same way as the NetConnection. call method on the client: it invokes a command on a remote server. Note: If you want to call a method on a client from a server, use the Client. call method. Example This example uses RTMP to execute a call from one Flash Communication Server to another Flash Communication Server. The code makes a connection to the App1 application on server 2 and then invokes the method Sum on server 2: nc1. connect("rtmp://server2. mydomain. com/App1", "svr2", ); nc1. call("Sum", newResult(), 3, 6); The following server-side ActionScript code is on server 2. When the client is connecting, this code checks to see whether it has an argument that is equal to svr1. If the client has that argument, the Sum method is defined so that when the method is called from svr1, svr2 can respond with the appropriate method: application. onConnect = function(clientObj){ if(arg1 == "svr1"){ clientObj. Sum = function(p1, p2){ return p1 + p2; } } return true; }; The following example uses an AMF request to make a call to an application server. This allows Flash Communication Server to connect to an application server and then invoke the quote method. The Java adaptor dispatches the call by using the identifier to the left of the dot as the class name and the identifier to the right of the dot as a method of the class. nc = new NetConnection; nc. connect("http://www. xyz. com/java"); nc. call("myPackage. quote", newResult()); NetConnection. close Availability Flash Communication Server MX. Usage myNetConnection. close() Parameters None. Returns Nothing. Description Method; closes the connection with the server. After you close the connection, you can reuse the NetConnection instance and reconnect to an old application or connect to a new one. Note: The NetConnection. close method has no effect on HTTP connections. Server-Side Communication ActionScript 37 Example The following code closes the NetConnection instance myNetConn: myNetConn. close(); NetConnection. connect Availability Flash Communication Server MX. Usage myNetConnection. connect(URI, [p1, . . . , pN]) Parameters URI A URI to connect to. p1, . . . , pN Optional parameters that can be of any ActionScript type, including references to other ActionScript objects. These parameters are sent as connection parameters to the application. onConnect event handler for RTMP connections. For AMF connections to application servers, any RTMP parameters are ignored. Returns For RTMP connections, a Boolean value of true for success; false otherwise. For AMF connections to application servers, true is always returned. Description Method; connects to the host. The host URI has the following format: [protocol://]host[:port]/appName[/instanceName] For example, the following are legal URIs: http://appServer. mydomain. com/webApp rtmp://rtserver. mydomain. com/realtimeApp It is good practice to write an application. onStatus callback function and check the NetConnection. isConnected property for RTMP connections to see whether a successful connection was made. For Action Message Format connections, check NetConnection. onStatus. Example This example creates an RTMP connection to another Flash Communication Server for the myConn instance of NetConnection: myConn = new NetConnection(); myConn. connect("rtmp://tc. foo. com/myApp/myConn"); The following example creates an AMF connection to an application server for the myConn instance of NetConnection: myConn = new NetConnection(); myConn. connect("http://www. xyz. com/myApp/"); NetConnection. isConnected Availability Flash Communication Server MX. 38 Usage myNetConnection. isConnected Description Property (read-only); a Boolean value that indicates whether a connection has been made. It's a good idea to check this property value in the onStatus callback function. This property is always true for AMF connections to application servers. Example This example uses NetConnection. isConnected inside an onStatus definition to check if a connection has been made: nc = new NetConnection(); nc. connect("rtmp://tc. foo. com/myApp"); nc. onStatus = function(infoObj){ if (info. code == "NetConnection. Connect. Success" && nc. isConnected){ trace("We are connected"); } }; NetConnection. onStatus Availability Flash Communication Server MX. Usage myNetConnection. onStatus = function(infoObject) { // Your code here } Parameters infoObject An information object. For details about this parameter, see the Appendix, "Server-Side Information Objects, " on page 67. Returns Nothing. Description Event handler; invoked every time the status of the NetConnection object changes. For example, if the connection with the server is lost in an RTMP connection, the NetConnection. isConnected property is set to false, and NetConnection. onStatus is invoked with a status message of NetConnection. Connect. closed. For AMF connections, NetConnection. onStatus is used only to indicate a failed connection. Use this event handler to check for connectivity. Server-Side Communication ActionScript 39 Example This example defines a function for the onStatus handler that outputs messages to indicate whether the NetConnection was successful: nc = new NetConnection(); nc. onStatus = function(info){ if (info. code == "NetConnection. Connect. Success") { _root. gotoAndStop(2); } else { if (!nc. isConnected){ _root. gotoAndStop(1); } } }; NetConnection. uri Availability Flash Communication Server MX. Usage myNetConnection. uri Description Property (read-only); A string indicating the URI that was passed by the NetConnection. connect method. This property is set to null before a call to NetConnection. connect or after NetConnection. close is called. setInterval Availability Flash Communication Server MX. Usage setInterval(function, interval[, p1, . . . , pN]); setInterval(object, methodName, interval[, p1, . . . , pN]); Parameters function The name of a defined ActionScript function or a reference to an anonymous An object derived from the ActionScript Object object. Optional parameters passed to function. function. object methodName interval p1, . . . , pN Returns A unique ID for this call. If the interval is not set, the method returns -1. 40 Description Method (global); continually calls a function or method at a specified time interval until the clearInterval method is called. [. . . ] You can use the trace method to debug a script. Server-Side Communication ActionScript 65 66 APPENDIX Server-Side Information Objects The Application, NetConnection, and Stream objects provide an onStatus event handler that uses an information object for providing information, status, or error messages. To respond to this event handler, you must create a function to process the information object, and you must know the format and contents of the information object returned. You can define the following global function at the top of your main. asc file to display all the status messages for the parameters that you pass to the function. You need to place this code in the main. asc file only once. function showStatusForClass(){ for (var i=0;i<arguments. length;i++){ arguments[i]. prototype. onStatus = function(infoObj){ trace(infoObj. code + " (level:" + infoObj. level + ")"); } } showStatusForClass(Application, NetConnection, Stream) For more information about information objects, see the appendix of the Client-Side Communication ActionScript Dictionary. [. . . ]