Application class

Availability

Flash Communication Server 1.

The Application class contains information about a Flash Media Server application instance that lasts until the application instance is unloaded. A Flash Media Server application is a collection of stream objects, shared objects, and clients (connected users). Each application has a unique name, and you can use a naming scheme to create multiple instances of an application. For more information about the naming scheme, see Using naming conventions.

Every instance of a Flash Media Server application has an application object, which is a single instance of the Application class. You don't need to use a constructor function to create the application object; it is created automatically when an application is instantiated by the server. Use the following syntax to call the methods, properties, and event handlers of the Application class:

application.methodPropertyOrHandler

Use the application object to accept and reject client connection attempts, register and unregister classes and proxies, and create functions that are invoked when an application starts or stops or when a client connects or disconnects.

For more information about the life cycle of an application, see "Application flow" in Developing Media Applications.

Besides the built-in properties of the Application class, you can create other properties of any legal ActionScript type, including references to other ActionScript objects. For example, the following code creates a new property of type Array and a new property of type Number:

application.myarray = new Array();
application.num_requests = 1;

Method summary for the Application class

Method	Description
Application.acceptConnection()	Accepts a connection to an application from a client.
Application.broadcastMsg()	Broadcasts a message to all connected clients.
Application.clearSharedObjects()	Clears all shared objects associated with the current instance.
Application.clearStreams()	Clears all stream objects associated with the current instance.
Application.disconnect()	Disconnects a client from the server.
Application.gc()	Invokes the garbage collector to reclaim any unused resources for this application instance.
Application.getStats()	Returns network statistics for the application instance.
Application.registerClass()	Registers or unregisters a constructor that is called during object deserialization.
Application.registerProxy()	Registers a NetConnection or Client object to fulfill a method request.
Application.rejectConnection()	Rejects a connection to an application.
Application.shutdown()	Unloads the application instance.

Property summary for the Application class

Property	Description
Application.allowDebug	A Boolean value that lets administrators use the `approveDebugSession()` Server Management ActionScript method to access your Flash Media Server application (`true`) or not (`false`).
Application.clients	Read-only; an object containing a list of all clients currently connected to the application.
Application.config	Lets you access properties of the `ApplicationObject` tag in the Application.xml configuration file.
Application.hostname	Read-only; the host name of the server for default virtual hosts, and virtual host name for non-default virtual hosts.
Application.name	Read-only; the name of an application instance.
Application.server	Read-only; the platform and version of the server.

Event handler summary for the Application class

Event handler	Description
Application.onAppStart	Invoked when the application is loaded by the server.
Application.onAppStop	Invoked when the application is unloaded by the server.
Application.onConnect	Invoked when a client connects to the application.
Application.onConnectAccept	Invoked when a client successfully connects to the application; for use with media components only.
Application.onConnectReject	Invoked when a client fails to connect to the application; for use with communication components only.
Application.onDisconnect	Invoked when a client disconnects from the application.
Application.onStatus	Invoked when a script generates an error.

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/fms/2/docs/00000640.html