KDESu::PtyProcess Class
Synchronous communication with tty programs. More...
| Header: | #include <KDESu/PtyProcess> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS Su)target_link_libraries(mytarget PRIVATE KF6::Su) |
| Inherited By: |
Public Types
| enum | checkPidStatus { Error, NotExited, Killed } |
Public Functions
| int | enableLocalEcho(bool enable = true) |
| int | exec(const QByteArray &command, const QList<QByteArray> &args) |
| int | fd() const |
| int | pid() const |
| QByteArray | readAll(bool block = true) |
| QByteArray | readLine(bool block = true) |
| void | setEnvironment(const QList<QByteArray> &env) |
| void | setErase(bool erase) |
| void | setExitString(const QByteArray &exit) |
| void | setTerminal(bool terminal) |
| void | unreadLine(const QByteArray &line, bool addNewline = true) |
| int | waitForChild() |
| int | waitSlave() |
| void | writeLine(const QByteArray &line, bool addNewline = true) |
Static Public Members
| bool | checkPid(pid_t pid) |
| int | checkPidExited(pid_t pid) |
| int | waitMS(int fd, int ms) |
Protected Functions
| QList<QByteArray> | environment() const |
Detailed Description
PtyProcess provides synchronous communication with tty based programs. The communications channel used is a pseudo tty (as opposed to a pipe) This means that programs which require a terminal will work.
Member Type Documentation
enum PtyProcess::checkPidStatus
Error return values for checkPidExited()
| Constant | Value | Description |
|---|---|---|
KDESu::PtyProcess::Error | -1 | No child |
KDESu::PtyProcess::NotExited | -2 | Child hasn't exited |
KDESu::PtyProcess::Killed | -3 | Child terminated by signal |
Member Function Documentation
[static] bool PtyProcess::checkPid(pid_t pid)
Basic check for the existence of pid.
Returns true iff pid is an extant process, (one you could kill - see man kill(2) for signal 0).
[static] int PtyProcess::checkPidExited(pid_t pid)
Check process exit status for process pid.
If child pid has exited, return its exit status, (which may be zero).
On error (no child, no exit), return -1.
If child has not exited, return -2.
int PtyProcess::enableLocalEcho(bool enable = true)
Enables/disables local echo on the pseudo tty.
[protected] QList<QByteArray> PtyProcess::environment() const
Returns the additional environment variables set by setEnvironment()
See also setEnvironment().
int PtyProcess::exec(const QByteArray &command, const QList<QByteArray> &args)
Forks off and execute a command.
The command's standard in and output are connected to the pseudo tty. They are accessible with readLine and writeLine.
command The command to execute.
args The arguments to the command.
Returns 0 on success, -1 on error. errno might give more information then.
int PtyProcess::fd() const
Returns the filedescriptor of the process.
int PtyProcess::pid() const
Returns the pid of the process.
QByteArray PtyProcess::readAll(bool block = true)
Read all available output from the program's standard out.
block If no output is in the buffer, should the function block (else it will return an empty QByteArray)?
Returns the output.
QByteArray PtyProcess::readLine(bool block = true)
Reads a line from the program's standard out. Depending on the block parameter, this call blocks until something was read.
Note that in some situations this function will return less than a full line of output, but never more. Newline characters are stripped.
block Block until a full line is read?
Returns the output string.
void PtyProcess::setEnvironment(const QList<QByteArray> &env)
Set additinal environment variables.
See also environment().
void PtyProcess::setErase(bool erase)
Overwrites the password as soon as it is used. Relevant only to some subclasses.
void PtyProcess::setExitString(const QByteArray &exit)
Sets the exit string. If a line of program output matches this, waitForChild() will terminate the program and return.
void PtyProcess::setTerminal(bool terminal)
Enables/disables terminal output. Relevant only to some subclasses.
void PtyProcess::unreadLine(const QByteArray &line, bool addNewline = true)
Puts back a line of input.
line The line to put back.
addNewline Adds a '\n' to the line.
int PtyProcess::waitForChild()
Waits for the child to exit. See also setExitString.
[static] int PtyProcess::waitMS(int fd, int ms)
Wait ms milliseconds (ie. 1/10th of a second is 100ms), using fd as a filedescriptor to wait on.
Returns select(2)'s result, which is -1 on error, 0 on timeout, or positive if there is data on one of the selected fd's.
ms must be in the range 0..999 (i.e. the maximum wait duration is 999ms, almost one second).
int PtyProcess::waitSlave()
Waits until the pty has cleared the ECHO flag. This is useful when programs write a password prompt before they disable ECHO. Disabling it might flush any input that was written.
void PtyProcess::writeLine(const QByteArray &line, bool addNewline = true)
Writes a line of text to the program's standard in.
line The text to write.
addNewline Adds a '\n' to the line.