ICommandScheduler
public interface ICommandScheduler
com.android.tradefed.command.ICommandScheduler |
Một bộ lập lịch để chạy các lệnh TradeFederation.
Bản tóm tắt
các lớp lồng nhau | |
---|---|
interface | ICommandScheduler.IScheduledInvocationListener Trình lắng nghe 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 lịch trình. |
abstract void | addCommandFile (String cmdFile, extraArgs) addCommandFile (String cmdFile, extraArgs) Thêm tất cả các lệnh từ tệp đã cho vào bộ lập lịch |
abstract void | await () Đợi bộ lập lịch bắt đầu chạy, bao gồm 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 yêu cầu hiện tại. |
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ả các giá trị |
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 nó vào hàng đợi lệnh bằng cách sử dụng |
abstract long | execCommand ( ICommandScheduler.IScheduledInvocationListener listener, String[] args) Cấp phát trực tiếp thiết bị và thực thi lệnh mà không cần thêm nó vào hàng đợi lệnh. |
abstract long | execCommand ( ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) execCommand ( ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) Trực tiếp thực hiện lệnh trên các thiết bị đã được phân bổ. |
abstract CommandFileWatcher | getCommandFileWatcher () Nhận |
abstract int | getExecutingCommandCount () Trả về số Lệnh ở trạng thái thực thi. |
abstract String | getInvocationInfo (int invocationId) Trả lại thông tin về một lời gọi bu chỉ định id lời gọi. |
abstract CommandRunner.ExitCode | getLastInvocationExitCode () Trả lại mã lỗi của lệnh gọi cuối cùng đã chạy. |
abstract Throwable | getLastInvocationThrowable () Trả về |
abstract int | getReadyCommandCount () Trả về số 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 sử dụng bởi chuỗi yêu cầu đang hoạt động. |
abstract void | join () Chờ bộ lập lịch hoàn tất. |
abstract void | join (long millis) Đợi bộ lập lịch hoàn thành hoặc hết thời gian chờ sau khoảng thời gian được chỉ định tính bằng mili giây. |
abstract void | removeAllCommands () Xóa tất cả các lệnh khỏi bộ lập lịch |
abstract void | setClearcutClient (ClearcutClient client) Đặt khách hàng để báo cáo dữ liệu khai thác |
abstract boolean | shouldShutdownOnCmdfileError () Trả về true nếu chúng ta cần tắt bộ lập lịch khi có lỗi lệnh |
default void | shutdown () Cố gắng tắt bộ lập lịch lệnh một cách duyên dáng. |
abstract void | shutdown (boolean notifyStop) Cố gắng tắt bộ lập lịch lệnh một cách duyên dáng. |
abstract void | shutdownHard (boolean killAdb) Cố gắng tắt mạnh bộ lập lịch lệnh. |
abstract void | shutdownHard () Cố gắng tắt mạnh bộ lập lịch lệnh. |
abstract void | shutdownOnEmpty () Tương tự như |
abstract void | start () Bắt đầu |
abstract boolean | stopInvocation (int invocationId, String cause) Dừng một lời gọi đang chạy bằng cách chỉ định id của nó. |
default boolean | stopInvocation (int invocationId) Dừng một lời gọi đang chạy bằng cách chỉ định id của nó. |
abstract boolean | stopInvocation ( ITestInvocation invocation) Dừng một lời gọi đang chạy. |
Phương thức công khai
thêmCommand
public abstract Pair<Boolean, Integer> addCommand (String[] args)
Thêm một lệnh vào lịch trình.
Một lệnh về cơ bản là một thể hiện của một cấu hình để chạy và các đối số liên quan của nó.
Nếu đối số "--help" được chỉ định, văn bản trợ giúp cho cấu hình sẽ được xuất ra thiết bị xuất chuẩn. Nếu không, cấu hình sẽ được thêm vào hàng đợi để chạy.
Thông số | |
---|---|
args | String : các đối số cấu hình. |
trả lại | |
---|---|
Pair <Boolean, Integer> | Một cặp giá trị, giá trị đầu tiên là Boolean true nếu lệnh được thêm thành công. Giá trị thứ hai là id 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ả các thiết bị, nếu không -1. |
ném | |
---|---|
ConfigurationException | nếu lệnh không thể được phân tích cú pháp |
thêmCommandFile
public abstract void addCommandFile (String cmdFile,extraArgs)
Thêm tất cả các lệnh từ tệp đã cho vào bộ lập lịch
Thông số | |
---|---|
cmdFile | String : đường dẫn hệ thống tệp của tệp comand |
extraArgs | ERROR(/List) của ERROR(/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 rỗng. |
ném | |
---|---|
ConfigurationException | nếu tập tin lệnh không thể được phân tích cú pháp |
Xem thêm:
chờ đợi
public abstract void await ()
Đợi bộ lập lịch bắt đầu chạy, bao gồm 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.
Thông số | |
---|---|
printWriter | PrintWriter : ERROR(/PrintWriter) để xuất ra. |
regex | String : biểu thức chính quy mà các lệnh sẽ được khớp để được in. Nếu null, thì tất cả các lệnh sẽ được in. |
hiển thịInvocationsInfo
public abstract void displayInvocationsInfo (PrintWriter printWriter)
Hiển thị danh sách các yêu cầu hiện tại.
Thông số | |
---|---|
printWriter | PrintWriter : ERROR(/PrintWriter) để xuất ra. |
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ả các giá trị Option
được chỉ định cho tất cả các lệnh hiện tại.
Thông số | |
---|---|
printWriter | PrintWriter : ERROR(/PrintWriter) để xuất trạng thái sang. |
regex | String : biểu thức chính quy mà các lệnh sẽ được đối sánh để tệp xml được kết xuất. Nếu null, thì tất cả các lệnh sẽ bị hủy. |
execCommand
public 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 nó vào hàng đợi lệnh bằng cách sử dụng IInvocationContext
đã có sẵn.
Thông số | |
---|---|
context | IInvocationContext : một IInvocationContext hiện có. |
listener | ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener được thông báo |
args | String : các đối số lệnh |
trả lại | |
---|---|
long |
ném | |
---|---|
ConfigurationException | nếu lệnh không hợp lệ |
NoDeviceException | nếu không có thiết bị để sử dụng |
execCommand
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Cấp phát trực tiếp thiết bị và thực thi lệnh mà không cần thêm nó vào hàng đợi lệnh.
Thông số | |
---|---|
listener | ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener được thông báo |
args | String : các đối số lệnh |
trả lại | |
---|---|
long | Id lời gọi của lệnh đã lên lịch. |
ném | |
---|---|
ConfigurationException | nếu lệnh không hợp lệ |
NoDeviceException | nếu không có thiết bị để sử dụng |
execCommand
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener,devices, String[] args)
Trực tiếp thực hiện lệnh trên các thiết bị đã được phân bổ.
Thông số | |
---|---|
listener | ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener được thông báo |
devices | ERROR(/List ) ERROR(/List ) để sử dụng |
args | String : các đối số lệnh |
trả lại | |
---|---|
long | Id lời gọi của lệnh đã lên lịch. |
ném | |
---|---|
ConfigurationException | nếu lệnh không hợp lệ |
getCommandFileWatcher
public abstract CommandFileWatcher getCommandFileWatcher ()
Nhận CommandFileWatcher
thích hợp cho bộ lập lịch này
trả lại | |
---|---|
CommandFileWatcher |
getExecutingCommandCount
public abstract int getExecutingCommandCount ()
Trả về số Lệnh ở trạng thái thực thi.
trả lại | |
---|---|
int |
getInvocationInfo
public abstract String getInvocationInfo (int invocationId)
Trả lại thông tin về một lời gọi bu chỉ định id lời gọi.
Thông số | |
---|---|
invocationId | int : id theo dõi của lệnh gọi. |
trả lại | |
---|---|
String | MỘT ERROR(/String) chứa thông tin về lệnh gọi. |
getLastInvocationExitCode
public abstract CommandRunner.ExitCode getLastInvocationExitCode ()
Trả lại mã lỗi của lệnh gọi cuối cùng đã chạy. Trả về 0 (không có lỗi), nếu chưa chạy lời gọi nào.
trả lại | |
---|---|
CommandRunner.ExitCode |
getLastInvocationThrowable
public abstract Throwable getLastInvocationThrowable ()
Trả về ERROR(/Throwable)
từ lệnh gọi cuối cùng đã chạy. Trả về null, nếu không có sẵn ném.
trả lại | |
---|---|
Throwable |
getReadyCommandCount
public abstract int getReadyCommandCount ()
Trả về số Lệnh ở trạng thái sẵn sàng trong hàng đợi.
trả lại | |
---|---|
int |
isDeviceInInvocationThread
public abstract boolean isDeviceInInvocationThread (ITestDevice device)
Trả về true nếu thiết bị được sử dụng bởi chuỗi yêu cầu đang hoạt động.
Thông số | |
---|---|
device | ITestDevice |
trả lại | |
---|---|
boolean |
tham gia
public abstract void join (long millis)
Đợi bộ lập lịch hoàn thành hoặc hết thời gian chờ sau khoảng thời gian được chỉ định tính bằng mili giây.
Thông số | |
---|---|
millis | long |
Xem thêm:
loại bỏ tất cả các lệnh
public abstract void removeAllCommands ()
Xóa tất cả các lệnh khỏi bộ lập lịch
thiết lậpClearcutClient
public abstract void setClearcutClient (ClearcutClient client)
Đặt khách hàng để báo cáo dữ liệu khai thác
Thông số | |
---|---|
client | ClearcutClient |
nênShutdownOnCmdfileError
public abstract boolean shouldShutdownOnCmdfileError ()
Trả về true nếu chúng ta cần tắt bộ lập lịch khi có lỗi lệnh
trả lại | |
---|---|
boolean |
tắt
public void shutdown ()
Cố gắng tắt bộ lập lịch lệnh một cách duyên dáng.
Xóa các lệnh đang chờ để được kiểm tra và yêu cầu tất cả các yêu cầu đang diễn ra được tắt một cách duyên dáng.
Sau khi tắt máy được gọi, vòng lặp chính của bộ lập lịch sẽ đợi tất cả các yêu cầu đ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 bộ lập lịch lệnh một cách duyên dáng.
Thông số | |
---|---|
notifyStop | boolean : nếu đúng, thông báo yêu cầu tắt TF. |
tắt máyCứng
public abstract void shutdownHard (boolean killAdb)
Cố gắng tắt mạnh bộ lập lịch lệnh.
Tương tự như shutdown()
, nhưng cũng sẽ tùy chọn hủy kết nối adb, nhằm cố gắng 'truyền cảm hứng' cho các yêu cầu đang diễn ra để hoàn thành nhanh hơn.
Thông số | |
---|---|
killAdb | boolean |
tắt máyCứng
public abstract void shutdownHard ()
Cố gắng tắt mạnh bộ lập lịch lệnh. Tương tự như shutdownHard(true).
tắt máyOnRỗng
public abstract void shutdownOnEmpty ()
Tương tự như shutdown()
, nhưng thay vào đó sẽ đợi tất cả các lệnh được thực thi trước khi thoát.
bắt đầu
public abstract void start ()
Bắt đầu ICommandScheduler
.
shutdown()
được gọi. xem ERROR(/Thread#start())
. ngừng gọi
public abstract boolean stopInvocation (int invocationId, String cause)
Dừng một lời gọi đang chạy bằng cách chỉ định id của nó.
Thông số | |
---|---|
invocationId | int : id theo dõi của lệnh gọi. |
cause | String : nguyên nhân dừng lời gọi. |
trả lại | |
---|---|
boolean | đúng nếu lời gọi bị dừng, ngược lại là sai |
ném | |
---|---|
| nếu việc triển khai không hỗ trợ điều này |
ngừng gọi
public boolean stopInvocation (int invocationId)
Dừng một lời gọi đang chạy bằng cách chỉ định id của nó.
Thông số | |
---|---|
invocationId | int |
trả lại | |
---|---|
boolean | đúng nếu lời gọi bị dừng, ngược lại là sai |
ném | |
---|---|
| nếu việc triển khai không hỗ trợ điều này |
ngừng gọi
public abstract boolean stopInvocation (ITestInvocation invocation)
Dừng một lời gọi đang chạy.
Thông số | |
---|---|
invocation | ITestInvocation |
trả lại | |
---|---|
boolean | đúng nếu lời gọi bị dừng, ngược lại là sai |
ném | |
---|---|
| nếu việc triển khai không hỗ trợ điều này |
Nội dung và mã mẫu trên trang này phải tuân thủ các giấy phép như mô tả trong phần Giấy phép nội dung. Java và OpenJDK là nhãn hiệu hoặc nhãn hiệu đã đăng ký của Oracle và/hoặc đơn vị liên kết của Oracle.
Cập nhật lần gần đây nhất: 2023-03-30 UTC.