![]() |
Kea 2.7.3
|
Implementation of the ProcessSpawn
class.
More...
Public Member Functions | |
ProcessSpawnImpl (const ProcessSpawn::SpawnMode mode, const std::string &executable, const ProcessArgs &args, const ProcessEnvVars &vars, const bool inherit_env) | |
Constructor. | |
~ProcessSpawnImpl () | |
Destructor. | |
void | clearState (const pid_t pid) |
Removes the status of the process with a specified PID. | |
std::string | getCommandLine () const |
Returns full command line, including arguments, for the process. | |
int | getExitStatus (const pid_t pid) const |
Returns exit status of the process. | |
bool | isAnyRunning () const |
Checks if any of the spawned processes is still running. | |
bool | isRunning (const pid_t pid) const |
Checks if the process is still running. | |
pid_t | spawn (bool dismiss) |
Spawn the new process. | |
Implementation of the ProcessSpawn
class.
This pimpl idiom is used by the ProcessSpawn
in this case to avoid exposing the internals of the implementation, such as custom handling of a SIGCHLD signal, and the conversion of the arguments of the executable from the STL container to the array.
This class is made noncopyable so that we don't have attempts to make multiple copies of an object. This avoid problems with multiple copies of objects for a single global resource such as the SIGCHLD signal handler. In addition making it noncopyable keeps the static check code from flagging the lack of a copy constructor as an issue.
Definition at line 75 of file process_spawn.cc.
isc::asiolink::ProcessSpawnImpl::ProcessSpawnImpl | ( | const ProcessSpawn::SpawnMode | mode, |
const std::string & | executable, | ||
const ProcessArgs & | args, | ||
const ProcessEnvVars & | vars, | ||
const bool | inherit_env ) |
Constructor.
mode | specifies synchronous or asynchronous mode. |
executable | A full path to the program to be executed. |
args | Arguments for the program to be executed. |
vars | Environment variables for the program to be executed. |
inherit_env | whether the spawned process will inherit the environment before adding 'vars' on top. |
Definition at line 250 of file process_spawn.cc.
isc::asiolink::ProcessSpawnImpl::~ProcessSpawnImpl | ( | ) |
Destructor.
Definition at line 306 of file process_spawn.cc.
void isc::asiolink::ProcessSpawnImpl::clearState | ( | const pid_t | pid | ) |
Removes the status of the process with a specified PID.
This method removes the status of the process with a specified PID. If the process is still running, the status is not removed and the exception is thrown.
pid | A process pid. |
Definition at line 465 of file process_spawn.cc.
References isc_throw, and isRunning().
std::string isc::asiolink::ProcessSpawnImpl::getCommandLine | ( | ) | const |
Returns full command line, including arguments, for the process.
Definition at line 314 of file process_spawn.cc.
int isc::asiolink::ProcessSpawnImpl::getExitStatus | ( | const pid_t | pid | ) | const |
Returns exit status of the process.
If the process is still running, the previous status is returned or 0, if the process is being ran for the first time.
pid | ID of the child process for which exit status should be returned. |
Definition at line 389 of file process_spawn.cc.
References isc_throw.
bool isc::asiolink::ProcessSpawnImpl::isAnyRunning | ( | ) | const |
Checks if any of the spawned processes is still running.
Definition at line 376 of file process_spawn.cc.
bool isc::asiolink::ProcessSpawnImpl::isRunning | ( | const pid_t | pid | ) | const |
Checks if the process is still running.
pid | ID of the child processes for which state should be checked. |
Definition at line 365 of file process_spawn.cc.
References isc_throw.
Referenced by clearState().
pid_t isc::asiolink::ProcessSpawnImpl::spawn | ( | bool | dismiss | ) |
Spawn the new process.
This method forks the current process and executes the specified binary with arguments within the child process.
The child process will return EXIT_FAILURE if the method was unable to start the executable, e.g. as a result of insufficient permissions or when the executable does not exist. If the process ends successfully the EXIT_SUCCESS is returned.
dismiss | The flag which indicated if the process status can be disregarded. |
ProcessSpawnError | if forking a current process failed. |
Definition at line 329 of file process_spawn.cc.
References isc::asiolink::ProcessSpawn::ASYNC, isc::asiolink::ProcessSpawn::getIOService(), isc_throw, and isc::asiolink::ProcessSpawn::SYNC.