template<typenameC,typenameT>basic_pstreambuf<C,T>*redi::basic_pstreambuf<C,T>::close
Close the stream buffer and wait for the process to exit. Closes all pipes and calls wait() to wait for
the process to finish. If an error occurs the error code will be set to one of the possible errors for
waitpid(). See your system's documentation for these errors.
Returns
this on successful close or NULL if there is no process to close or if an error occurs.
template<typenameC,typenameT>boolredi::basic_pstreambuf<C,T>::empty_buffer[protected]
Writes buffered characters to the process' stdin pipe.
Returns
true if the buffer was emptied, false otherwise.
template<typenameC,typenameT>intredi::basic_pstreambuf<C,T>::error[inline]
Return the error number (errno) for the most recent failed operation.
Returns
The error code of the most recently failed operation, or zero.
template<typenameC,typenameT>boolredi::basic_pstreambuf<C,T>::exited[inline]
Report whether the process has exited. This function can call pstreambuf::wait() and so may change the
object's state if the child process has already exited.
Returns
True if the associated process has exited, false otherwise.
Seealsobasic_pstreambuf<C,T>::wait()template<typenameC,typenameT>boolredi::basic_pstreambuf<C,T>::fill_buffer(boolnon_blocking=false)[protected]Returns
true if the buffer was filled, false otherwise.
template<typenameC,typenameT>pid_tredi::basic_pstreambuf<C,T>::fork(pmodemode)[protected]
Initialise pipes and fork process. Creates pipes as specified by mode and calls fork()tocreateanewprocess.Iftheforkissuccessfultheparentprocessstoresthechild'sPIDandtheopenedpipesandthechildprocessreplacesitsstandardstreamswiththeopenedpipes.
If an error occurs the error code will be set to one of the possible errors for pipe() or fork().Seeyoursystem'sdocumentationfortheseerrorcodes.Parametersmode an OR of pmodes specifying which of the child's standard streams to connect to.
Returns
On success the PID of the child is returned in the parent's context and zero is returned in the
child's context. On error -1 is returned and the error code is set appropriately.
template<typenameC,typenameT>boolredi::basic_pstreambuf<C,T>::is_open[inline]
Report whether the stream buffer has been initialised. Unlike pstreambuf::exited(), this function will
not call wait() and so will not change the object's state. This means that once a child process is
executed successfully this function will continue to return true even after the process exits (until
wait() is called.)
Returns
true if a previous call to open() succeeded and wait() has not been called and determined that the
process has exited, false otherwise.
template<typenameC,typenameT>basic_pstreambuf<C,T>*redi::basic_pstreambuf<C,T>::kill(intsignal=SIGTERM)[inline]
Send a signal to the process. Sends the specified signal to the process. A signal can be used to
terminate a child process that would not exit otherwise.
If an error occurs the error code will be set to one of the possible errors for kill().Seeyoursystem'sdocumentationfortheseerrors.Parameterssignal A signal to send to the child process.
Returns
this or NULL if kill()fails.template<typenameC,typenameT>basic_pstreambuf<C,T>*redi::basic_pstreambuf<C,T>::killpg(intsignal=SIGTERM)[inline]
Send a signal to the process' process group. Sends the specified signal to the process group of the child
process. A signal can be used to terminate a child process that would not exit otherwise, or to kill the
process and its own children.
If an error occurs the error code will be set to one of the possible errors for getpgid() or kill().Seeyoursystem'sdocumentationfortheseerrors.IfthechildisinthecurrentprocessgroupthenNULLwillbereturnedandtheerrorcodesettoEPERM.Parameterssignal A signal to send to the child process.
Returns
this on success or NULL on failure.
template<typenameC,typenameT>basic_pstreambuf<C,T>*redi::basic_pstreambuf<C,T>::open(conststd::string&command,pmodemode)
Initialise the stream buffer with cmd. Starts a new process by passing command to the shell (/bin/sh) and
opens pipes to the process with the specified mode.
If mode contains pstdout the initial read source will be the child process' stdout, otherwise if mode
contains pstderr the initial read source will be the child's stderr.
Will duplicate the actions of the shell in searching for an executable file if the specified file name
does not contain a slash (/) character.
Warning
There is no way to tell whether the shell command succeeded, this function will always succeed unless
resource limits (such as memory usage, or number of processes or open files) are exceeded. This means
is_open() will return true even if command cannot be executed. Use pstreambuf::open(conststd::string&,constargv_type&,pmode) if you need to know whether the command failed to execute.
Parameterscommand a string containing a shell command.
mode a bitwise OR of one or more of out, in, err.
Returns
NULL if the shell could not be started or the pipes could not be opened, this otherwise.
Seealsoexecl(3)
Referenced by redi::basic_pstreambuf< CharT, Traits >::basic_pstreambuf().
template<typenameC,typenameT>basic_pstreambuf<C,T>*redi::basic_pstreambuf<C,T>::open(conststd::string&file,constargv_type&argv,pmodemode)
Initialise the stream buffer with file and argv. Starts a new process by executing file with the
arguments in argv and opens pipes to the process with the specified mode.
By convention argv[0] should be the file name of the file being executed.
If mode contains pstdout the initial read source will be the child process' stdout, otherwise if mode
contains pstderr the initial read source will be the child's stderr.
Will duplicate the actions of the shell in searching for an executable file if the specified file name
does not contain a slash (/) character.
Iff file is successfully executed then is_open() will return true. Otherwise, pstreambuf::error() can be
used to obtain the value of errno that was set by execvp(3) in the child process.
The exit status of the new process will be returned by pstreambuf::status() after pstreambuf::exited()
returns true.
Parametersfile a string containing the pathname of a program to execute.
argv a vector of argument strings passed to the new program.
mode a bitwise OR of one or more of out, in and err.
Returns
NULL if a pipe could not be opened or if the program could not be executed, this otherwise.
Seealsoexecvp(3)
template<typenameC,typenameT>basic_pstreambuf<C,T>::int_typeredi::basic_pstreambuf<C,T>::overflow(int_typec)[protected]
Transfer characters to the pipe when character buffer overflows. Called when the internal character
buffer is not present or is full, to transfer the buffer contents to the pipe.
Parametersc a character to be written to the pipe.
Returns
traits_type::eof() if an error occurs, otherwise if c is not equal to traits_type::eof() it will be
buffered and a value other than traits_type::eof() returned to indicate success.
template<typenameC,typenameT>basic_pstreambuf<C,T>::int_typeredi::basic_pstreambuf<C,T>::pbackfail(int_typec=traits_type::eof())[protected]
Make a character available to be returned by the next extraction. Attempts to make c available as the
next character to be read by sgetc().
Parametersc a character to make available for extraction.
Returnsc if the character can be made available, traits_type::eof() otherwise.
template<typenameC,typenameT>voidredi::basic_pstreambuf<C,T>::peof[inline]
Close the pipe connected to the process' stdin. Closes the output pipe, causing the child process to
receive the end-of-file indicator on subsequent reads from its stdin stream.
Referenced by redi::basic_opstream< CharT, Traits >::peof().
template<typenameC,typenameT>basic_pstreambuf<C,T>::char_type*redi::basic_pstreambuf<C,T>::rbuffer[inline],[protected]
Return the active input buffer.
Returns
a pointer to the start of the active input buffer area.
template<typenameC,typenameT>std::streamsizeredi::basic_pstreambuf<C,T>::read(char_type*s,std::streamsizen)[inline],[protected]
Extract a sequence of characters from the pipe. Reads up to n characters from the pipe to the buffer s.
Parameterss character buffer.
n buffer length.
Returns
the number of characters read.
template<typenameC,typenameT>boolredi::basic_pstreambuf<C,T>::read_err(boolreaderr=true)[inline]
Change active input source. Toggle the stream used for reading. If readerr is true then the process'
stderr output will be used for subsequent extractions, if readerr is false the the process' stdout will
be used.
Parametersreaderr true to read stderr, false to read stdout.
Returns
true if the requested stream is open and will be used for subsequent extractions, false otherwise.
Referenced by redi::basic_ipstream< CharT, Traits >::err(), redi::basic_pstream< CharT, Traits >::err(),
redi::basic_rpstream< CharT, Traits >::err(), redi::basic_ipstream< CharT, Traits >::out(),
redi::basic_pstream< CharT, Traits >::out(), and redi::basic_rpstream< CharT, Traits >::out().
template<typenameC,typenameT>pstreams::fd_type&redi::basic_pstreambuf<C,T>::rpipe[inline],[protected]
Return the file descriptor for the active input pipe.
Returns
a reference to the active input file descriptor
template<typenameC,typenameT>pstreams::fd_type&redi::basic_pstreambuf<C,T>::rpipe(buf_read_srcwhich)[inline],[protected]
Return the file descriptor for the specified input pipe.
Returns
a reference to the specified input file descriptor
template<typenameC,typenameT>intredi::basic_pstreambuf<C,T>::status[inline]
Return the exit status of the process.
Returns
The exit status of the child process, or -1 if wait() has not yet been called to wait for the child
to exit.
Seealsobasic_pstreambuf<C,T>::wait()template<typenameC,typenameT>basic_pstreambuf<C,T>::int_typeredi::basic_pstreambuf<C,T>::underflow[protected]
Transfer characters from the pipe when the character buffer is empty. Called when the internal character
buffer is is empty, to re-fill it from the pipe.
Returns
The first available character in the buffer, or traits_type::eof() in case of failure.
template<typenameC,typenameT>intredi::basic_pstreambuf<C,T>::wait(boolnohang=false)[protected]
Wait for the child process to exit. Suspends execution and waits for the associated process to exit, or
until a signal is delivered whose action is to terminate the current process or to call a signal handling
function. If the process has already exited (i.e. it is a 'zombie' process) then wait() returns
immediately. Waiting for the child process causes all its system resources to be freed.
error() will return EINTR if wait() is interrupted by a signal.
Parametersnohang true to return immediately if the process has not exited.
Returns
1 if the process has exited and wait() has not yet been called. 0 if nohang is true and the process
has not exited yet. -1 if no process has been started or if an error occurs, in which case the error
can be found using error().
template<typenameC,typenameT>pstreams::fd_type&redi::basic_pstreambuf<C,T>::wpipe[inline],[protected]
Return the file descriptor for the output pipe.
Returns
a reference to the output file descriptor
template<typenameC,typenameT>std::streamsizeredi::basic_pstreambuf<C,T>::write(constchar_type*s,std::streamsizen)[inline],[protected]
Insert a sequence of characters into the pipe. Writes up to n characters to the pipe from the buffer s.
Parameterss character buffer.
n buffer length.
Returns
the number of characters written.
template<typenameC,typenameT>std::streamsizeredi::basic_pstreambuf<C,T>::xsputn(constchar_type*s,std::streamsizen)[protected]
Insert multiple characters into the pipe.
Parameterss character buffer.
n buffer length.
Returns
the number of characters written.
Install Now
PNG Icons
