מתזמן המשימות

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler


מתזמן להרצת פקודות TradeFederation.

סיכום

מחלקות מקוננות

interface ICommandScheduler.IScheduledInvocationListener

האזנה לאירועי הפעלה בסיום ההפעלה. 

שיטות ציבוריות

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

הוספת פקודה לתזמון.

abstract void addCommandFile(String cmdFile, extraArgs)

הוספה של כל הפקודות מקובץ נתון למתזמן

abstract void await()

בהמתנה שהמתזמן יתחיל לפעול, כולל בהמתנה לסיום ההעברה של המכשיר הישן אם רלוונטי.

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, devices, String[] args)

הפעלה ישירה של הפקודה במכשירים שכבר הוקצו.

abstract CommandFileWatcher getCommandFileWatcher()

משיגים את ה-CommandFileWatcher המתאים לתזמון הזה

abstract int getExecutingCommandCount()

הפונקציה מחזירה את מספר הפקודות במצב ביצוע.

abstract String getInvocationInfo(int invocationId)

להחזיר את המידע על ממשק ההפעלה שמצוין בו מזהה ההפעלה.

abstract CommandRunner.ExitCode getLastInvocationExitCode()

מחזירה את קוד השגיאה של ההפעלה האחרונה שרצה.

abstract Throwable getLastInvocationThrowable()

מחזירה את הערך Throwable מההפעלה האחרונה שרצה.

abstract int getReadyCommandCount()

הפונקציה מחזירה את מספר הפקודות במצב Ready בתור.

abstract boolean isDeviceInInvocationThread(ITestDevice device)

הפונקציה מחזירה את הערך True אם המכשיר נמצא בשימוש על ידי שרשור הפעלה פעיל.

abstract void join()

בהמתנה להשלמת המתזמן.

abstract void join(long millis)

בהמתנה להשלמת המתזמן או לסיום הזמן הקצוב לתפוגה אחרי משך הזמן שצוין באלפיות השנייה.

abstract void removeAllCommands()

הסרת כל הפקודות מהמתזמן

abstract void setClearcutClient(ClearcutClient client)

הגדרת הלקוח לדיווח על נתוני רתמות

abstract boolean shouldShutdownOnCmdfileError()

פונקציה זו מחזירה את הערך true אם יש צורך לכבות את המתזמן במקרה של שגיאות פקודה

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)

כדי להפסיק הפעלה רצה, מציינים את המזהה.

default boolean stopInvocation(int invocationId)

כדי להפסיק הפעלה רצה, מציינים את המזהה.

abstract boolean stopInvocation(ITestInvocation invocation)

הפסקת ההפעלה הרצה.

default void stopScheduling()

האפשרות הזו מפסיקה לתזמן ולקבל בדיקות חדשות, אבל לא מפסיקה אתטרייד.

שיטות ציבוריות

addCommand

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

הוספת פקודה לתזמון.

פקודה היא בעצם מופע של מערך הגדרות אישיות שמריצים ארגומנטים.

אם "--help" צוין ארגומנט, טקסט העזרה עבור ההגדרה יופק כפלט אל stdout. אחרת, ההגדרה תתווסף לתור להרצה.

פרמטרים
args String: הארגומנטים מסוג config.

החזרות
Pair<Boolean, Integer> צמד ערכים, הערך הראשון הוא true בוליאני אם נוספה פקודה בהצלחה. הערך השני הוא המזהה הידוע של מעקב הפקודות(ערך לא שלילי), אם הפקודה נוספה בהצלחה, החזרת הפקודה 0 כאשר תתווסף הפקודה לכל המכשירים, אחרת 1-.

קליעות
ConfigurationException אם לא ניתן לנתח את הפקודה

addCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

הוספה של כל הפקודות מקובץ נתון למתזמן

פרמטרים
cmdFile String: נתיב מערכת הקבצים של קובץ comand

extraArgs : ERROR(/List) מתוך String ארגומנטים לצירוף לכל פקודה שנותחה מקובץ. השדה יכול להיות ריק אבל לא יכול להיות null.

קליעות
ConfigurationException אם אי אפשר לנתח את קובץ הפקודה

למידע נוסף:

לחכות

public abstract void await ()

בהמתנה שהמתזמן יתחיל לפעול, כולל בהמתנה לסיום ההעברה של המכשיר הישן אם רלוונטי.

displayCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

פלט מידע מפורט על ניפוי באגים לגבי מצב תור ביצוע הפקודות.

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

יוצרים פלט של רשימה של הפקודות הנוכחיות.

פרמטרים
printWriter PrintWriter: ה-ERROR(/PrintWriter) שאליו יש לשלוח את הפלט.

regex String: הביטוי הרגולרי שאליו צריך להתאים פקודות כדי מודפס. אם הערך הוא null, כל הפקודות יודפסו.

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. אם הערך הוא null, כל הפקודות יושלכו.

פקודה

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 אם אין מכשיר להשתמש בו

פקודה

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

מקצה מכשיר באופן ישיר ומבצע פקודות בלי להוסיף אותו לתור הפקודות.

פרמטרים
listener ICommandScheduler.IScheduledInvocationListener: הICommandScheduler.IScheduledInvocationListener שצריך לעדכן

args String: הארגומנטים של הפקודה

החזרות
long מזהה ההפעלה של הפקודה המתוזמנת.

קליעות
ConfigurationException אם הפקודה לא הייתה חוקית
NoDeviceException אם אין מכשיר להשתמש בו

פקודה

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

הפעלה ישירה של הפקודה במכשירים שכבר הוקצו.

פרמטרים
listener ICommandScheduler.IScheduledInvocationListener: הICommandScheduler.IScheduledInvocationListener שצריך לעדכן

devices : ERROR(/List) לשימוש

args String: הארגומנטים של הפקודה

החזרות
long מזהה ההפעלה של הפקודה המתוזמנת.

קליעות
ConfigurationException אם הפקודה לא הייתה חוקית

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

משיגים את ה-CommandFileWatcher המתאים לתזמון הזה

החזרות
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

הפונקציה מחזירה את מספר הפקודות במצב ביצוע.

החזרות
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

להחזיר את המידע על ממשק ההפעלה שמצוין בו מזהה ההפעלה.

פרמטרים
invocationId int: המזהה לצורכי מעקב של ההפעלה.

החזרות
String String שמכיל מידע על ההפעלה.

getLastInvocationיציאהCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

מחזירה את קוד השגיאה של ההפעלה האחרונה שרצה. פונקציה זו מחזירה 0 (אין שגיאה), אם עדיין לא פעלה הפעלה.

החזרות
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

מחזירה את הערך Throwable מההפעלה האחרונה שרצה. החזרת null, אם לא ניתן להשליך.

החזרות
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

הפונקציה מחזירה את מספר הפקודות במצב Ready בתור.

החזרות
int

isDeviceInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

הפונקציה מחזירה את הערך True אם המכשיר נמצא בשימוש על ידי שרשור הפעלה פעיל.

פרמטרים
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

צריךכיבוי

public abstract boolean shouldShutdownOnCmdfileError ()

פונקציה זו מחזירה את הערך true אם יש צורך לכבות את המתזמן במקרה של שגיאות פקודה

החזרות
boolean

כיבוי

public void shutdown ()

כדאי לנסות לכבות באלגנטיות את מתזמן הפקודות.

מנקה פקודות שממתינות לבדיקה ומבקש לסגור את כל ההפעלות שמתבצעות באלגנטיות.

לאחר קריאה לכיבוי, הלולאה הראשית של מתזמן ימתין עד שכל ההפעלות את ההתקדמות שהושלם לפני יציאה לחלוטין.

כיבוי

public abstract void shutdown (boolean notifyStop)

כדאי לנסות לכבות באלגנטיות את מתזמן הפקודות.

פרמטרים
notifyStop boolean: אם הערך הוא True, המערכת מודיעה על הפעלות של סגירת TF.

כיבוי קשיח

public abstract void shutdownHard (boolean killAdb)

ניסיון לכבות בכוח את מתזמן הפקודות.

דומה ל-shutdown(), אבל באופן אופציונלי גם יחדל את חיבור ה-adb, לנסות 'לעורר השראה' מתבצעות הפעלות כדי להשלים אותן מהר יותר.

פרמטרים
killAdb boolean

כיבוי קשיח

public abstract void shutdownHard ()

ניסיון לכבות בכוח את מתזמן הפקודות. זהה ל- offHard(true).

כיבוי ריק

public abstract void shutdownOnEmpty ()

דומה ל-shutdown(), אבל ימתין עד שכל הפקודות יבוצעו לפני היציאה.

חשוב לשים לב שאם פקודות מסוימות נמצאות במצב לולאה, מתזמן הבקשות לא ייצא אף פעם.

התחל

public abstract void start ()

מפעילים את ICommandScheduler.

חובה לקרוא לפונקציה לפני קריאה לשיטות אחרות.

יפעל עד קריאה אל shutdown(). פרטים נוספים זמינים בThread.start().

הפסקת ההפעלה

public abstract boolean stopInvocation (int invocationId, 
                String cause)

כדי להפסיק הפעלה רצה, מציינים את המזהה.

פרמטרים
invocationId int: המזהה לצורכי מעקב של ההפעלה.

cause String: הסיבה להפסקת ההפעלה.

החזרות
boolean true אם ההפעלה הופסקה, אחרת false

קליעות
UnsupportedOperationException אם ההטמעה לא תומכת

הפסקת ההפעלה

public boolean stopInvocation (int invocationId)

כדי להפסיק הפעלה רצה, מציינים את המזהה.

פרמטרים
invocationId int

החזרות
boolean true אם ההפעלה הופסקה, אחרת false

קליעות
UnsupportedOperationException אם ההטמעה לא תומכת

הפסקת ההפעלה

public abstract boolean stopInvocation (ITestInvocation invocation)

הפסקת ההפעלה הרצה.

פרמטרים
invocation ITestInvocation

החזרות
boolean true אם ההפעלה הופסקה, אחרת false

קליעות
UnsupportedOperationException אם ההטמעה לא תומכת

הפסקת התזמון

public void stopScheduling ()

האפשרות הזו מפסיקה לתזמן ולקבל בדיקות חדשות, אבל לא מפסיקה אתטרייד. המטרה היא לאפשר כיבוי דו-שלבי שבו קודם כולנו מרוקנים את כל הבדיקות הפעילות ואז מפסיקים את מערכת TradeFederal תהליך האימות.