Home · Modules · Classes · Namespaces · Functions

QxtSshProcess Class Reference
[QxtNetwork module]

The QxtSshProcess class allows communication with a process invoked on an SSH server More...

    #include <QxtSshProcess>

Inherits QxtSshChannel.

List of all members, including inherited members

Public Types

enum TerminalType { VanillaTerminal, Vt102Terminal, AnsiTerminal }

Public Functions

void requestPty ( TerminalType term = VanillaTerminal )
void start ( const QString & cmd )
void startShell ()

33 public functions inherited from QIODevice
29 public functions inherited from QObject

Signals

void finished ( int exitCode )
void started ()

1 signal inherited from QxtSshChannel
4 signals inherited from QIODevice
1 signal inherited from QObject

Additional Inherited Members

1 property inherited from QObject
1 public slot inherited from QObject
1 public type inherited from QObject
4 static public members inherited from QObject
5 protected functions inherited from QIODevice
7 protected functions inherited from QObject
2 protected variables inherited from QObject

Detailed Description

The QxtSshProcess class allows communication with a process invoked on an SSH server

QxtSshProcess is an I/O device analogous to QProcess. It can invoke a command or SSH subsystem on the SSH server; the stdin, stdout, and stderr channels of the process are redirected through the channel.

QxtSshProcess objects are created using the QxtSshClient::openProcessChannel() method.

Member Type Documentation

enum QxtSshProcess::TerminalType

Constant	Value	Description
`QxtSshProcess::VanillaTerminal`	`0`	A terminal with no special features
`QxtSshProcess::Vt102Terminal`	`1`	A terminal that understands VT102 command codes
`QxtSshProcess::AnsiTerminal`	`2`	A terminal that understands ANSI command codes

Member Function Documentation

void QxtSshProcess::finished ( int exitCode ) `[signal]`

This signal is emitted when the process on the SSH server finishes. The parameter is the exit code of the process. After the process has finished, the read buffer QxtSshProcess will still contain any data the process may have written before terminating.

Another process or subsystem may be invoked on the same channel after the first process terminates.

void QxtSshProcess::requestPty ( TerminalType term = VanillaTerminal )

Requests that a PTY be allocated for this channel on the remote host.

This function must be invoked before starting the process that requires it.

void QxtSshProcess::start ( const QString & cmd )

Invokes a shell command on the SSH server.

If there is already a process running on this channel, the behavior is undefined.

void QxtSshProcess::startShell ()

Starts a login shell on the SSH server.