KDESu::SshProcess Class Reference

#include <kdesu/ssh.h>

Inheritance diagram for KDESu::SshProcess:

List of all members.

Public Types
enum	Errors { SshNotFound = 1, SshNeedsPassword, SshIncorrectPassword }
Public Member Functions
	SshProcess (const QByteArray &host=QByteArray(), const QByteArray &user=QByteArray(), const QByteArray &command=QByteArray())
	~SshProcess ()
int	checkInstall (const char *password)
int	checkNeedPassword ()
QByteArray	error () const
int	exec (const char *password, int check=0)
QByteArray	prompt () const
void	setHost (const QByteArray &host)
void	setStub (const QByteArray &stub)
Protected Member Functions
virtual QByteArray	display ()
virtual QByteArray	displayAuth ()
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

Executes a remote command, using ssh.

---

Member Enumeration Documentation

enum KDESu::SshProcess::Errors

Enumerator:

SshNotFound
SshNeedsPassword
SshIncorrectPassword

Definition at line 32 of file ssh.h.

---

Constructor & Destructor Documentation

KDESu::SshProcess::SshProcess	(	const QByteArray &	host = QByteArray(),
		const QByteArray &	user = QByteArray(),
		const QByteArray &	command = QByteArray()
	)		[explicit]

Definition at line 57 of file ssh.cpp.

KDESu::SshProcess::~SshProcess

(

)

Definition at line 66 of file ssh.cpp.

---

Member Function Documentation

int KDESu::SshProcess::checkInstall

(

const char *

password

)

Checks if the stub is installed and if the password is correct.

Returns:

Zero if everything is correct, nonzero otherwise.

Definition at line 83 of file ssh.cpp.

int KDESu::SshProcess::checkNeedPassword

(

)

Checks if the current user@host needs a password.

Returns:

The prompt for the password if a password is required. A null string otherwise.

Todo:

The return doc is so obviously wrong that the C code needs to be checked.

Definition at line 89 of file ssh.cpp.

QByteArray KDESu::SshProcess::display

(

)

[protected, virtual]

This virtual function can be overloaded when special behavior is desired.

By default, it returns the value returned by KCookie.

Reimplemented from KDESu::StubProcess.

Definition at line 248 of file ssh.cpp.

QByteArray KDESu::SshProcess::displayAuth

(

)

[protected, virtual]

See display.

Reimplemented from KDESu::StubProcess.

Definition at line 254 of file ssh.cpp.

QByteArray KDESu::SshProcess::error

(

)

const

Definition at line 160 of file ssh.cpp.

int KDESu::SshProcess::exec	(	const char *	password,
		int	check = 0
	)

Executes the command.

Definition at line 95 of file ssh.cpp.

QByteArray KDESu::SshProcess::prompt

(

)

const

Definition at line 155 of file ssh.cpp.

void KDESu::SshProcess::setHost

(

const QByteArray &

host

)

Sets the target host.

Definition at line 71 of file ssh.cpp.

void KDESu::SshProcess::setStub

(

const QByteArray &

stub

)

Sets the localtion of the remote stub.

Definition at line 77 of file ssh.cpp.

void KDESu::SshProcess::virtual_hook	(	int	id,
		void *	data
	)		[protected, virtual]

Standard hack to add virtual methods in a BC way.

Unused.

Reimplemented from KDESu::StubProcess.

Definition at line 259 of file ssh.cpp.

---

The documentation for this class was generated from the following files:

• ssh.h
• ssh.cpp