ICommandScheduler

addCommand

public abstract 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 the help text for the config will be outputed to stdout. Otherwise, the config will be added to the queue to run.

addCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

Adds all commands from given file to the scheduler

await

public abstract void await ()

Waits for scheduler to start running, including waiting for handover from old TF to complete if applicable.

completeHandover

public abstract void completeHandover ()

Informs the command scheduler that a initiated handover sequence is fully complete, and it should re-initialize its remote manager on the default port.

displayCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

Output detailed debug info on state of command execution queue.

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Output a list of current commands.

displayInvocationsInfo

public abstract void displayInvocationsInfo (PrintWriter printWriter)

Displays a list of current invocations.

dumpCommandsXml

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

Dump the expanded xml file for the command with all Option values specified for all current commands.

execCommand

public abstract void execCommand (IInvocationContext context, 
                ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

Directly allocates a device and executes a command without adding it to the command queue using an already existing IInvocationContext.

execCommand

public abstract void execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

Directly allocates a device and executes a command without adding it to the command queue.

execCommand

public abstract void execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                ITestDevice device, 
                String[] args)

Directly execute command on already allocated device.

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

Get the appropriate CommandFileWatcher for this scheduler

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

Returns the number of Commands in executing state.

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

Return the information on an invocation bu specifying the invocation id.

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

Return the error code of the last invocation that ran. Return 0 (no error), if no invocation has ran yet.

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

Return the Throwable from the last invocation that ran. Return null, if no throwable is available.

getReadyCommandCount

public abstract int getReadyCommandCount ()

Returns the number of Commands in ready state in the queue.

handoverInitiationComplete

public abstract void handoverInitiationComplete ()

Informs the command scheduler that initial handover exchange of devices and commands in use is complete, and it can begin scheduling operation.

handoverShutdown

public abstract 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.

join

public abstract void join ()

Waits for scheduler to complete.

join

public abstract void join (long millis)

Waits for scheduler to complete or timeout after the duration specified in milliseconds.

removeAllCommands

public abstract void removeAllCommands ()

Remove all commands from scheduler

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

Set the client to report harness data

setLastInvocationExitCode

public abstract void setLastInvocationExitCode (CommandRunner.ExitCode code, 
                Throwable stack)

Helper method, when running inside a CommandRunner context, set an exit error code and a stack trace that can be returned.

shouldShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

Return true if we need to shutdown the scheduler on a command errors

shutdown

public abstract 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.

shutdownHard

public abstract 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.

shutdownOnEmpty

public abstract 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.

start

public abstract void start ()

Start the ICommandScheduler.

Must be called before calling other methods.

Will run until shutdown() is called. see Thread.start().

stopInvocation

public abstract boolean stopInvocation (int invocationId, 
                String cause)

Stop a running invocation by specifying it's id.

stopInvocation

public boolean stopInvocation (int invocationId)

Stop a running invocation by specifying it's id.

stopInvocation

public abstract boolean stopInvocation (ITestInvocation invocation)

Stop a running invocation.