softwarecontainer::CommandJob Class Reference

Use this class to execute a command line in a SoftwareContainer. More...

#include <commandjob.h>

Inheritance diagram for softwarecontainer::CommandJob:

Collaboration diagram for softwarecontainer::CommandJob:

Public Member Functions
	CommandJob (ExecutablePtr executable, const std::string &command)
bool	setWorkingDirectory (const std::string &folder)
bool	start ()
std::string	toString () const
void	captureStdin ()
void	setOutputFile (const std::string &path)
void	captureStdout ()
void	captureStderr ()
int	wait ()
int	stdout ()
int	stderr ()
int	stdin ()
pid_t	pid ()
bool	isSuccess ()
	Helper about return value of jobs. More...
bool	isError ()
	Helper about return value of jobs. More...
bool	isRunning ()
	That method always returns true as soon as the start() method has been called, even if the command fails to start, since we don't know if the exec() occurring after the fork into the container actually succeeds... More...
void	setEnvironmentVariable (const std::string &key, const std::string &value)
void	setEnvironmentVariables (const EnvironmentVariables &env)

Static Public Attributes
static constexpr int	UNASSIGNED_STREAM

Protected Types
typedef std::shared_ptr< Executable >	ExecutablePtr

Protected Member Functions
	LOG_DECLARE_CLASS_CONTEXT ("JOAB","JobAbstract")

Protected Attributes
EnvironmentVariables	m_env
ExecutablePtr	m_executable
int	m_exitStatus
pid_t	m_pid
int	m_stdin [2]
int	m_stdout [2]
int	m_stderr [2]

Detailed Description

Use this class to execute a command line in a SoftwareContainer.

Definition at line 29 of file commandjob.h.

Member Function Documentation

bool softwarecontainer::JobAbstract::isSuccess ( )

inherited

Helper about return value of jobs.

Describes whether the exit status of a command or a function indicates success or not

Note that this method will interpret exit status only for the last job

Definition at line 85 of file jobabstract.cpp.

{
    if (0 == m_exitStatus) {
        return true;
    }

    return false;
}

bool softwarecontainer::JobAbstract::isError ( )

inherited

Helper about return value of jobs.

Describes whether the exit status of a command or a function indicates error or not

Note that this method will interpret exit status only for the last job

Definition at line 94 of file jobabstract.cpp.

{
    return !isSuccess();
}

bool softwarecontainer::JobAbstract::isRunning ( )

inherited

That method always returns true as soon as the start() method has been called, even if the command fails to start, since we don't know if the exec() occurring after the fork into the container actually succeeds...

Definition at line 103 of file jobabstract.cpp.

{
    // TODO : find a way to test whether the exec() which occurs in the container succeeded
    return (m_pid != 0);
}

---

The documentation for this class was generated from the following files:

• libsoftwarecontainer/include/commandjob.h
• libsoftwarecontainer/src/jobs/commandjob.cpp