stx::ExecPipeImpl Class Reference

Main library implementation (internal object). More...

Classes
struct	Stage
	Structure representing each stage in the pipe. More...
Public Member Functions
void	set_debug_level (enum ExecPipe::DebugLevel dl)
	Change the current debug level. The default is DL_ERROR.
void	set_debug_output (void(output)(const char line))
	Change output function for debug messages.
	ExecPipeImpl ()
	Create a new pipe implementation with zero reference counter.
unsigned int &	refs ()
	Return writable reference to counter.
void	input_source_write (const void *data, unsigned int datalen)
	Function called by PipeSource::write() to push data into the ring buffer.
void	stage_function_write (unsigned int st, const void *data, unsigned int datalen)
	Function called by PipeSource::write() to push data into the ring buffer.
void	run ()
	Run the configured pipe sequence and wait for all children processes to complete.
Input Selectors

void	set_input_fd (int fd)
	Assign an already opened file descriptor as input stream for the first exec stage.
void	set_input_file (const char *path)
	Assign a file as input stream source.
void	set_input_string (const std::string *input)
	Assign a std::string as input stream source.
void	set_input_source (PipeSource *source)
	Assign a PipeSource as input stream source.
Output Selectors

void	set_output_fd (int fd)
	Assign an already opened file descriptor as output stream for the last exec stage.
void	set_output_file (const char *path, int mode=0666)
	Assign a file as output stream destination.
void	set_output_string (std::string *output)
	Assign a std::string as output stream destination.
void	set_output_sink (PipeSink *sink)
	Assign a PipeSink as output stream destination.
Add Pipe Stages

unsigned int	size () const
	Return the number of pipe stages added.
void	add_exec (const char *prog)
	Add an exec() stage to the pipe with given arguments.
void	add_exec (const char prog, const char arg1)
	Add an exec() stage to the pipe with given arguments.
void	add_exec (const char prog, const char arg1, const char *arg2)
	Add an exec() stage to the pipe with given arguments.
void	add_exec (const char prog, const char arg1, const char arg2, const char arg3)
	Add an exec() stage to the pipe with given arguments.
void	add_exec (const std::vector< std::string > *args)
	Add an exec() stage to the pipe with given arguments.
void	add_execp (const char *prog)
	Add an execp() stage to the pipe with given arguments.
void	add_execp (const char prog, const char arg1)
	Add an execp() stage to the pipe with given arguments.
void	add_execp (const char prog, const char arg1, const char *arg2)
	Add an execp() stage to the pipe with given arguments.
void	add_execp (const char prog, const char arg1, const char arg2, const char arg3)
	Add an execp() stage to the pipe with given arguments.
void	add_execp (const std::vector< std::string > *args)
	Add an execp() stage to the pipe with given arguments.
void	add_exece (const char path, const std::vector< std::string > argsp, const std::vector< std::string > *envp)
	Add an exece() stage to the pipe with the given arguments and environments.
void	add_function (PipeFunction *func)
	Add a function stage to the pipe.
Inspect Return Codes

int	get_return_status (unsigned int stageid) const
	Get the return status of exec() stage's program run after pipe execution as indicated by wait().
int	get_return_code (unsigned int stageid) const
	Get the return code of exec() stage's program run after pipe execution, or -1 if the program terminated abnormally.
int	get_return_signal (unsigned int stageid) const
	Get the signal of the abnormally terminated exec() stage's program run after pipe execution, or -1 if the program terminated normally.
bool	all_return_codes_zero () const
	Return true if the return code of all exec() stages were zero.
Protected Member Functions
void	exec_stage (const Stage &stage)
	Transform arguments and launch an exec stage using the correct exec() variant.
void	print_exec (const std::vector< std::string > &args)
	Print all arguments of exec() call.
void	sclose (int fd)
	Safe close() call and output error if fd was already closed.
Private Types
enum	StreamType { ST_NONE = 0, ST_FD, ST_FILE, ST_STRING, ST_OBJECT }
	Enumeration describing the currently set input or output stream type. More...
typedef std::vector< Stage >	stagelist_type
	typedef of list of pipe stages.
Private Attributes
unsigned int	m_refs
	reference counter
enum ExecPipe::DebugLevel	m_debug_level
	currently set debug level
void(*	m_debug_output )(const char *line)
	current debug line output function
StreamType	m_input
	describes the currently set input stream type
int	m_input_fd
	for ST_FD the input fd given by the user.
const char *	m_input_file
	for ST_FILE the path of the input file.
const std::string *	m_input_string
	for ST_STRING a pointer to the user-supplied std::string input stream object.
std::string::size_type	m_input_string_pos
	for ST_STRING the current position in the input stream object.
PipeSource *	m_input_source
	for ST_OBJECT the input stream source object
RingBuffer	m_input_rbuffer
	for ST_OBJECT the input stream ring buffer
StreamType	m_output
	describes the currently set input stream type
int	m_output_fd
	for ST_FD the output fd given by the user.
const char *	m_output_file
	for ST_FILE the path of the output file.
int	m_output_file_mode
	for ST_FILE the permission used in the open() call.
std::string *	m_output_string
	for ST_STRING a pointer to the user-supplied std::string output stream object.
PipeSink *	m_output_sink
	for ST_OBJECT the output stream source object
stagelist_type	m_stages
	list of pipe stages.
char	m_buffer [4096]
	general buffer used for read() and write() calls.

Detailed Description

Main library implementation (internal object).

Implementation class for stx::ExecPipe. See the documentation of the front-end class for detailed information.

Definition at line 258 of file stx-execpipe.cc.

Member Typedef Documentation

typedef std::vector<Stage> stx::ExecPipeImpl::stagelist_type [private]

typedef of list of pipe stages.

Definition at line 402 of file stx-execpipe.cc.

Member Enumeration Documentation

enum stx::ExecPipeImpl::StreamType [private]

Enumeration describing the currently set input or output stream type.

Enumerator:

ST_NONE	no special redirection requested
ST_FD	redirection to existing fd
ST_FILE	redirection to file path
ST_STRING	input/output directed by/to string
ST_OBJECT	input/output attached to program object

Definition at line 293 of file stx-execpipe.cc.

Constructor & Destructor Documentation

stx::ExecPipeImpl::ExecPipeImpl ( ) [inline]

Create a new pipe implementation with zero reference counter.

Definition at line 413 of file stx-execpipe.cc.

Member Function Documentation

void stx::ExecPipeImpl::add_exec ( const std::vector< std::string > * args ) [inline]

Add an exec() stage to the pipe with given arguments.

The vector of arguments is not copied, so it must still exist when run() is called. Note that the program called is args[0].

Definition at line 632 of file stx-execpipe.cc.

void stx::ExecPipeImpl::add_exec	(	const char *	prog,
		const char *	arg1,
		const char *	arg2,
		const char *	arg3
	)			`[inline]`

Add an exec() stage to the pipe with given arguments.

Note that argv[0] is set to prog.

Definition at line 616 of file stx-execpipe.cc.

void stx::ExecPipeImpl::add_exec	(	const char *	prog,
		const char *	arg1,
		const char *	arg2
	)			`[inline]`

Add an exec() stage to the pipe with given arguments.

Note that argv[0] is set to prog.

Definition at line 602 of file stx-execpipe.cc.

void stx::ExecPipeImpl::add_exec	(	const char *	prog,
		const char *	arg1
	)			`[inline]`

Add an exec() stage to the pipe with given arguments.

Note that argv[0] is set to prog.

Definition at line 589 of file stx-execpipe.cc.

void stx::ExecPipeImpl::add_exec ( const char * prog ) [inline]

Add an exec() stage to the pipe with given arguments.

Note that argv[0] is set to prog.

Definition at line 577 of file stx-execpipe.cc.

void stx::ExecPipeImpl::add_exece	(	const char *	path,
		const std::vector< std::string > *	argsp,
		const std::vector< std::string > *	envp
	)			`[inline]`

Add an exece() stage to the pipe with the given arguments and environments.

This is the most flexible exec() call. The vector of arguments and environment variables is not copied, so it must still exist when run() is called. The env vector pointer may be NULL, the args vector must not be NULL. The args[0] is _not_ override with path, so you can fake program name calls.

Definition at line 731 of file stx-execpipe.cc.

void stx::ExecPipeImpl::add_execp ( const std::vector< std::string > * args ) [inline]