org.kde.koala

Class Slave

public class Slave extends SlaveInterface

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) See SlaveSignals for signals emitted by Slave

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

Constructor Summary
protected	Slave(Class dummy)

Method Summary
String	className()
static Slave	createSlave(String protocol, KURL url, int[] error, StringBuffer error_text) Creates a new slave.
void	deref()
void	gotInput()
void	hold(KURL url) Puts the kioslave associated with `url` at halt.
static Slave	holdSlave(String protocol, KURL url)
String	host()
int	idleTime()
boolean	isAlive()
boolean	isConnected()
void	kill() Force termination
QMetaObject	metaObject()
String	passwd()
int	port()
String	protocol() The protocol this slave handles.
void	ref()
void	resetHost() Clear host info.
void	resume() Resumes the operation of the attached kioslave.
void	send(int cmd, byte[] data) Sends the given command to the kioslave.
void	send(int cmd)
void	setConnected(boolean c)
void	setHost(String host, int port, String user, String passwd) Set host for url
void	setIdle() Marks this slave as idle.
void	setPID(int arg1)
void	setProtocol(String protocol)
String	slaveProtocol() The actual protocol used to handle the request.
int	slave_pid()
void	suspend() Suspends the operation of the attached kioslave.
boolean	suspended() Tells wether the kioslave is suspended.
void	timeout()
String	user()

Constructor Detail

Slave

protected Slave(Class dummy)

Method Detail

className

public String className()

createSlave

public static Slave createSlave(String protocol, KURL url, int[] error, StringBuffer error_text)

Creates a new slave.

Parameters: protocol protocol the slave is for. url URL the slave should operate on. 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.

UNKNOWN: What are legal protocol values? Creates a new slave.

deref

public void deref()

gotInput

public void gotInput()

hold

public void hold(KURL url)

Puts the kioslave associated with url at halt.

UNKNOWN: Puts the kioslave associated with url at halt.

holdSlave

public static Slave holdSlave(String protocol, KURL url)

host

public String host()

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

UNKNOWN:

idleTime

public int idleTime()

Returns: The time this slave has been idle.

UNKNOWN:

isAlive

public boolean isAlive()

Returns: true if the slave survived the last mission.

UNKNOWN:

isConnected

public boolean isConnected()

kill

public void kill()

Force termination

UNKNOWN: Force termination

metaObject

public QMetaObject metaObject()

passwd

public String passwd()

Returns: Passwd used to log in

UNKNOWN:

port

public int port()

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

UNKNOWN:

protocol

public String protocol()

The protocol this slave handles.

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

UNKNOWN: The protocol this slave handles.

ref

public void ref()

resetHost

public void resetHost()

Clear host info.

UNKNOWN: Clear host info.

resume

public void resume()

Resumes the operation of the attached kioslave.

UNKNOWN: Resumes the operation of the attached kioslave.

send

public void send(int cmd, byte[] data)

Sends the given command to the kioslave.

Parameters: cmd command id data byte array containing data

UNKNOWN: Sends the given command to the kioslave.

send

public void send(int cmd)

setConnected

public void setConnected(boolean c)

setHost

public void setHost(String host, int port, String user, String passwd)

Set host for url

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

UNKNOWN: Set host for url

setIdle

public void setIdle()

Marks this slave as idle.

UNKNOWN: Marks this slave as idle.

setPID

public void setPID(int arg1)

setProtocol

public void setProtocol(String protocol)

slaveProtocol

public String 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

UNKNOWN: The actual protocol used to handle the request.

slave_pid

public int slave_pid()

suspend

public void suspend()

Suspends the operation of the attached kioslave.

UNKNOWN: Suspends the operation of the attached kioslave.

suspended

public boolean suspended()

Tells wether the kioslave is suspended.

Returns: true if the kioslave is suspended.

UNKNOWN: Tells wether the kioslave is suspended.

timeout

public void timeout()

user

public String user()

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

UNKNOWN: