public class

CommandScheduler

extends Thread
implements ICommandScheduler
java.lang.Object
   ↳ java.lang.Thread
     ↳ com.android.tradefed.command.CommandScheduler

Class Overview

A scheduler for running TradeFederation commands across all available devices.

Will attempt to prioritize commands to run based on a total running count of their execution time. e.g. infrequent or fast running commands will get prioritized over long running commands.

Runs forever in background until shutdown.

Summary

[Expand]
Inherited Constants
From class java.lang.Thread
Public Constructors
CommandScheduler()
Creates a CommandScheduler.
Public Methods
boolean addCommand(String[] args)
Adds a command to the scheduler.
boolean addCommand(String[] args, long totalExecTime)
An alternate addCommand(String[]) that accepts an initial total execution time for the command.
void await()
Waits for scheduler to start running.
void displayCommandQueue(PrintWriter printWriter)
Output detailed debug info on state of command execution queue.
void displayCommandsInfo(PrintWriter printWriter)
Output a list of current commands.
void displayInvocationsInfo(PrintWriter printWriter)
Displays a list of current invocations.
synchronized boolean handoverShutdown(int handoverPort)
Initiates a shutdown() and handover to another tradefed process on this same host.
synchronized void removeAllCommands()
Remove all commands from scheduler
void run()
The main execution block of this thread.
synchronized void shutdown()
Attempt to gracefully shutdown the command scheduler.
synchronized void shutdownHard()
Attempt to forcefully shutdown the command scheduler.
synchronized void shutdownOnEmpty()
Similar to shutdown(), but will instead wait for all commands to be executed before exiting.
int startRemoteManager()
Starts a socket to listen to remote commands.
boolean stopInvocation(ITestInvocation invocation)
Stop a running invocation.
void stopRemoteManager()
Cancels the currently running remote manager.
[Expand]
Inherited Methods
From class java.lang.Thread
From class java.lang.Object
From interface com.android.tradefed.command.ICommandScheduler
From interface java.lang.Runnable

Public Constructors

public CommandScheduler ()

Creates a CommandScheduler.

Note: logging is initialized here. We assume that start() will be called, so that we can clean logs up at the end of the run() method. In particular, this means that a leak will result if a CommandScheduler instance is instantiated but not started.

Public Methods

public boolean addCommand (String[] args)

Adds a command to the scheduler.

A command is essentially an instance of a configuration to run and its associated arguments.

If "--help" argument is specified, or the config arguments are invalid, the help text for the config will be outputed to stdout. Otherwise, the config will be added to the queue to run.

Parameters
args the config arguments.
Returns
  • true if command was added successfully

public boolean addCommand (String[] args, long totalExecTime)

An alternate addCommand(String[]) that accepts an initial total execution time for the command.

Useful when transitioning pre-existing commands from another tradefed process

Parameters
args the config arguments.
totalExecTime the accumulated elapsed execution time of the command
Returns
  • true if command was added successfully

public void await ()

Waits for scheduler to start running.

Throws
InterruptedException

public void displayCommandQueue (PrintWriter printWriter)

Output detailed debug info on state of command execution queue.

public void displayCommandsInfo (PrintWriter printWriter)

Output a list of current commands.

Parameters
printWriter the PrintWriter to output to.

public void displayInvocationsInfo (PrintWriter printWriter)

Displays a list of current invocations.

Parameters
printWriter the PrintWriter to output to.

public synchronized boolean handoverShutdown (int handoverPort)

Initiates a shutdown() and handover to another tradefed process on this same host.

The scheduler will inform the remote tradefed process listening on that port of freed devices as they become available.

Returns
  • true if handover initiation was successful, false otherwise

public synchronized void removeAllCommands ()

Remove all commands from scheduler

public void run ()

The main execution block of this thread.

public synchronized void shutdown ()

Attempt to gracefully shutdown the command scheduler.

Clears commands waiting to be tested, and requests that all invocations in progress shut down gracefully.

After shutdown is called, the scheduler main loop will wait for all invocations in progress to complete before exiting completely.

public synchronized void shutdownHard ()

Attempt to forcefully shutdown the command scheduler.

Similar to shutdown(), but will also forcefully kill the adb connection, in an attempt to 'inspire' invocations in progress to complete quicker.

public synchronized void shutdownOnEmpty ()

Similar to shutdown(), but will instead wait for all commands to be executed before exiting.

Note that if any commands are in loop mode, the scheduler will never exit.

public int startRemoteManager ()

Starts a socket to listen to remote commands.

Used to handle handover communication. @see handoverShutdown(int).

Returns
  • the TCP port of the socket or -1 if it failed to start.

public boolean stopInvocation (ITestInvocation invocation)

Stop a running invocation.

Returns
  • true if the invocation was stopped, false otherwise
Throws
UnsupportedOperationException

public void stopRemoteManager ()

Cancels the currently running remote manager.