flash.tools.debugger

Interface SessionManager2

All Superinterfaces:

SessionManager

All Known Implementing Classes:

PlayerSessionManager, ThreadSafeSessionManager

public interface SessionManager2
extends SessionManager

Field Summary

Fields inherited from interface flash.tools.debugger.SessionManager

PLAYER_SUPPORTS_GET, PREF_ACCEPT_TIMEOUT, PREF_CONNECT_RETRY_ATTEMPTS, PREF_CONNECT_TIMEOUT, PREF_CONNECT_WAIT_INTERVAL, PREF_CONTEXT_RESPONSE_TIMEOUT, PREF_GETVAR_RESPONSE_TIMEOUT, PREF_HIERARCHICAL_VARIABLES, PREF_INVOKE_GETTERS, PREF_RESPONSE_TIMEOUT, PREF_SETVAR_RESPONSE_TIMEOUT, PREF_SOCKET_TIMEOUT, PREF_SUSPEND_WAIT, PREF_SWFSWD_LOAD_TIMEOUT, PREF_URI_MODIFICATION

Method Summary

Methods

Modifier and Type	Method and Description
Session	launch(String uri, AIRLaunchInfo airLaunchInfo, boolean forDebugging, IProgress waitReporter, ILaunchNotification launchNotification, ILauncher launcher) Launches the given string as a URI using the ILauncher Instance.
Process	launchForRun(String uri, AIRLaunchInfo airLaunchInfo, IProgress waitReporter, ILaunchNotification launchNotification) This is, functionally, a clone of the SessionManager.launch() method.
Process	launchForRun(String uri, AIRLaunchInfo airLaunchInfo, IProgress waitReporter, ILaunchNotification launchNotification, ILauncher launcher) This is, functionally, a clone of the SessionManager.launch() method.

Methods inherited from interface flash.tools.debugger.SessionManager

accept, connect, getPreference, isConnecting, isListening, launch, playerForUri, setDebuggerCallbacks, setPreference, setPreference, startListening, stopConnecting, stopListening, supportsLaunch

Method Detail

launchForRun

Process launchForRun(String uri,
                   AIRLaunchInfo airLaunchInfo,
                   IProgress waitReporter,
                   ILaunchNotification launchNotification)
                     throws IOException

This is, functionally, a clone of the SessionManager.launch() method. There are however some differences. -This is to be called only for run launches. only for debug launches, the launch() method creates a Session and binds it to the launch and since the launch() method returns the Session, which will be null in a Run Launch case, we have no way of accessing the Process that was created for the launch. -To enable auto termination of run launches, we need to know the system Process for us to terminate it when necessary. -This method creates the process and binds a process listener to it and then returns the process.

Parameters:

uri - which will launch a Flash player under running OS. For Flash/Flex apps, this can point to either a SWF or an HTML file. For AIR apps, this must point to the application.xml file for the application.

airLaunchInfo - If trying to launch an AIR application, this argument must be specified; it gives more information about how to do the launch. If trying to launch a regular web-based Flash or Flex application, such as one that will be in a browser or in the standalone Flash Player, this argument should be null.

waitReporter - a progress monitor to allow accept() to notify its parent how long it has been waiting for the Flash player to connect to it. May be null if the caller doesn't need to know how long it's been waiting.

launchNotification - a notifier to notify the caller about ADL Exit Code. Main usage is for ADL Exit Code 1 (Successful invocation of an already running AIR application. ADL exits immediately). May be null if no need to listen ADL. The callback will be called on a different thread.

Returns:

a Process to use for the run launch. The return value is not used to indicate an error -- exceptions are used for that. If this function returns without throwing an exception, then the return value will always be non-null.

Throws:

IOException - see Runtime.exec()

launchForRun

Process launchForRun(String uri,
                   AIRLaunchInfo airLaunchInfo,
                   IProgress waitReporter,
                   ILaunchNotification launchNotification,
                   ILauncher launcher)
                     throws IOException

This is, functionally, a clone of the SessionManager.launch() method. There are however some differences. -This is to be called only for run launches. only for debug launches, the launch() method creates a Session and binds it to the launch and since the launch() method returns the Session, which will be null in a Run Launch case, we have no way of accessing the Process that was created for the launch. -To enable auto termination of run launches, we need to know the system Process for us to terminate it when necessary. -This method creates the process and binds a process listener to it and then returns the process. - This method used the ILauncher instance passed to launch the application.

Parameters:

uri - which will launch a Flash player under running OS. For Flash/Flex apps, this can point to either a SWF or an HTML file. For AIR apps, this must point to the application.xml file for the application.

airLaunchInfo - If trying to launch an AIR application, this argument must be specified; it gives more information about how to do the launch. If trying to launch a regular web-based Flash or Flex application, such as one that will be in a browser or in the standalone Flash Player, this argument should be null.

waitReporter - a progress monitor to allow accept() to notify its parent how long it has been waiting for the Flash player to connect to it. May be null if the caller doesn't need to know how long it's been waiting.

launchNotification - a notifier to notify the caller about ADL Exit Code. Main usage is for ADL Exit Code 1 (Successful invocation of an already running AIR application. ADL exits immediately). May be null if no need to listen ADL. The callback will be called on a different thread.

launcher - a launcher instance which will be used to launch.

Returns:

a Process to use for the run launch. The return value is not used to indicate an error -- exceptions are used for that. If this function returns without throwing an exception, then the return value will always be non-null.

Throws:

IOException

launch

Session launch(String uri,
             AIRLaunchInfo airLaunchInfo,
             boolean forDebugging,
             IProgress waitReporter,
             ILaunchNotification launchNotification,
             ILauncher launcher)
               throws IOException

Launches the given string as a URI using the ILauncher Instance. This API is to provide more flexibility to handle the Player launch in different platforms. This call will block until a session with the newly launched player is created.

It is the caller's responsibility to ensure that no other thread is blocking in accept(), since that thread will gain control of this session.

Before calling launch(), you should first call supportsLaunch(). If supportsLaunch() returns false, then you will have to tell the user to manually launch the Flash player.

Also, before calling launch(), you must call startListening().

Parameters:

uri - which will launch a Flash player under running OS. For Flash/Flex apps, this can point to either a SWF or an HTML file. For AIR apps, this must point to the application.xml file for the application.

airLaunchInfo - If trying to launch an AIR application, this argument must be specified; it gives more information about how to do the launch. If trying to launch a regular web-based Flash or Flex application, such as one that will be in a browser or in the standalone Flash Player, this argument should be null.

forDebugging - if true, then the launch is for the purposes of debugging. If false, then the launch is simply because the user wants to run the movie but not debug it; in that case, the return value of this function will be null.

waitReporter - a progress monitor to allow accept() to notify its parent how long it has been waiting for the Flash player to connect to it. May be null if the caller doesn't need to know how long it's been waiting.

launchNotification - a notifier to notify the caller about ADL Exit Code. Main usage is for ADL Exit Code 1 (Successful invocation of an already running AIR application. ADL exits immediately). May be null if no need to listen ADL. Will only be called if forDebugging is false. (If forDebugging is true, error conditions are handled by throwing an exception.) The callback will be called on a different thread.

Returns:

a Session to use for debugging, or null if forDebugging==false. The return value is not used to indicate an error -- exceptions are used for that. If this function returns without throwing an exception, then the return value will always be non-null if forDebugging==true, or null if forDebugging==false.

Throws:

BindException - if isListening() == false

FileNotFoundException - if file cannot be located

CommandLineException - if the program that was launched exited unexpectedly. This will be returned, for example, when launching an AIR application, if adl exits with an error code. CommandLineException includes functions to return any error text that may have been sent to stdout/stderr, and the exit code of the program.

IOException - Exception during launch.