KIO

KIO::Slave

KIO::Slave Class Reference

#include <slave.h>

Inheritance diagram for KIO::Slave:

[legend]

List of all members.

Detailed Description

Definition at line 46 of file slave.h.


Public Slots
void	accept ()
void	gotInput ()
void	timeout ()
Signals
void	slaveDied (KIO::Slave *slave)
Public Member Functions
	Slave (const QString &protocol, QObject *parent=0)
virtual	~Slave ()
void	setPID (pid_t)
int	slave_pid ()
void	kill ()
bool	isAlive ()
virtual void	setHost (const QString &host, quint16 port, const QString &user, const QString &passwd)
void	resetHost ()
virtual void	setConfig (const MetaData &config)
QString	protocol ()
void	setProtocol (const QString &protocol)
QString	slaveProtocol ()
QString	host ()
quint16	port ()
QString	user ()
QString	passwd ()
virtual void	suspend ()
virtual void	resume ()
virtual bool	suspended ()
virtual void	send (int cmd, const QByteArray &arr=QByteArray())
virtual void	hold (const KUrl &url)
time_t	idleTime ()
void	setIdle ()
bool	isConnected ()
void	setConnected (bool c)
void	ref ()
void	deref ()
Static Public Member Functions
static Slave *	createSlave (const QString &protocol, const KUrl &url, int &error, QString &error_text)
static Slave *	holdSlave (const QString &protocol, const KUrl &url)

Constructor & Destructor Documentation

Slave::Slave	(	const QString &	protocol,
		QObject *	parent = `0`
	)			`[explicit]`

Definition at line 158 of file slave.cpp.

Slave::~Slave ( ) [virtual]

Definition at line 167 of file slave.cpp.

Member Function Documentation

void Slave::setPID ( pid_t pid )

Definition at line 253 of file slave.cpp.

int Slave::slave_pid ( )

Definition at line 259 of file slave.cpp.

void Slave::kill ( )

Force termination.

Definition at line 336 of file slave.cpp.

bool Slave::isAlive ( )

Returns:: true if the slave survived the last mission.

Definition at line 265 of file slave.cpp.

void Slave::setHost	(	const QString &	host,
		quint16	port,
		const QString &	user,
		const QString &	passwd
	)			`[virtual]`

Set host for url.

Parameters:

	host	to connect to.
	port	to connect to.
	user	to login as
	passwd	to login with

Reimplemented in KIO::DataSlave.

Definition at line 348 of file slave.cpp.

void Slave::resetHost ( )

Clear host info.

Definition at line 363 of file slave.cpp.

void Slave::setConfig ( const MetaData & config ) [virtual]

Configure slave.

Reimplemented in KIO::DataSlave.

Definition at line 369 of file slave.cpp.

QString Slave::protocol ( )

The protocol this slave handles.

Returns:: name of protocol handled by this slave, as seen by the user

Definition at line 173 of file slave.cpp.

void Slave::setProtocol ( const QString & protocol )

Definition at line 179 of file slave.cpp.

QString Slave::slaveProtocol ( )

The actual protocol used to handle the request.

This method will return a different protocol than the one obtained by using protocol() if a proxy-server is used for the given protocol. This usually means that this method will return "http" when the actuall request was to retrieve a resource from an "ftp" server by going through a proxy server.

Returns:: the actual protocol (io-slave) that handled the request

Definition at line 185 of file slave.cpp.

QString Slave::host ( )

Returns:: Host this slave is (was?) connected to

Definition at line 191 of file slave.cpp.

quint16 Slave::port ( )

Returns:: port this slave is (was?) connected to

Definition at line 197 of file slave.cpp.

QString Slave::user ( )

Returns:: User this slave is (was?) logged in as

Definition at line 203 of file slave.cpp.

QString Slave::passwd ( )

Returns:: Passwd used to log in

Definition at line 209 of file slave.cpp.

Slave * Slave::createSlave	(	const QString &	protocol,
		const KUrl &	url,
		int &	error,
		QString &	error_text
	)			`[static]`

Creates a new slave.

Parameters:

	protocol	the protocol
	url	is the url
	error	is the error code on failure and undefined else.
	error_text	is the error text on failure and undefined else.

Returns:: 0 on failure, or a pointer to a slave otherwise.

Definition at line 378 of file slave.cpp.

Slave * Slave::holdSlave	(	const QString &	protocol,
		const KUrl &	url
	)			`[static]`

Definition at line 450 of file slave.cpp.

void Slave::suspend ( ) [virtual]

Suspends the operation of the attached kioslave.

Reimplemented in KIO::DataSlave.

Definition at line 291 of file slave.cpp.

void Slave::resume ( ) [virtual]

Resumes the operation of the attached kioslave.

Reimplemented in KIO::DataSlave.

Definition at line 297 of file slave.cpp.

bool Slave::suspended ( ) [virtual]

Tells wether the kioslave is suspended.

Returns:: true if the kioslave is suspended.

Reimplemented in KIO::DataSlave.

Definition at line 303 of file slave.cpp.

void Slave::send	(	int	cmd,
		const QByteArray &	arr = `QByteArray()`
	)			`[virtual]`

Sends the given command to the kioslave.

Parameters:

	cmd	command id
	arr	byte array containing data

Reimplemented in KIO::DataSlave.

Definition at line 309 of file slave.cpp.

void Slave::hold ( const KUrl & url ) [virtual]

Puts the kioslave associated with url at halt.

Reimplemented in KIO::DataSlave.

Definition at line 271 of file slave.cpp.

time_t Slave::idleTime ( )

Returns:: The time this slave has been idle.

Definition at line 247 of file slave.cpp.

void Slave::setIdle ( )

Marks this slave as idle.

Definition at line 215 of file slave.cpp.

bool Slave::isConnected ( )

Definition at line 221 of file slave.cpp.

void Slave::setConnected ( bool c )

Definition at line 227 of file slave.cpp.

void Slave::ref ( )

Definition at line 233 of file slave.cpp.

void Slave::deref ( )

Definition at line 239 of file slave.cpp.

void Slave::accept ( ) [slot]

Definition at line 115 of file slave.cpp.

void Slave::gotInput ( ) [slot]

Definition at line 315 of file slave.cpp.

void Slave::timeout ( ) [slot]

Definition at line 125 of file slave.cpp.

void KIO::Slave::slaveDied ( KIO::Slave * slave ) [signal]

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

KIO

KIO::Slave Class Reference

Detailed Description

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

KIO

kdelibs