• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kio/kio
 

kio/kio

  • KIO
  • Slave
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions
KIO::Slave Class Reference

#include <slave.h>

Inheritance diagram for KIO::Slave:
KIO::SlaveInterface KIO::DataSlave KIO::DataProtocol

List of all members.

Public Slots

void accept (KSocket *socket)
void gotInput ()
void timeout ()

Signals

void slaveDied (KIO::Slave *slave)

Public Member Functions

 Slave (KServerSocket *unixdomain, const TQString &protocol, const TQString &socketname)
void setPID (pid_t)
int slave_pid ()
void kill ()
bool isAlive ()
void setHost (const TQString &host, int port, const TQString &user, const TQString &passwd)
void resetHost ()
void setConfig (const MetaData &config)
TQString protocol ()
void setProtocol (const TQString &protocol)
TQString slaveProtocol ()
TQString host ()
int port ()
TQString user ()
TQString passwd ()
void suspend ()
void resume ()
bool suspended ()
void send (int cmd, const TQByteArray &data=TQByteArray())
void hold (const KURL &url)
time_t idleTime ()
void setIdle ()
bool isConnected ()
void setConnected (bool c)
KDE_DEPRECATED Connection * connection ()
void ref ()
void deref ()

Static Public Member Functions

static Slave * createSlave (const TQString &protocol, const KURL &url, int &error, TQString &error_text)
static Slave * holdSlave (const TQString &protocol, const KURL &url)

Protected Types

enum  {
  VIRTUAL_SUSPEND = 0x200, VIRTUAL_RESUME, VIRTUAL_SEND, VIRTUAL_HOLD,
  VIRTUAL_SUSPENDED, VIRTUAL_SET_HOST, VIRTUAL_SET_CONFIG
}

Protected Member Functions

 Slave (bool derived, KServerSocket *unixdomain, const TQString &protocol, const TQString &socketname)
void unlinkSocket ()
virtual void virtual_hook (int id, void *data)

Detailed Description

Attention developers: If you change the implementation of KIO::Slave, do *not* use connection() or slaveconn but the respective KIO::Slave accessor methods.

Otherwise classes derived from Slave might break. (LS)

Definition at line 44 of file slave.h.


Constructor & Destructor Documentation

Slave::Slave ( bool  derived,
KServerSocket *  unixdomain,
const TQString &  protocol,
const TQString &  socketname 
) [protected]

Use this constructor if you derive your own class from Slave derived must be true in any case.

Definition at line 160 of file slave.cpp.


Member Function Documentation

KDE_DEPRECATED Connection* KIO::Slave::connection ( ) [inline]
Deprecated:
This method is obsolete, use the accessor methods within KIO::Slave instead.

Old code directly accessing connection() will not be able to access special protocols.

Definition at line 208 of file slave.h.

Slave * Slave::createSlave ( const TQString &  protocol,
const KURL &  url,
int &  error,
TQString &  error_text 
) [static]

Creates a new slave.

Parameters:
protocolprotocol the slave is for.
urlURL the slave should operate on.
erroris the error code on failure and undefined else.
error_textis the error text on failure and undefined else.
Returns:
0 on failure, or a pointer to a slave otherwise.
Todo:
What are legal protocol values?

Definition at line 355 of file slave.cpp.

void Slave::hold ( const KURL &  url)

Puts the kioslave associated with url at halt.

Reimplemented in KIO::DataSlave.

Definition at line 216 of file slave.cpp.

TQString KIO::Slave::host ( ) [inline]
Returns:
Host this slave is (was?) connected to

Definition at line 124 of file slave.h.

time_t Slave::idleTime ( )
Returns:
The time this slave has been idle.

Definition at line 206 of file slave.cpp.

bool KIO::Slave::isAlive ( ) [inline]
Returns:
true if the slave survived the last mission.

Definition at line 77 of file slave.h.

void Slave::kill ( )

Force termination.

Definition at line 317 of file slave.cpp.

TQString KIO::Slave::passwd ( ) [inline]
Returns:
Passwd used to log in

Definition at line 139 of file slave.h.

int KIO::Slave::port ( ) [inline]
Returns:
port this slave is (was?) connected to

Definition at line 129 of file slave.h.

TQString KIO::Slave::protocol ( ) [inline]

The protocol this slave handles.

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

Definition at line 104 of file slave.h.

void Slave::resetHost ( )

Clear host info.

Definition at line 342 of file slave.cpp.

void Slave::resume ( )

Resumes the operation of the attached kioslave.

Reimplemented in KIO::DataSlave.

Definition at line 264 of file slave.cpp.

void Slave::send ( int  cmd,
const TQByteArray &  data = TQByteArray() 
)

Sends the given command to the kioslave.

Parameters:
cmdcommand id
databyte array containing data
Since:
3.2

Reimplemented in KIO::DataSlave.

Definition at line 285 of file slave.cpp.

void Slave::setConfig ( const MetaData &  config)

Configure slave.

Reimplemented in KIO::DataSlave.

Definition at line 347 of file slave.cpp.

void Slave::setHost ( const TQString &  host,
int  port,
const TQString &  user,
const TQString &  passwd 
)

Set host for url.

Parameters:
hostto connect to.
portto connect to.
userto login as
passwdto login with

Reimplemented in KIO::DataSlave.

Definition at line 328 of file slave.cpp.

void Slave::setIdle ( )

Marks this slave as idle.

Definition at line 201 of file slave.cpp.

TQString KIO::Slave::slaveProtocol ( ) [inline]

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 119 of file slave.h.

void Slave::suspend ( )

Suspends the operation of the attached kioslave.

Reimplemented in KIO::DataSlave.

Definition at line 254 of file slave.cpp.

bool Slave::suspended ( )

Tells wether the kioslave is suspended.

Returns:
true if the kioslave is suspended.
Since:
3.2

Reimplemented in KIO::DataSlave.

Definition at line 274 of file slave.cpp.

TQString KIO::Slave::user ( ) [inline]
Returns:
User this slave is (was?) logged in as

Definition at line 134 of file slave.h.


The documentation for this class was generated from the following files:
  • slave.h
  • slave.cpp

kio/kio

Skip menu "kio/kio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kio/kio

Skip menu "kio/kio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kio/kio by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |