Package com.intellij.execution.process

Class KillableProcessHandler

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.execution.process.ProcessHandler

com.intellij.execution.process.BaseProcessHandler<java.lang.Process>

com.intellij.execution.process.BaseOSProcessHandler

com.intellij.execution.process.OSProcessHandler

com.intellij.execution.process.KillableProcessHandler

All Implemented Interfaces:

KillableProcess, TaskExecutor, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

ColoredProcessHandler, GitTextHandler.MyOSProcessHandler

public class KillableProcessHandler
extends OSProcessHandler
implements KillableProcess

This process handler supports the "soft-kill" feature (see KillableProcessHandler). At first "stop" button send SIGINT signal to process, if it still hangs user can terminate it recursively with SIGKILL signal.

Soft kill works on Unix, and also on Windows if a mediator process was used.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.execution.process.OSProcessHandler

OSProcessHandler.Silent

Nested classes/interfaces inherited from class com.intellij.execution.process.BaseOSProcessHandler

BaseOSProcessHandler.SimpleOutputReader

Field Summary

Fields inherited from class com.intellij.execution.process.BaseProcessHandler

myCharset, myCommandLine, myPresentableName, myProcess, myWaitFor

Fields inherited from class com.intellij.execution.process.ProcessHandler

SILENTLY_DESTROY_ON_CLOSE, TERMINATION_REQUESTED

Constructor Summary

Constructors

Constructor and Description
KillableProcessHandler(GeneralCommandLine commandLine)
KillableProcessHandler(GeneralCommandLine commandLine, boolean withMediator) Starts a process with a mediator when withMediator is set to true and the platform is Windows.
KillableProcessHandler(java.lang.Process process, java.lang.String commandLine) commandLine must not be not empty (for correct thread attribution in the stacktrace)
KillableProcessHandler(java.lang.Process process, java.lang.String commandLine, java.nio.charset.Charset charset) commandLine must not be not empty (for correct thread attribution in the stacktrace)
KillableProcessHandler(java.lang.Process process, java.lang.String commandLine, java.nio.charset.Charset charset, java.util.Set<? extends java.io.File> filesToDelete) commandLine must not be not empty (for correct thread attribution in the stacktrace)

Method Summary

Modifier and Type	Method and Description
boolean	canKillProcess()
protected boolean	destroyProcessGracefully()
protected void	destroyProcessImpl() Performs process destruction.
protected void	doDestroyProcess()
void	killProcess()
protected static GeneralCommandLine	mediate(GeneralCommandLine commandLine, boolean withMediator, boolean showConsole)
protected void	notifyProcessTerminated(int exitCode)
void	setShouldKillProcessSoftly(boolean shouldKillProcessSoftly) Sets whether the process will be terminated gracefully.
void	setShouldKillProcessSoftlyWithWinP(boolean shouldKillProcessSoftlyWithWinP) Enables sending Ctrl+C to a Windows-process on first termination attempt.
boolean	shouldKillProcessSoftly()

Methods inherited from class com.intellij.execution.process.OSProcessHandler

checkEdtAndReadAction, deleteFileOnTermination, getDefaultModality, killProcessTree, onOSProcessTerminated, processCanBeKilledByOS, processHasSeparateErrorStream, readerOptions, setHasPty, setShouldDestroyProcessRecursively, shouldDestroyProcessRecursively, waitFor, waitFor

Methods inherited from class com.intellij.execution.process.BaseOSProcessHandler

createErrorDataReader, createOutputDataReader, createProcessErrReader, createProcessOutReader, executeOnPooledThread, executeTask, startNotify, toString

Methods inherited from class com.intellij.execution.process.BaseProcessHandler

closeStreams, detachIsDefault, detachProcessImpl, getCharset, getCommandLine, getProcess, getProcessInput

Methods inherited from class com.intellij.execution.process.ProcessHandler

addProcessListener, addProcessListener, destroyProcess, detachProcess, getExitCode, isProcessTerminated, isProcessTerminating, isSilentlyDestroyOnClose, isStartNotified, notifyProcessDetached, notifyTextAvailable, removeProcessListener

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KillableProcessHandler

public KillableProcessHandler(GeneralCommandLine commandLine)
                       throws ExecutionException

Throws:

ExecutionException

KillableProcessHandler

public KillableProcessHandler(GeneralCommandLine commandLine,
                              boolean withMediator)
                       throws ExecutionException

Starts a process with a mediator when withMediator is set to true and the platform is Windows.

Throws:

ExecutionException

KillableProcessHandler

public KillableProcessHandler(java.lang.Process process,
                              java.lang.String commandLine)

commandLine must not be not empty (for correct thread attribution in the stacktrace)

KillableProcessHandler

public KillableProcessHandler(java.lang.Process process,
                              java.lang.String commandLine,
                              java.nio.charset.Charset charset)

commandLine must not be not empty (for correct thread attribution in the stacktrace)

KillableProcessHandler

public KillableProcessHandler(java.lang.Process process,
                              java.lang.String commandLine,
                              java.nio.charset.Charset charset,
                              java.util.Set<? extends java.io.File> filesToDelete)

commandLine must not be not empty (for correct thread attribution in the stacktrace)

Method Detail

mediate

protected static GeneralCommandLine mediate(GeneralCommandLine commandLine,
                                            boolean withMediator,
                                            boolean showConsole)

shouldKillProcessSoftly

public boolean shouldKillProcessSoftly()

Returns:

true, if graceful process termination should be attempted first

setShouldKillProcessSoftly

public void setShouldKillProcessSoftly(boolean shouldKillProcessSoftly)

Sets whether the process will be terminated gracefully.

Parameters:

shouldKillProcessSoftly - true, if graceful process termination should be attempted first (i.e. soft kill)

destroyProcessImpl

protected void destroyProcessImpl()

Description copied from class: ProcessHandler

Performs process destruction.

This is an internal implementation of ProcessHandler.destroyProcess(). All sub-classes must implement this method and perform the destruction in this method. This method is called from ProcessHandler.destroyProcess() and it can be in any thread including the event dispatcher thread. You should avoid doing any expensive operation directly in this method. Instead, you may post the work to background thread and return without waiting for it. If the performed destruction led to process termination, ProcessHandler.notifyProcessTerminated(int) must be called in any thread (not necessary from this method).

Overrides:

destroyProcessImpl in class BaseProcessHandler<java.lang.Process>

notifyProcessTerminated

protected void notifyProcessTerminated(int exitCode)

Overrides:

notifyProcessTerminated in class ProcessHandler

doDestroyProcess

protected void doDestroyProcess()

Overrides:

doDestroyProcess in class OSProcessHandler

setShouldKillProcessSoftlyWithWinP

public void setShouldKillProcessSoftlyWithWinP(boolean shouldKillProcessSoftlyWithWinP)

Enables sending Ctrl+C to a Windows-process on first termination attempt. This is an experimental API which will be removed in future releases once stabilized. Please do not use this API.

Parameters:

shouldKillProcessSoftlyWithWinP - true to use

destroyProcessGracefully

protected boolean destroyProcessGracefully()

canKillProcess

public boolean canKillProcess()

Specified by:

canKillProcess in interface KillableProcess

killProcess

public void killProcess()

Specified by:

killProcess in interface KillableProcess