IRunUtil

public interface IRunUtil

com.android.tradefed.util.IRunUtil

מחלקות משנה לא ישירות מוכרות RunUtil RunUtil אוסף של שיטות עזר להפעלת פעולות.

---

ממשק להרצת פעולות מתוזמנות ופקודות מערכת.

סיכום

כיתות מוטמעות
interface	IRunUtil.IRunnableResult ממשק להפעלה אסינכרונית של פעולה שמחזירה סטטוס בוליאני.

‫methods ציבוריים
abstract void	allowInterrupt(boolean allow) מאפשרת או אוסרת על הפרעות בהרצת השרשור הנוכחי.
abstract void	interrupt(Thread thread, String message, ErrorIdentifier errorId) מפסיקה את פעולות ההרצה המתמשכות או הקרובות בשרשור הנתון.
abstract void	interrupt(Thread thread, String message) מפסיקה את פעולות ההרצה המתמשכות או הקרובות בשרשור הנתון.
abstract boolean	isInterruptAllowed() החזרת סטטוס ההפרעה של RunUtil.
abstract Process	runCmdInBackground(ProcessBuilder.Redirect redirect, List<String> command) שיטה חלופית runCmdInBackground(String...) שמקבלת את ארגומנטי הפקודה בפורמט List.
abstract Process	runCmdInBackground(ProcessBuilder.Redirect redirect, String... command) שיטת עזר להרצת פקודת מערכת באופן אסינכרוני.
abstract Process	runCmdInBackground(List<String> command) שיטה חלופית runCmdInBackground(String...) שמקבלת את ארגומנטי הפקודה בפורמט List.
abstract Process	runCmdInBackground(String... command) שיטת עזר להרצת פקודת מערכת באופן אסינכרוני.
abstract Process	runCmdInBackground(List<String> command, OutputStream output) הפעלת הפקודה עם OutputStream תרשום את הפלט של הפקודה.
abstract boolean	runEscalatingTimedRetry(long opTimeout, long initialPollInterval, long maxPollInterval, long maxTime, IRunUtil.IRunnableResult runnable) חסימה וביצוע של פעולה כמה פעמים עד שהיא מצליחה.
abstract boolean	runFixedTimedRetry(long opTimeout, long pollInterval, long maxTime, IRunUtil.IRunnableResult runnable) חסימה וביצוע של פעולה כמה פעמים עד שהיא מצליחה.
abstract boolean	runFixedTimedRetryWithOutputMonitor(long opTimeout, long idleOutputTimeout, long pollInterval, long maxTime, IRunUtil.IRunnableResult runnable) חסימה וביצוע של פעולה כמה פעמים עד שהיא מצליחה.
abstract CommandStatus	runTimed(long timeout, IRunUtil.IRunnableResult runnable, boolean logErrors) חסימה וביצוע של פעולה, ביטול אם הפעולה נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmd(long timeout, String... command) שיטת עזר להרצת פקודה במערכת, וביטול אם הפקודה נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmd(long timeout, OutputStream stdout, OutputStream stderr, String... command) שיטת עזר להפעלת פקודה במערכת, ביטול אם הפעולה נמשכת יותר מהזמן שצוין והפניית הפלט לקבצים אם צוין.
abstract CommandResult	runTimedCmdRetry(long timeout, long retryInterval, int attempts, String... command) שיטת עזר להרצת פקודה במערכת, וביטול אם הפקודה נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmdRetryWithOutputMonitor(long timeout, long idleOutputTimeout, long retryInterval, int attempts, String... command) שיטת עזר להרצת פקודה במערכת, וביטול אם הפקודה נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmdSilently(long timeout, String... command) שיטת עזר להרצת פקודה במערכת, וביטול אם הפקודה נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmdSilentlyRetry(long timeout, long retryInterval, int attempts, String... command) שיטת עזר להרצת פקודה במערכת, וביטול אם הפקודה נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmdWithInput(long timeout, String input, String... command) שיטת עזר להפעלת פקודה במערכת שנדרש לה קלט stdin, וביטול הפעולה אם היא נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmdWithInput(long timeout, String input, List<String> command) שיטת עזר להפעלת פקודה במערכת שנדרש לה קלט stdin, וביטול הפעולה אם היא נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmdWithInput(long timeout, String input, File stdoutFile, File stderrFile, String... command) שיטת עזר להפעלת פקודה במערכת, ביטול אם הפעולה נמשכת יותר מהזמן שצוין והפניית הפלט לקבצים אם צוין.
abstract CommandResult	runTimedCmdWithInputRedirect(long timeout, File inputRedirect, String... command) שיטת עזר להפעלת פקודה במערכת שדורשת הפניה של Stdin מקובץ, וביטול אם הפעולה נמשכת יותר מהזמן שצוין.
abstract CommandResult	runTimedCmdWithOutputMonitor(long timeout, long idleOutputTimeout, String... command) שיטת עזר להרצת פקודה במערכת, וביטול אם הפקודה נמשכת יותר מזמן מוגדר.
abstract CommandResult	runTimedCmdWithOutputMonitor(long timeout, long idleOutputTimeout, OutputStream stdout, OutputStream stderr, String... command) שיטת עזר להפעלת פקודה במערכת, ביטול אם הפעולה נמשכת יותר מהזמן שצוין והפניית הפלט לקבצים אם צוין.
abstract boolean	runTimedRetry(long opTimeout, long pollInterval, int attempts, IRunUtil.IRunnableResult runnable) חסימה וביצוע של פעולה כמה פעמים עד שהיא מצליחה.
abstract boolean	runTimedRetryWithOutputMonitor(long opTimeout, long idleOutputTimeout, long pollInterval, int attempts, IRunUtil.IRunnableResult runnable) חסימה וביצוע של פעולה כמה פעמים עד שהיא מצליחה.
abstract CommandStatus	runTimedWithOutputMonitor(long timeout, long idleOutputTimeout, IRunUtil.IRunnableResult runnable, boolean logErrors) חסימה וביצוע של פעולה, ביטול אם הפעולה נמשכת יותר מזמן מוגדר.
abstract void	setEnvVariable(String key, String value) מגדיר משתנה סביבה לשימוש בהרצת פקודות מערכת.
abstract void	setEnvVariablePriority(IRunUtil.EnvPriority priority) מחליטים אם כשיוצרים תהליך, ביטול ההגדרה של משתנה סביבה הוא בעדיפות גבוהה יותר מהגדרת משתנה סביבה.
abstract void	setInterruptibleInFuture(Thread thread, long timeMs) הגדרה כהודעה שניתן להפסיק אחרי פרק זמן מסוים.
abstract void	setLinuxInterruptProcess(boolean interrupt) הגדרה שמאפשרת להשתמש בהפרעה 'kill' של Linux בתהליך שמופעל באמצעות שיטות ‎ #runTimed כשהוא מגיע לזמן קצוב לתפוגה.
abstract void	setRedirectStderrToStdout(boolean redirect) מגדירים את זרם השגיאות הרגיל להפניה לזרם הפלט הרגיל כשמריצים פקודות מערכת.
abstract void	setWorkingDir(File dir) הגדרת ספריית העבודה לפקודות המערכת.
abstract void	sleep(long time) שיטת עזר להשהיה למשך זמן נתון, תוך התעלמות מחריגים.
abstract void	unsetEnvVariable(String key) מבטל את ההגדרה של משתנה סביבה, כך שפקודות המערכת יפעלו בלי משתנה הסביבה הזה.

‫methods ציבוריים

allowInterrupt

public abstract void allowInterrupt (boolean allow)

מאפשרת או אוסרת על הפרעות בהרצת השרשור הנוכחי. אם הפעולה מותרת, אפשר להפריע לפעולות של השרשור הנוכחי משרשורים אחרים באמצעות השיטה interrupt(Thread, String).

פרמטרים
allow	‫boolean: האם לאפשר הפרעות בהרצה בשרשור הנוכחי.

להפריע

public abstract void interrupt (Thread thread, 
                String message, 
                ErrorIdentifier errorId)

מפסיקה את פעולות ההרצה המתמשכות או הקרובות בשרשור הנתון. הפעלת פעולות בשרשור הנתון תגרום לשגיאה RunInterruptedException.

פרמטרים
message	String: ההודעה לRunInterruptedException.
errorId	ErrorIdentifier: מייצג את הסיבה להפרעה, אם היא ידועה.

להפריע

public abstract void interrupt (Thread thread, 
                String message)

מפסיקה את פעולות ההרצה המתמשכות או הקרובות בשרשור הנתון. הפעלת פעולות בשרשור הנתון תגרום לשגיאה RunInterruptedException.

פרמטרים
message	String: ההודעה לRunInterruptedException.

isInterruptAllowed

public abstract boolean isInterruptAllowed ()

החזרת סטטוס ההפרעה של RunUtil.

החזרות
boolean	הערך true אם אפשר להפריע להרצה, אחרת הערך false.

runCmdInBackground

public abstract Process runCmdInBackground (ProcessBuilder.Redirect redirect, 
                List<String> command)

שיטה חלופית runCmdInBackground(String...) שמקבלת את ארגומנטי הפקודה בפורמט List.

פרמטרים
redirect	ProcessBuilder.Redirect: ה-Redirect שיחול על ProcessBuilder.
command	‫List: List שמכיל את פקודת המערכת שצוינה, ואופציונלית ארגומנטים להרצה

החזרות
Process	הפקודה Process שהופעלה

הקפצת הודעות שגיאה (throw)
IOException	אם הפקודה לא פעלה

runCmdInBackground

public abstract Process runCmdInBackground (ProcessBuilder.Redirect redirect, 
                String... command)

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

הפקודה תחזיר ערך מיד אחרי ההפעלה.

פרמטרים
redirect	ProcessBuilder.Redirect: ה-Redirect שיחול על ProcessBuilder.
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
Process	הפקודה Process שהופעלה

הקפצת הודעות שגיאה (throw)
IOException	אם הפקודה לא פעלה

runCmdInBackground

public abstract Process runCmdInBackground (List<String> command)

שיטה חלופית runCmdInBackground(String...) שמקבלת את ארגומנטי הפקודה בפורמט List.

פרמטרים
command	‫List: List שמכיל את פקודת המערכת שצוינה, ואופציונלית ארגומנטים להרצה

החזרות
Process	הפקודה Process שהופעלה

הקפצת הודעות שגיאה (throw)
IOException	אם הפקודה לא פעלה

runCmdInBackground

public abstract Process runCmdInBackground (String... command)

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

הפקודה תחזיר ערך מיד אחרי ההפעלה.

פרמטרים
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
Process	הפקודה Process שהופעלה

הקפצת הודעות שגיאה (throw)
IOException	אם הפקודה לא פעלה

runCmdInBackground

public abstract Process runCmdInBackground (List<String> command, 
                OutputStream output)

הפעלת הפקודה עם OutputStream תרשום את הפלט של הפקודה. הפלט הרגיל והפלט של שגיאות מוזגו יחד.

פרמטרים
command	‫List: הפקודה להרצה
output	‫OutputStream: ה-OutputStream שבו שומרים את הפלט

החזרות
Process	המשתמש Process שמריץ את הפקודה

הקפצת הודעות שגיאה (throw)
	java.io.IOException
IOException

runEscalatingTimedRetry

public abstract boolean runEscalatingTimedRetry (long opTimeout, 
                long initialPollInterval, 
                long maxPollInterval, 
                long maxTime, 
                IRunUtil.IRunnableResult runnable)

חסימה וביצוע של פעולה כמה פעמים עד שהיא מצליחה.

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

פרמטרים
opTimeout	‫long: הזמן המקסימלי להמתנה באלפיות השנייה לניסיון בודד של פעולה
initialPollInterval	‫long: משך הזמן הראשוני להמתנה בין ניסיונות הפעולה
maxPollInterval	‫long: הזמן המקסימלי להמתנה בין ניסיונות הפעולה
maxTime	‫long: משך הזמן הכולל המקסימלי המשוער לניסיון חוזר של הפעולה
runnable	IRunUtil.IRunnableResult: IRunUtil.IRunnableResult להפעלה

החזרות
boolean	‫true אם הפעולה הושלמה בהצלחה לפני שחלף הזמן המקסימלי

runFixedTimedRetry

public abstract boolean runFixedTimedRetry (long opTimeout, 
                long pollInterval, 
                long maxTime, 
                IRunUtil.IRunnableResult runnable)

חסימה וביצוע של פעולה כמה פעמים עד שהיא מצליחה.

פרמטרים
opTimeout	‫long: הזמן המקסימלי להמתנה באלפיות השנייה לניסיון בודד של פעולה
pollInterval	‫long: משך הזמן הראשוני להמתנה בין ניסיונות הפעולה
maxTime	‫long: משך הזמן הכולל המקסימלי המשוער לניסיון חוזר של הפעולה
runnable	IRunUtil.IRunnableResult: IRunUtil.IRunnableResult להפעלה

החזרות
boolean	‫true אם הפעולה הושלמה בהצלחה לפני שחלף הזמן המקסימלי

runFixedTimedRetryWithOutputMonitor

public abstract boolean runFixedTimedRetryWithOutputMonitor (long opTimeout, 
                long idleOutputTimeout, 
                long pollInterval, 
                long maxTime, 
                IRunUtil.IRunnableResult runnable)

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

פרמטרים
opTimeout	‫long: הזמן המקסימלי להמתנה באלפיות השנייה לניסיון בודד של פעולה
idleOutputTimeout	‫long: משך הזמן המקסימלי להמתנה באלפיות השנייה לפלט בזרמי הפלט
pollInterval	‫long: משך הזמן הראשוני להמתנה בין ניסיונות הפעולה
maxTime	‫long: משך הזמן הכולל המקסימלי המשוער לניסיון חוזר של הפעולה
runnable	IRunUtil.IRunnableResult: IRunUtil.IRunnableResult להפעלה

החזרות
boolean	‫true אם הפעולה הושלמה בהצלחה לפני שחלף הזמן המקסימלי

runTimed

public abstract CommandStatus runTimed (long timeout, 
                IRunUtil.IRunnableResult runnable, 
                boolean logErrors)

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

פרמטרים
timeout	‫long: זמן ההמתנה המקסימלי במילישניות
runnable	IRunUtil.IRunnableResult: IRunUtil.IRunnableResult להפעלה
logErrors	‫boolean: רישום שגיאות ביומן במקרה של חריגה או לא.

החזרות
CommandStatus	התוצאה של הפעולה CommandStatus.

runTimedCmd

public abstract CommandResult runTimedCmd (long timeout, 
                String... command)

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

פרמטרים
timeout	‫long: הזמן המקסימלי להמתנה באלפיות השנייה. 0 מציין שאין זמן קצוב לתפוגה.
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmd

public abstract CommandResult runTimedCmd (long timeout, 
                OutputStream stdout, 
                OutputStream stderr, 
                String... command)

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

פרמטרים
timeout	‫long: זמן קצוב לתפוגה, הזמן המקסימלי להמתנה באלפיות השנייה. 0 מציין שאין זמן קצוב לתפוגה.
stdout	‫OutputStream: OutputStream לאן הפלט הרגיל יופנה. יכול להיות null.
stderr	‫OutputStream: OutputStream לאן יופנה פלט השגיאה. יכול להיות null.
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdRetry

public abstract CommandResult runTimedCmdRetry (long timeout, 
                long retryInterval, 
                int attempts, 
                String... command)

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

פרמטרים
timeout	‫long: משך ההמתנה המקסימלי באלפיות השנייה לכל ניסיון
retryInterval	‫long: משך הזמן להמתנה בין ניסיונות חוזרים של פקודה
attempts	‫int: המספר המקסימלי של ניסיונות
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdRetryWithOutputMonitor

public abstract CommandResult runTimedCmdRetryWithOutputMonitor (long timeout, 
                long idleOutputTimeout, 
                long retryInterval, 
                int attempts, 
                String... command)

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

פרמטרים
timeout	‫long: משך ההמתנה המקסימלי באלפיות השנייה לכל ניסיון
idleOutputTimeout	‫long: משך הזמן המקסימלי להמתנה באלפיות השנייה לפלט בזרמי הפלט
retryInterval	‫long: משך הזמן להמתנה בין ניסיונות חוזרים של פקודה
attempts	‫int: המספר המקסימלי של ניסיונות
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdSilently

public abstract CommandResult runTimedCmdSilently (long timeout, 
                String... command)

שיטת עזר להרצת פקודה במערכת, וביטול אם הפקודה נמשכת יותר מזמן מוגדר. דומה ל-runTimedCmd(long,String...), אבל לא מתעד שגיאות בחריג.

פרמטרים
timeout	‫long: זמן ההמתנה המקסימלי במילישניות
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdSilentlyRetry

public abstract CommandResult runTimedCmdSilentlyRetry (long timeout, 
                long retryInterval, 
                int attempts, 
                String... command)

שיטת עזר להרצת פקודה במערכת, וביטול אם הפקודה נמשכת יותר מזמן מוגדר. דומה ל-runTimedCmdRetry(long,long,int,String[]), אבל לא מתעד שגיאות בחריג.

פרמטרים
timeout	‫long: זמן ההמתנה המקסימלי במילישניות
retryInterval	‫long: משך הזמן להמתנה בין ניסיונות חוזרים של פקודה
attempts	‫int: המספר המקסימלי של ניסיונות
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdWithInput

public abstract CommandResult runTimedCmdWithInput (long timeout, 
                String input, 
                String... command)

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

פרמטרים
timeout	‫long: זמן ההמתנה המקסימלי במילישניות
input	‫String: קלט stdin להעברה לתהליך
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdWithInput

public abstract CommandResult runTimedCmdWithInput (long timeout, 
                String input, 
                List<String> command)

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

פרמטרים
timeout	‫long: זמן ההמתנה המקסימלי במילישניות
input	‫String: קלט stdin להעברה לתהליך
command	‫List: List שמכיל את פקודת המערכת ואופציונלית את הארגומנטים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdWithInput

public abstract CommandResult runTimedCmdWithInput (long timeout, 
                String input, 
                File stdoutFile, 
                File stderrFile, 
                String... command)

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

פרמטרים
timeout	‫long: זמן קצוב לתפוגה, הזמן המקסימלי להמתנה באלפיות השנייה. 0 מציין שאין זמן קצוב לתפוגה.
input	‫String: קלט stdin להעברה לתהליך
stdoutFile	‫File: File לאן הפלט הרגיל יופנה. יכול להיות null.
stderrFile	‫File: File לאן יופנה פלט השגיאה. יכול להיות null.
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdWithInputRedirect

public abstract CommandResult runTimedCmdWithInputRedirect (long timeout, 
                File inputRedirect, 
                String... command)

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

פרמטרים
timeout	‫long: זמן ההמתנה המקסימלי במילישניות
inputRedirect	‫File: File להפניה אוטומטית כקלט רגיל באמצעות ProcessBuilder.redirectInput(). אם הערך הוא null, לא תתבצע הפניה אוטומטית של stdin.
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdWithOutputMonitor

public abstract CommandResult runTimedCmdWithOutputMonitor (long timeout, 
                long idleOutputTimeout, 
                String... command)

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

פרמטרים
timeout	‫long: הזמן המקסימלי להמתנה באלפיות השנייה. 0 מציין שאין זמן קצוב לתפוגה.
idleOutputTimeout	‫long: משך הזמן המקסימלי להמתנה באלפיות השנייה לפלט בזרמי הפלט
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedCmdWithOutputMonitor

public abstract CommandResult runTimedCmdWithOutputMonitor (long timeout, 
                long idleOutputTimeout, 
                OutputStream stdout, 
                OutputStream stderr, 
                String... command)

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

פרמטרים
timeout	‫long: זמן קצוב לתפוגה, הזמן המקסימלי להמתנה באלפיות השנייה. 0 מציין שאין זמן קצוב לתפוגה.
idleOutputTimeout	‫long: משך הזמן המקסימלי להמתנה באלפיות השנייה לפלט בזרמי הפלט
stdout	‫OutputStream: OutputStream לאן הפלט הרגיל יופנה. יכול להיות null.
stderr	‫OutputStream: OutputStream לאן יופנה פלט השגיאה. יכול להיות null.
command	‫String: פקודת המערכת שצוינה, וארגומנטים אופציונליים להרצה

החזרות
CommandResult	‫CommandResult שמכיל את התוצאה מהרצת הפקודה

runTimedRetry

public abstract boolean runTimedRetry (long opTimeout, 
                long pollInterval, 
                int attempts, 
                IRunUtil.IRunnableResult runnable)

חסימה וביצוע של פעולה כמה פעמים עד שהיא מצליחה.

פרמטרים
opTimeout	‫long: הזמן המקסימלי להמתנה באלפיות השנייה לניסיון אחד של פעולה
pollInterval	‫long: משך הזמן להמתנה בין ניסיונות חוזרים של פקודה
attempts	‫int: המספר המקסימלי של ניסיונות
runnable	IRunUtil.IRunnableResult: IRunUtil.IRunnableResult להפעלה

החזרות
boolean	‫true אם הפעולה הושלמה בהצלחה לפני שהניסיונות הגיעו.

runTimedRetryWithOutputMonitor

public abstract boolean runTimedRetryWithOutputMonitor (long opTimeout, 
                long idleOutputTimeout, 
                long pollInterval, 
                int attempts, 
                IRunUtil.IRunnableResult runnable)

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

פרמטרים
opTimeout	‫long: הזמן המקסימלי להמתנה באלפיות השנייה לניסיון אחד של פעולה
idleOutputTimeout	‫long: משך הזמן המקסימלי להמתנה באלפיות השנייה לפלט בזרמי הפלט
pollInterval	‫long: משך הזמן להמתנה בין ניסיונות חוזרים של פקודה
attempts	‫int: המספר המקסימלי של ניסיונות
runnable	IRunUtil.IRunnableResult: IRunUtil.IRunnableResult להפעלה

החזרות
boolean	‫true אם הפעולה הושלמה בהצלחה לפני שהניסיונות הגיעו.

runTimedWithOutputMonitor

public abstract CommandStatus runTimedWithOutputMonitor (long timeout, 
                long idleOutputTimeout, 
                IRunUtil.IRunnableResult runnable, 
                boolean logErrors)

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

פרמטרים
timeout	‫long: זמן ההמתנה המקסימלי במילישניות
idleOutputTimeout	‫long: משך הזמן המקסימלי להמתנה באלפיות השנייה לפלט בזרמי הפלט
runnable	IRunUtil.IRunnableResult: IRunUtil.IRunnableResult להפעלה
logErrors	‫boolean: רישום שגיאות ביומן במקרה של חריגה או לא.

החזרות
CommandStatus	התוצאה של הפעולה CommandStatus.

setEnvVariable

public abstract void setEnvVariable (String key, 
                String value)

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

פרמטרים
key	‫String: שם המשתנה
value	‫String: ערך המשתנה

מידע נוסף:

• ProcessBuilder.environment()

setEnvVariablePriority

public abstract void setEnvVariablePriority (IRunUtil.EnvPriority priority)

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

פרמטרים
priority	IRunUtil.EnvPriority

setInterruptibleInFuture

public abstract void setInterruptibleInFuture (Thread thread, 
                long timeMs)

הגדרה כהודעה שניתן להפסיק אחרי פרק זמן מסוים. ‫ERROR(/CommandScheduler#shutdownHard()) כדי לאכוף את סיום התהליך בסופו של דבר.

פרמטרים
thread	‫Thread: השרשור שניתן להפריע לו.
timeMs	‫long: משך הזמן להמתנה לפני הגדרת האפשרות להפרעה.

setLinuxInterruptProcess

public abstract void setLinuxInterruptProcess (boolean interrupt)

הגדרה שמאפשרת להשתמש בהפרעה 'kill' של Linux בתהליך שמופעל באמצעות שיטות ‎ #runTimed כשהוא מגיע לזמן קצוב לתפוגה. אי אפשר להשתמש בהן במופע ברירת המחדל של IRunUtil.

פרמטרים
interrupt	boolean

setRedirectStderrToStdout

public abstract void setRedirectStderrToStdout (boolean redirect)

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

פרמטרים
redirect	boolean: ערך חדש שקובע אם לבצע הפניה או לא

מידע נוסף:

• ProcessBuilder.redirectErrorStream(boolean)

setWorkingDir

public abstract void setWorkingDir (File dir)

הגדרת ספריית העבודה לפקודות המערכת.

פרמטרים
dir	‫File: ספריית העבודה

מידע נוסף:

• ProcessBuilder.directory(File)

שינה

public abstract void sleep (long time)

שיטת עזר להשהיה למשך זמן נתון, תוך התעלמות מחריגים.

פרמטרים
time	‫long: אלפיות השנייה של זמן ההמתנה. ערכים שקטנים מ-0 או שווים לו יתעלמו

unsetEnvVariable

public abstract void unsetEnvVariable (String key)

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

פרמטרים
key	‫String: שם המשתנה

מידע נוסף:

• ProcessBuilder.environment()