SshProcess Class Reference

Executes a remote command, using ssh. More...

#include <ssh.h>

Inheritance diagram for SshProcess:

[legend]

List of all members.

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

---

Detailed Description

Executes a remote command, using ssh.

Definition at line 26 of file ssh.h.

---

Member Enumeration Documentation

enum SshProcess::Errors

Enumerator:

SshNotFound
SshNeedsPassword
SshIncorrectPassword

Definition at line 32 of file ssh.h.

---

Constructor & Destructor Documentation

SshProcess::SshProcess	(	const QCString &	host = 0,
		const QCString &	user = 0,
		const QCString &	command = 0
	)

Definition at line 42 of file ssh.cpp.

SshProcess::~SshProcess

(

)

Definition at line 52 of file ssh.cpp.

---

Member Function Documentation

int 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 63 of file ssh.cpp.

int 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 69 of file ssh.cpp.

QCString SshProcess::dcopServer

(

)

[protected, virtual]

See display.

Reimplemented from StubProcess.

Definition at line 273 of file ssh.cpp.

QCString 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 StubProcess.

Definition at line 260 of file ssh.cpp.

QCString SshProcess::displayAuth

(

)

[protected, virtual]

Definition at line 266 of file ssh.cpp.

QCString SshProcess::error

(

)

[inline]

Definition at line 65 of file ssh.h.

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

Executes the command.

Definition at line 75 of file ssh.cpp.

QCString SshProcess::prompt

(

)

[inline]

Definition at line 64 of file ssh.h.

void SshProcess::setHost

(

const QCString &

host

)

[inline]

Sets the target host.

Definition at line 37 of file ssh.h.

void SshProcess::setStub

(

const QCString &

stub

)

Sets the localtion of the remote stub.

Definition at line 57 of file ssh.cpp.

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

Reimplemented from StubProcess.

Definition at line 278 of file ssh.cpp.

---

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

• ssh.h
• ssh.cpp