#include <pipechan.h>
Inheritance diagram for PPipeChannel:
Construction | |
enum | OpenMode { ReadOnly, WriteOnly, ReadWrite, ReadWriteStd } |
Channel mode for the pipe to the sub-process. More... | |
PPipeChannel () | |
PPipeChannel (const PString &subProgram, OpenMode mode=ReadWrite, BOOL searchPath=TRUE, BOOL stderrSeparate=FALSE) | |
PPipeChannel (const PString &subProgram, const PStringArray &argumentList, OpenMode mode=ReadWrite, BOOL searchPath=TRUE, BOOL stderrSeparate=FALSE) | |
PPipeChannel (const PString &subProgram, const PStringToString &environment, OpenMode mode=ReadWrite, BOOL searchPath=TRUE, BOOL stderrSeparate=FALSE) | |
PPipeChannel (const PString &subProgram, const PStringArray &argumentList, const PStringToString &environment, OpenMode mode=ReadWrite, BOOL searchPath=TRUE, BOOL stderrSeparate=FALSE) | |
~PPipeChannel () | |
Close the pipe channel, killing the sub-process. | |
New member functions | |
BOOL | Open (const PString &subProgram, OpenMode mode=ReadWrite, BOOL searchPath=TRUE, BOOL stderrSeparate=FALSE) |
BOOL | Open (const PString &subProgram, const PStringArray &argumentList, OpenMode mode=ReadWrite, BOOL searchPath=TRUE, BOOL stderrSeparate=FALSE) |
BOOL | Open (const PString &subProgram, const PStringToString &environment, OpenMode mode=ReadWrite, BOOL searchPath=TRUE, BOOL stderrSeparate=FALSE) |
BOOL | Open (const PString &subProgram, const PStringArray &argumentList, const PStringToString &environment, OpenMode mode=ReadWrite, BOOL searchPath=TRUE, BOOL stderrSeparate=FALSE) |
const PFilePath & | GetSubProgram () const |
BOOL | Execute () |
BOOL | IsRunning () const |
int | GetReturnCode () const |
int | WaitForTermination () |
int | WaitForTermination (const PTimeInterval &timeout) |
BOOL | Kill (int signal=9) |
BOOL | ReadStandardError (PString &errors, BOOL wait=FALSE) |
BOOL | CanReadAndWrite () |
Public Types | |
Public Member Functions | |
Overrides from class PObject | |
Comparison | Compare (const PObject &obj) const |
Overrides from class PChannel | |
virtual PString | GetName () const |
virtual BOOL | Read (void *buf, PINDEX len) |
virtual BOOL | Write (const void *buf, PINDEX len) |
virtual BOOL | Close () |
Protected Attributes | |
PFilePath | subProgName |
The fully qualified path name for the sub-program executable. | |
int | toChildPipe [2] |
int | fromChildPipe [2] |
int | stderrChildPipe [2] |
int | childPid |
int | retVal |
Where full multi-processing is not supported then the sub-program is run with its input supplied from, or output captured to, a disk file. The current process is then suspended during the execution of the sub-program. In the latter case the semantics of the Execute()# and Close()# functions change from the usual for channels.
Note that for platforms that do not support multi-processing, the current process is suspended until the sub-program terminates. The input and output of the sub-program is transferred via a temporary file. The exact moment of execution of the sub-program depends on the mode. If mode is ReadOnly# then it is executed immediately and its output captured. In WriteOnly# mode the sub-program is run when the Close()# function is called, or when the pipe channel is destroyed. In ReadWrite# mode the sub-program is run when the Execute()# function is called indicating that the output from the current process to the sub-program has completed and input is now desired.
The CanReadAndWrite()# function effectively determines whether full multi-processing is supported by the platform. Note that this is different to whether { multi-threading} is supported.
|
|
Create a new pipe channel. |
|
Create a new pipe channel. This executes the subProgram and transfers data from its stdin/stdout/stderr. See the #Open()# function for details of various parameters.
|
|
Create a new pipe channel. This executes the subProgram and transfers data from its stdin/stdout/stderr. See the #Open()# function for details of various parameters.
|
|
Create a new pipe channel. This executes the subProgram and transfers data from its stdin/stdout/stderr. See the #Open()# function for details of various parameters.
|
|
Create a new pipe channel. This executes the subProgram and transfers data from its stdin/stdout/stderr. See the #Open()# function for details of various parameters.
|
|
Close the pipe channel, killing the sub-process.
|
|
Determine if the platform can support simultaneous read and writes from the PPipeChannel (eg MSDOS returns FALSE, Unix returns TRUE).
|
|
Close the channel. This will kill the sub-program's process (on platforms where that is relevent). For WriteOnly# or ReadWrite# mode pipe channels on platforms that do no support concurrent multi-processing and have not yet called the Execute()# function this will run the sub-program. Reimplemented from PChannel. |
|
Determine if the two objects refer to the same pipe channel. This actually compares the sub-program names that are passed into the constructor.
Reimplemented from PChannel. |
|
Start execution of sub-program for platforms that do not support multi-processing, this will actually run the sub-program passing all data written to the PPipeChannel. For platforms that do support concurrent multi-processing this will close the pipe from the current process to the sub-process. As the sub-program is run immediately and concurrently, this will just give an end of file to the stdin of the remote process. This is often necessary.
|
|
Get the name of the channel.
Reimplemented from PChannel. |
|
Get the return code from the most recent Close;
|
|
Get the full file path for the sub-programs executable file.
|
|
Determine if the program associated with the PPipeChannel is still executing. This is useful for determining the status of PPipeChannels which take a long time to execute on operating systems which support concurrent multi-processing.
|
|
This function will terminate the sub-program using the signal code specified.
|
|
Open a new pipe channel allowing the subProgram to be executed and data transferred from its stdin/stdout/stderr. If the mode is ReadOnly# then the #stdout# of the sub-program is supplied via the #Read()# calls of the PPipeChannel. The sub-programs input is set to the platforms null device (eg /dev/nul). If mode is WriteOnly# then #Write()# calls of the PPipeChannel are suppied to the sub-programs #stdin# and its #stdout# is sent to the null device. If mode is ReadWrite# then both read and write actions can occur. The #subProgram# parameter may contain just the path of the program to be run or a program name and space separated arguments, similar to that provided to the platforms command processing shell. Which use of this parameter is determiend by whether arguments are passed via the #argumentPointers# or #argumentList# parameters. The #searchPath# parameter indicates that the system PATH for executables should be searched for the sub-program. If FALSE then only the explicit or implicit path contained in the #subProgram# parameter is searched for the executable. The #stderrSeparate# parameter indicates that the standard error stream is not included in line with the standard output stream. In this case, data in this stream must be read using the #ReadStandardError()# function. The #environment# parameter is a null terminated sequence of null terminated strings of the form name=value. If NULL is passed then the same invironment as calling process uses is passed to the child process.
|
|
Open a channel.
|
|
Open a channel.
|
|
Open a channel.
|
|
Low level read from the channel. This function may block until the requested number of characters were read or the read timeout was reached. The GetLastReadCount() function returns the actual number of bytes read. If there are no more characters available as the sub-program has stopped then the number of characters available is returned. This is similar to end of file for the PFile channel. The GetErrorCode() function should be consulted after Read() returns FALSE to determine what caused the failure.
Reimplemented from PChannel. |
|
Read all available data on the standard error stream of the sub-process. If the #wait# parameter is FALSE then only the text currently available is returned. If TRUE then the function blocks as long as necessary to get some number of bytes.
|
|
This function will block and wait for the sub-program to terminate. It will wait only for the specified amount of time.
|
|
This function will block and wait for the sub-program to terminate.
|
|
Low level write to the channel. This function will block until the requested number of characters are written or the write timeout is reached. The GetLastWriteCount() function returns the actual number of bytes written. If the sub-program has completed its run then this function will fail returning FALSE. The GetErrorCode() function should be consulted after Write() returns FALSE to determine what caused the failure.
Reimplemented from PChannel. |
|
|
|
|
|
|
|
|
|
The fully qualified path name for the sub-program executable.
|
|
|