ICommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler

Trình lập lịch biểu để chạy các lệnh TradeFederation.

Tóm tắt

Lớp lồng ghép

interface ICommandScheduler.IScheduledInvocationListener

Trình nghe cho các sự kiện gọi khi lệnh gọi hoàn tất. 

Phương thức công khai

abstract Pair<Boolean, Integer> addCommand(String[] args)

Thêm một lệnh vào trình lập lịch biểu.

abstract void addCommandFile(String cmdFile, extraArgs)

Thêm tất cả các lệnh từ tệp đã cho vào trình lập lịch biểu

abstract void await()

Chờ trình lập lịch biểu bắt đầu chạy, bao gồm cả việc chờ quá trình chuyển giao từ TF cũ hoàn tất nếu có.

abstract void displayCommandQueue(PrintWriter printWriter)

Xuất thông tin gỡ lỗi chi tiết về trạng thái của hàng đợi thực thi lệnh.

abstract void displayCommandsInfo(PrintWriter printWriter, String regex)

Xuất danh sách các lệnh hiện tại.

abstract void displayInvocationsInfo(PrintWriter printWriter)

Hiển thị danh sách các lệnh gọi hiện tại.

abstract void dumpCommandsXml(PrintWriter printWriter, String regex)

Kết xuất tệp xml mở rộng cho lệnh bằng tất cả giá trị Option được chỉ định cho mọi lệnh hiện tại.

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

Trực tiếp phân bổ một thiết bị và thực thi một lệnh mà không cần thêm thiết bị đó vào hàng đợi lệnh bằng cách sử dụng một IInvocationContext hiện có.

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

Trực tiếp phân bổ một thiết bị và thực thi một lệnh mà không cần thêm thiết bị đó vào hàng đợi lệnh.

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

Trực tiếp thực thi lệnh trên thiết bị đã được phân bổ.

abstract long execCommand(ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args)

Trực tiếp thực thi lệnh trên các thiết bị đã được phân bổ.

abstract CommandFileWatcher getCommandFileWatcher()

Tải CommandFileWatcher thích hợp cho trình lập lịch biểu này

abstract int getExecutingCommandCount()

Trả về số lượng Lệnh ở trạng thái thực thi.

abstract String getInvocationInfo(int invocationId)

Trả về thông tin về một lệnh gọi bằng cách chỉ định mã lệnh gọi.

abstract CommandRunner.ExitCode getLastInvocationExitCode()

Trả về mã lỗi của lệnh gọi gần đây nhất đã chạy.

abstract Throwable getLastInvocationThrowable()

Trả về Throwable từ lệnh gọi gần đây nhất đã chạy.

abstract int getReadyCommandCount()

Trả về số lượng Lệnh ở trạng thái sẵn sàng trong hàng đợi.

abstract boolean isDeviceInInvocationThread(ITestDevice device)

Trả về true nếu thiết bị được một luồng gọi đang hoạt động sử dụng.

abstract void join()

Chờ trình lập lịch biểu hoàn tất.

abstract void join(long millis)

Chờ trình lập lịch biểu hoàn tất hoặc hết thời gian chờ sau khoảng thời gian được chỉ định bằng mili giây.

abstract void removeAllCommands()

Xoá tất cả các lệnh khỏi trình lập lịch biểu

abstract void setClearcutClient(ClearcutClient client)

Đặt ứng dụng báo cáo dữ liệu harness

abstract boolean shouldShutdownOnCmdfileError()

Trả về true nếu chúng ta cần tắt trình lập lịch biểu khi gặp lỗi lệnh

default void shutdown()

Cố gắng tắt trình lập lịch biểu lệnh một cách linh hoạt.

abstract void shutdown(boolean notifyStop)

Cố gắng tắt trình lập lịch biểu lệnh một cách êm ái.

abstract void shutdownHard(boolean killAdb)

Cố gắng tắt trình lập lịch biểu lệnh.

abstract void shutdownHard()

Cố gắng tắt trình lập lịch biểu lệnh.

abstract void shutdownOnEmpty()

Tương tự như shutdown(), nhưng sẽ chờ tất cả các lệnh được thực thi trước khi thoát.

abstract void start()

Khởi động ICommandScheduler.

abstract boolean stopInvocation(int invocationId, String cause)

Dừng một lệnh gọi đang chạy bằng cách chỉ định mã nhận dạng của lệnh gọi đó.

default boolean stopInvocation(int invocationId)

Dừng một lệnh gọi đang chạy bằng cách chỉ định mã nhận dạng của lệnh gọi đó.

abstract boolean stopInvocation(ITestInvocation invocation)

Dừng một lệnh gọi đang chạy.

default void stopScheduling()

Ngừng lên lịch và chấp nhận các thử nghiệm mới nhưng không dừng Tradefed.

Phương thức công khai

addCommand

public abstract Pair<Boolean, Integer> addCommand (String[] args)

Thêm một lệnh vào trình lập lịch biểu.

Về cơ bản, lệnh là một thực thể của cấu hình để chạy và các đối số liên quan.

Nếu bạn chỉ định đối số "--help", văn bản trợ giúp cho cấu hình sẽ được xuất ra stdout. Nếu không, cấu hình sẽ được thêm vào hàng đợi để chạy.

Tham số
args String: đối số cấu hình.
Giá trị trả về
Pair<Boolean, Integer> Một cặp giá trị, giá trị đầu tiên là true Boolean nếu lệnh được thêm thành công. Giá trị thứ hai là mã nhận dạng trình theo dõi lệnh đã biết(giá trị không âm) nếu lệnh được thêm thành công, trả về 0 khi lệnh được thêm cho tất cả thiết bị, nếu không thì trả về -1.
Gửi
ConfigurationException không thể phân tích cú pháp lệnh if

addCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

Thêm tất cả lệnh từ tệp đã cho vào trình lập lịch biểu

Tham số
cmdFile String: đường dẫn hệ thống tệp của tệp comand
extraArgs : ERROR(/List) của các đối số String để thêm vào mỗi lệnh được phân tích cú pháp từ tệp. Có thể để trống nhưng không được để giá trị rỗng.
Gửi
ConfigurationException nếu không thể phân tích cú pháp tệp lệnh

Xem thêm:

await

public abstract void await ()

Chờ trình lập lịch biểu bắt đầu chạy, bao gồm cả chờ quá trình chuyển giao từ TF cũ hoàn tất (nếu có).

displayCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

Xuất thông tin gỡ lỗi chi tiết về trạng thái của hàng đợi thực thi lệnh.

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Xuất danh sách các lệnh hiện tại.

Tham số
printWriter PrintWriter: ERROR(/PrintWriter) để xuất dữ liệu.
regex String: biểu thức chính quy để so khớp các lệnh cần in. Nếu giá trị này là rỗng, thì tất cả lệnh sẽ được in.

displayInvocationsInfo

public abstract void displayInvocationsInfo (PrintWriter printWriter)

Hiển thị danh sách các lệnh gọi hiện tại.

Tham số
printWriter PrintWriter: ERROR(/PrintWriter) để xuất dữ liệu.

dumpCommandsXml

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

Kết xuất tệp xml mở rộng cho lệnh với tất cả giá trị Option được chỉ định cho tất cả các lệnh hiện tại.

Tham số
printWriter PrintWriter: ERROR(/PrintWriter) để xuất trạng thái.
regex String: biểu thức chính quy cần được so khớp với các lệnh để tệp xml được kết xuất. Nếu giá trị này là rỗng, thì tất cả lệnh sẽ được kết xuất.

execCommand

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

Phân bổ trực tiếp một thiết bị và thực thi một lệnh mà không cần thêm thiết bị đó vào hàng đợi lệnh bằng một IInvocationContext đã có.

Tham số
context IInvocationContext: một IInvocationContext hiện có.
listener ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener cần được thông báo
args String: đối số lệnh
Giá trị trả về
long

Gửi
ConfigurationException nếu lệnh không hợp lệ
NoDeviceException nếu không có thiết bị nào để sử dụng

execCommand

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

Trực tiếp phân bổ một thiết bị và thực thi một lệnh mà không cần thêm thiết bị đó vào hàng đợi lệnh.

Tham số
listener ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener cần được thông báo
args String: đối số lệnh
Giá trị trả về
long Mã gọi của lệnh được lên lịch.
Gửi
ConfigurationException nếu lệnh không hợp lệ
NoDeviceException nếu không có thiết bị nào để sử dụng

execCommand

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

Thực thi trực tiếp lệnh trên thiết bị đã được phân bổ.

Tham số
listener ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener cần được thông báo
device ITestDevice: ITestDevice cần sử dụng
args String: đối số lệnh
Giá trị trả về
long Mã gọi của lệnh được lên lịch.
Gửi
ConfigurationException nếu lệnh không hợp lệ

execCommand

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

Thực thi trực tiếp lệnh trên các thiết bị đã được phân bổ.

Tham số
listener ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener cần nhận thông báo
devices : ERROR(/List) cần sử dụng
args String: đối số lệnh
Giá trị trả về
long Mã gọi của lệnh được lên lịch.
Gửi
ConfigurationException nếu lệnh không hợp lệ

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

Lấy CommandFileWatcher thích hợp cho trình lập lịch biểu này

Giá trị trả về
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

Trả về số lượng Lệnh ở trạng thái thực thi.

Giá trị trả về
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

Trả về thông tin về một lệnh gọi bằng cách chỉ định mã lệnh gọi.

Tham số
invocationId int: mã theo dõi của lệnh gọi.
Giá trị trả về
String String chứa thông tin về lệnh gọi.

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

Trả về mã lỗi của lệnh gọi gần đây nhất đã chạy. Trả về 0 (không có lỗi) nếu chưa có lệnh gọi nào chạy.

Giá trị trả về
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

Trả về Throwable từ lệnh gọi gần đây nhất đã chạy. Trả về giá trị rỗng nếu không có lớp throwable.

Giá trị trả về
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

Trả về số lượng Lệnh ở trạng thái sẵn sàng trong hàng đợi.

Giá trị trả về
int

isDeviceInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

Trả về true nếu thiết bị được một luồng gọi đang hoạt động sử dụng.

Tham số
device ITestDevice

Giá trị trả về
boolean

tham gia

public abstract void join ()

Chờ trình lập lịch biểu hoàn tất.

Xem thêm:

tham gia

public abstract void join (long millis)

Chờ trình lập lịch biểu hoàn tất hoặc hết thời gian chờ sau khoảng thời gian được chỉ định tính bằng mili giây.

Tham số
millis long

Xem thêm:

removeAllCommands

public abstract void removeAllCommands ()

Xoá tất cả lệnh khỏi trình lập lịch biểu

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

Đặt ứng dụng báo cáo dữ liệu harness

Tham số
client ClearcutClient

shouldShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

Trả về true nếu chúng ta cần tắt trình lập lịch biểu khi gặp lỗi lệnh

Giá trị trả về
boolean

tắt máy

public void shutdown ()

Cố gắng tắt trình lập lịch biểu lệnh một cách linh hoạt.

Xoá các lệnh đang chờ kiểm thử và yêu cầu tất cả các lệnh gọi đang diễn ra tắt một cách êm ái.

Sau khi lệnh tắt được gọi, vòng lặp chính của trình lập lịch biểu sẽ đợi tất cả các lệnh gọi đang diễn ra hoàn tất trước khi thoát hoàn toàn.

tắt

public abstract void shutdown (boolean notifyStop)

Cố gắng tắt trình lập lịch biểu lệnh một cách êm ái.

Tham số
notifyStop boolean: nếu đúng, sẽ thông báo các lệnh gọi tắt TF.

shutdownHard

public abstract void shutdownHard (boolean killAdb)

Cố gắng tắt trình lập lịch biểu lệnh.

Tương tự như shutdown(), nhưng cũng có thể xoá kết nối adb (không bắt buộc) để cố gắng "khuyến khích" các lệnh gọi đang diễn ra hoàn tất nhanh hơn.

Tham số
killAdb boolean

shutdownHard

public abstract void shutdownHard ()

Cố gắng tắt buộc trình lập lịch biểu lệnh. Tương tự như shutdownHard(true).

shutdownOnEmpty

public abstract void shutdownOnEmpty ()

Tương tự như shutdown(), nhưng sẽ chờ tất cả các lệnh được thực thi trước khi thoát.

Xin lưu ý rằng nếu có bất kỳ lệnh nào ở chế độ lặp, trình lập lịch biểu sẽ không bao giờ thoát.

start

public abstract void start ()

Khởi động ICommandScheduler.

Phải được gọi trước khi gọi các phương thức khác.

Sẽ chạy cho đến khi shutdown() được gọi. xem Thread.start().

dừngGọi

public abstract boolean stopInvocation (int invocationId, 
                String cause)

Dừng một lệnh gọi đang chạy bằng cách chỉ định mã nhận dạng của lệnh gọi đó.

Tham số
invocationId int: mã theo dõi của lệnh gọi.
cause String: nguyên nhân khiến lệnh gọi dừng hoạt động.
Giá trị trả về
boolean true nếu lệnh gọi đã bị dừng, false nếu không
Gửi
UnsupportedOperationException nếu quá trình triển khai không hỗ trợ điều này

stopInvocation

public boolean stopInvocation (int invocationId)

Dừng một lệnh gọi đang chạy bằng cách chỉ định mã nhận dạng của lệnh gọi đó.

Tham số
invocationId int

Giá trị trả về
boolean true nếu lệnh gọi đã bị dừng, false nếu không
Gửi
UnsupportedOperationException nếu quá trình triển khai không hỗ trợ điều này

stopInvocation

public abstract boolean stopInvocation (ITestInvocation invocation)

Dừng một lệnh gọi đang chạy.

Tham số
invocation ITestInvocation

Giá trị trả về
boolean true nếu lệnh gọi đã bị dừng, false nếu không
Gửi
UnsupportedOperationException nếu cách triển khai không hỗ trợ việc này

stopScheduling

public void stopScheduling ()

Ngừng lên lịch và chấp nhận các thử nghiệm mới nhưng không làm dừng Tradefeed. Điều này nhằm cho phép tắt hai bước, trong đó trước tiên, chúng ta sẽ loại bỏ tất cả các chương trình kiểm thử đang chạy, sau đó chấm dứt quy trình Tradefed.