ICommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler


ตัวกำหนดตารางเวลาสำหรับการรันคำสั่ง TradeFederation

สรุป

คลาสที่ซ้อนกัน

interface ICommandScheduler.IScheduledInvocationListener

Listener สำหรับเหตุการณ์การเรียกใช้เมื่อการเรียกเสร็จสิ้น

วิธีการสาธารณะ

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

เพิ่มคำสั่งไปยังตัวกำหนดตารางเวลา

abstract void addCommandFile (String cmdFile, extraArgs) addCommandFile (String cmdFile, extraArgs)

เพิ่มคำสั่งทั้งหมดจากไฟล์ที่กำหนดไปยังตัวกำหนดตารางเวลา

abstract void await ()

รอให้ตัวกำหนดตารางเวลาเริ่มทำงาน รวมถึงการรอการส่งมอบจาก TF เก่าให้เสร็จสิ้น หากมี

abstract void displayCommandQueue (PrintWriter printWriter)

ส่งออกข้อมูลการดีบักโดยละเอียดเกี่ยวกับสถานะของคิวการดำเนินการคำสั่ง

abstract void displayCommandsInfo (PrintWriter printWriter, String regex)

แสดงรายการคำสั่งปัจจุบัน

abstract void displayInvocationsInfo (PrintWriter printWriter)

แสดงรายการการเรียกปัจจุบัน

abstract void dumpCommandsXml (PrintWriter printWriter, String regex)

ดัมพ์ไฟล์ xml ที่ขยายสำหรับคำสั่งที่มีค่า Option ทั้งหมดที่ระบุสำหรับคำสั่งปัจจุบันทั้งหมด

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

จัดสรรอุปกรณ์โดยตรงและดำเนินการคำสั่งโดยไม่ต้องเพิ่มลงในคิวคำสั่งโดยใช้ IInvocationContext ที่มีอยู่แล้ว

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

จัดสรรอุปกรณ์โดยตรงและดำเนินการคำสั่งโดยไม่ต้องเพิ่มลงในคิวคำสั่ง

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

ดำเนินการคำสั่งโดยตรงบนอุปกรณ์ที่ได้รับการจัดสรรแล้ว

abstract CommandFileWatcher getCommandFileWatcher ()

รับ CommandFileWatcher ที่เหมาะสมสำหรับตัวกำหนดตารางเวลานี้

abstract int getExecutingCommandCount ()

ส่งกลับจำนวนคำสั่งในสถานะดำเนินการ

abstract String getInvocationInfo (int invocationId)

ส่งคืนข้อมูลในการเรียกใช้ bu ที่ระบุรหัสการเรียกใช้

abstract CommandRunner.ExitCode getLastInvocationExitCode ()

ส่งกลับรหัสข้อผิดพลาดของการเรียกใช้ล่าสุดที่ทำงาน

abstract Throwable getLastInvocationThrowable ()

ส่งคืน Throwable จากการเรียกครั้งสุดท้ายที่วิ่ง

abstract int getReadyCommandCount ()

ส่งกลับจำนวนคำสั่งในสถานะพร้อมในคิว

abstract boolean isDeviceInInvocationThread ( ITestDevice device)

คืนค่า จริง หากอุปกรณ์ถูกใช้โดยเธรดการเรียกใช้ที่ทำงานอยู่

abstract void join ()

รอให้ตัวกำหนดตารางเวลาดำเนินการให้เสร็จสิ้น

abstract void join (long millis)

รอให้ตัวจัดกำหนดการเสร็จสมบูรณ์หรือหมดเวลาหลังจากระยะเวลาที่ระบุเป็นมิลลิวินาที

abstract void removeAllCommands ()

ลบคำสั่งทั้งหมดออกจากตัวกำหนดตารางเวลา

abstract void setClearcutClient (ClearcutClient client)

ตั้งค่าไคลเอนต์ให้รายงานข้อมูลสายรัด

abstract boolean shouldShutdownOnCmdfileError ()

คืนค่า จริง หากเราจำเป็นต้องปิดตัวกำหนดตารางเวลาจากข้อผิดพลาดของคำสั่ง

default void shutdown ()

พยายามปิดตัวกำหนดตารางเวลาคำสั่งอย่างสง่างาม

abstract void shutdown (boolean notifyStop)

พยายามปิดตัวกำหนดตารางเวลาคำสั่งอย่างสง่างาม

abstract void shutdownHard (boolean killAdb)

พยายามบังคับให้ปิดตัวกำหนดตารางเวลาคำสั่ง

abstract void shutdownHard ()

พยายามบังคับให้ปิดตัวกำหนดตารางเวลาคำสั่ง

abstract void shutdownOnEmpty ()

คล้ายกับ shutdown() แต่จะรอให้คำสั่งทั้งหมดทำงานก่อนที่จะออก

abstract void start ()

เริ่ม ICommandScheduler

abstract boolean stopInvocation (int invocationId, String cause)

หยุดการเรียกใช้ที่ทำงานอยู่โดยระบุเป็น id

default boolean stopInvocation (int invocationId)

หยุดการเรียกใช้ที่ทำงานอยู่โดยระบุเป็น id

abstract boolean stopInvocation ( ITestInvocation invocation)

หยุดเรียกใช้การเรียกใช้

วิธีการสาธารณะ

addCommand

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

เพิ่มคำสั่งไปยังตัวกำหนดตารางเวลา

คำสั่งโดยพื้นฐานแล้วคืออินสแตนซ์ของการกำหนดค่าที่จะรันและอาร์กิวเมนต์ที่เกี่ยวข้อง

หากระบุอาร์กิวเมนต์ "--help" ข้อความช่วยเหลือสำหรับการกำหนดค่าจะถูกส่งไปยัง stdout มิฉะนั้น การกำหนดค่าจะถูกเพิ่มในคิวเพื่อรัน

พารามิเตอร์
args String : อาร์กิวเมนต์การตั้งค่า

คืนสินค้า
Pair <Boolean, Integer> คู่ของค่า ค่าแรกคือ Boolean true หากเพิ่มคำสั่งสำเร็จ ค่าที่สองคือ id ตัวติดตามคำสั่งที่รู้จัก (ค่าที่ไม่ใช่ค่าลบ) หากเพิ่มคำสั่งสำเร็จ ให้คืนค่า 0 เมื่อมีการเพิ่มคำสั่งสำหรับอุปกรณ์ทั้งหมด มิฉะนั้น -1

ขว้าง
ConfigurationException ถ้าแยกวิเคราะห์คำสั่งไม่ได้

ดูสิ่งนี้ด้วย:

addCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

เพิ่มคำสั่งทั้งหมดจากไฟล์ที่กำหนดไปยังตัวกำหนดตารางเวลา

พารามิเตอร์
cmdFile String : เส้นทางระบบไฟล์ของ comand file

extraArgs : ERROR(/List) ของอาร์กิวเมนต์ String ที่จะผนวกกับแต่ละคำสั่งที่แยกวิเคราะห์จากไฟล์ สามารถว่างเปล่าได้ แต่ไม่ควรเป็นค่าว่าง

ขว้าง
ConfigurationException หากแยกวิเคราะห์ไฟล์คำสั่งไม่ได้

ดูสิ่งนี้ด้วย:

รอคอย

public abstract void await ()

รอให้ตัวกำหนดตารางเวลาเริ่มทำงาน รวมถึงการรอการส่งมอบจาก TF เก่าให้เสร็จสิ้น หากมี

displayCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

ส่งออกข้อมูลการดีบักโดยละเอียดเกี่ยวกับสถานะของคิวการดำเนินการคำสั่ง

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

แสดงรายการคำสั่งปัจจุบัน

พารามิเตอร์
printWriter PrintWriter : ERROR(/PrintWriter) ที่จะส่งออกไปยัง

regex String : นิพจน์ทั่วไปที่ควรจับคู่คำสั่งเพื่อพิมพ์ หากเป็นโมฆะ คำสั่งทั้งหมดจะถูกพิมพ์

displayInvocationsInfo

public abstract void displayInvocationsInfo (PrintWriter printWriter)

แสดงรายการการเรียกปัจจุบัน

พารามิเตอร์
printWriter PrintWriter : ERROR(/PrintWriter) ที่จะส่งออกไปยัง

dumpCommandsXml

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

ดัมพ์ไฟล์ xml ที่ขยายสำหรับคำสั่งที่มีค่า Option ทั้งหมดที่ระบุสำหรับคำสั่งปัจจุบันทั้งหมด

พารามิเตอร์
printWriter PrintWriter : ERROR(/PrintWriter) ที่จะส่งออกสถานะไปที่

regex String : นิพจน์ทั่วไปที่คำสั่งควรจับคู่เพื่อให้ไฟล์ xml ถูกดัมพ์ หากเป็นโมฆะ คำสั่งทั้งหมดจะถูกดัมพ์

execCommand

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

จัดสรรอุปกรณ์โดยตรงและดำเนินการคำสั่งโดยไม่ต้องเพิ่มลงในคิวคำสั่งโดยใช้ IInvocationContext ที่มีอยู่แล้ว

พารามิเตอร์
context IInvocationContext : IInvocationContext ที่มีอยู่

listener ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener ที่จะได้รับแจ้ง

args String : อาร์กิวเมนต์คำสั่ง

คืนสินค้า
long

ขว้าง
ConfigurationException ถ้าคำสั่งไม่ถูกต้อง
NoDeviceException หากไม่มีอุปกรณ์ให้ใช้

execCommand

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

จัดสรรอุปกรณ์โดยตรงและดำเนินการคำสั่งโดยไม่ต้องเพิ่มลงในคิวคำสั่ง

พารามิเตอร์
listener ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener ที่จะได้รับแจ้ง

args String : อาร์กิวเมนต์คำสั่ง

คืนสินค้า
long รหัสการเรียกใช้ของคำสั่งที่กำหนดเวลาไว้

ขว้าง
ConfigurationException ถ้าคำสั่งไม่ถูกต้อง
NoDeviceException หากไม่มีอุปกรณ์ให้ใช้

execCommand

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

ดำเนินการคำสั่งโดยตรงบนอุปกรณ์ที่ได้รับการจัดสรรแล้ว

พารามิเตอร์
listener ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener ที่จะได้รับแจ้ง

device ITestDevice : ITestDevice ที่จะใช้

args String : อาร์กิวเมนต์คำสั่ง

คืนสินค้า
long รหัสการเรียกใช้ของคำสั่งที่กำหนดเวลาไว้

ขว้าง
ConfigurationException ถ้าคำสั่งไม่ถูกต้อง

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

รับ CommandFileWatcher ที่เหมาะสมสำหรับตัวกำหนดตารางเวลานี้

คืนสินค้า
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

ส่งกลับจำนวนคำสั่งในสถานะดำเนินการ

คืนสินค้า
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

ส่งคืนข้อมูลในการเรียกใช้ bu ที่ระบุรหัสการเรียกใช้

พารามิเตอร์
invocationId int : รหัสติดตามของการร้องขอ

คืนสินค้า
String String ที่มีข้อมูลเกี่ยวกับการเรียกใช้

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

ส่งกลับรหัสข้อผิดพลาดของการเรียกใช้ล่าสุดที่ทำงาน คืนค่า 0 (ไม่มีข้อผิดพลาด) หากยังไม่มีการเรียกใช้งาน

คืนสินค้า
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

ส่งคืน Throwable จากการเรียกครั้งสุดท้ายที่วิ่ง คืนค่า null ถ้าไม่มีการขว้างปา

คืนสินค้า
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

ส่งกลับจำนวนคำสั่งในสถานะพร้อมในคิว

คืนสินค้า
int

isDeviceInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

คืนค่า จริง หากอุปกรณ์ถูกใช้โดยเธรดการเรียกใช้ที่ทำงานอยู่

พารามิเตอร์
device ITestDevice

คืนสินค้า
boolean

เข้าร่วม

public abstract void join ()

รอให้ตัวกำหนดตารางเวลาดำเนินการให้เสร็จสิ้น

ดูสิ่งนี้ด้วย:

เข้าร่วม

public abstract void join (long millis)

รอให้ตัวจัดกำหนดการเสร็จสมบูรณ์หรือหมดเวลาหลังจากระยะเวลาที่ระบุเป็นมิลลิวินาที

พารามิเตอร์
millis long

ดูสิ่งนี้ด้วย:

removeAllCommands

public abstract void removeAllCommands ()

ลบคำสั่งทั้งหมดออกจากตัวกำหนดตารางเวลา

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

ตั้งค่าไคลเอนต์ให้รายงานข้อมูลสายรัด

พารามิเตอร์
client ClearcutClient

ควรShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

คืนค่า จริง หากเราจำเป็นต้องปิดตัวกำหนดตารางเวลาจากข้อผิดพลาดของคำสั่ง

คืนสินค้า
boolean

ปิดตัวลง

public void shutdown ()

พยายามปิดตัวกำหนดตารางเวลาคำสั่งอย่างสง่างาม

ล้างคำสั่งที่รอการทดสอบ และขอให้การเรียกใช้ทั้งหมดที่อยู่ระหว่างดำเนินการปิดตัวลงอย่างสง่างาม

หลังจากเรียกการปิดระบบ ลูปหลักของตัวจัดกำหนดการจะรอให้การเรียกใช้ทั้งหมดที่ดำเนินการอยู่เสร็จสิ้นก่อนที่จะออกจากอย่างสมบูรณ์

ปิดตัวลง

public abstract void shutdown (boolean notifyStop)

พยายามปิดตัวกำหนดตารางเวลาคำสั่งอย่างสง่างาม

พารามิเตอร์
notifyStop boolean : ถ้าเป็นจริง จะแจ้งการเรียกการปิด TF

ปิดฮาร์ด

public abstract void shutdownHard (boolean killAdb)

พยายามบังคับให้ปิดตัวกำหนดตารางเวลาคำสั่ง

คล้ายกับ shutdown() แต่จะเลือกที่จะฆ่าการเชื่อมต่อ adb ด้วย ด้วยความพยายามที่จะ 'สร้างแรงบันดาลใจ' การร้องขอที่กำลังดำเนินการให้เสร็จสิ้นเร็วขึ้น

พารามิเตอร์
killAdb boolean

ปิดฮาร์ด

public abstract void shutdownHard ()

พยายามบังคับให้ปิดตัวกำหนดตารางเวลาคำสั่ง เหมือนกับ shutdownHard(จริง)

shutdownOnEmpty

public abstract void shutdownOnEmpty ()

คล้ายกับ shutdown() แต่จะรอให้คำสั่งทั้งหมดทำงานก่อนที่จะออก

โปรดทราบว่าหากมีคำสั่งใดๆ อยู่ในโหมดวนรอบ ตัวกำหนดตารางเวลาจะไม่ออก

เริ่ม

public abstract void start ()

เริ่ม ICommandScheduler

ต้องเรียกก่อนเรียกวิธีอื่น

จะทำงานจนกว่าจะถูกเรียก shutdown() ดู Thread.start()

หยุดการร้องขอ

public abstract boolean stopInvocation (int invocationId, 
                String cause)

หยุดการเรียกใช้ที่ทำงานอยู่โดยระบุเป็น id

พารามิเตอร์
invocationId int : รหัสติดตามของการร้องขอ

cause String : สาเหตุของการหยุดการร้องขอ

คืนสินค้า
boolean จริงถ้าการวิงวอนหยุดลง เท็จ มิฉะนั้น

ขว้าง
UnsupportedOperationException หากการใช้งานไม่รองรับสิ่งนี้

หยุดการร้องขอ

public boolean stopInvocation (int invocationId)

หยุดการเรียกใช้ที่ทำงานอยู่โดยระบุเป็น id

พารามิเตอร์
invocationId int

คืนสินค้า
boolean จริงถ้าการวิงวอนหยุดลง เท็จ มิฉะนั้น

ขว้าง
UnsupportedOperationException หากการใช้งานไม่รองรับสิ่งนี้

หยุดการร้องขอ

public abstract boolean stopInvocation (ITestInvocation invocation)

หยุดเรียกใช้การเรียกใช้

พารามิเตอร์
invocation ITestInvocation

คืนสินค้า
boolean จริงถ้าการวิงวอนหยุดลง เท็จ มิฉะนั้น

ขว้าง
UnsupportedOperationException หากการใช้งานไม่รองรับสิ่งนี้