\section{KIO::Slave\-Base Class Reference}
\label{classKIO_1_1SlaveBase}\index{KIO::SlaveBase@{KIO::SlaveBase}}
There are two classes that specifies the protocol between application (job) and kioslave.  


{\tt \#include $<$slavebase.h$>$}

Inheritance diagram for KIO::Slave\-Base:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=70pt]{classKIO_1_1SlaveBase__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KIO::Slave\-Base:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=259pt]{classKIO_1_1SlaveBase__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Message\-Box\-Type} \{ \par
{\bf Question\-Yes\-No} =  1, 
{\bf Warning\-Yes\-No} =  2, 
{\bf Warning\-Continue\-Cancel} =  3, 
{\bf Warning\-Yes\-No\-Cancel} =  4, 
\par
{\bf Information} =  5, 
{\bf SSLMessage\-Box} =  6
 \}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Slave\-Base} (const  {\bf QCString} \&protocol, const  {\bf QCString} \&pool\_\-socket, const  {\bf QCString} \&app\_\-socket)\label{classKIO_1_1SlaveBase_a0}

\item 
void {\bf exit} ()\label{classKIO_1_1SlaveBase_a2}

\item 
void {\bf dispatch\-Loop} ()\label{classKIO_1_1SlaveBase_a3}

\item 
void {\bf set\-Connection} ({\bf Connection} $\ast$connection)\label{classKIO_1_1SlaveBase_a4}

\item 
{\bf Connection} $\ast$ {\bf connection} () const \label{classKIO_1_1SlaveBase_a5}

\item 
void {\bf data} (const  {\bf QByte\-Array} \&data)
\begin{CompactList}\small\item\em Sends data in the slave to the job (i.e. \item\end{CompactList}\item 
void {\bf data\-Req} ()
\begin{CompactList}\small\item\em Asks for data from the job. \item\end{CompactList}\item 
void {\bf error} (int \_\-errid, const  {\bf QString} \&\_\-text)
\begin{CompactList}\small\item\em Call to signal an error. \item\end{CompactList}\item 
void {\bf connected} ()
\begin{CompactList}\small\item\em Call in open\-Connection, if you reimplement it, when you're done. \item\end{CompactList}\item 
void {\bf finished} ()
\begin{CompactList}\small\item\em Call to signal successful completion of any command (besides open\-Connection and close\-Connection). \item\end{CompactList}\item 
void {\bf need\-Sub\-URLData} ()
\begin{CompactList}\small\item\em Call to signal that data from the sub-URL is needed. \item\end{CompactList}\item 
void {\bf slave\-Status} (const  {\bf QString} \&host, bool connected)
\begin{CompactList}\small\item\em Used to report the status of the slave. \item\end{CompactList}\item 
void {\bf stat\-Entry} (const  {\bf UDSEntry} \&\_\-entry)
\begin{CompactList}\small\item\em Call this from {\bf stat()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a37})} to express details about an object, the UDSEntry customarily contains the atoms describing file name, size, mimetype, etc. \item\end{CompactList}\item 
void {\bf list\-Entries} (const  {\bf UDSEntry\-List} \&\_\-entry)
\begin{CompactList}\small\item\em Call this in list\-Dir, each time you have a bunch of entries to report. \item\end{CompactList}\item 
bool {\bf can\-Resume} (KIO::filesize\_\-t offset)
\begin{CompactList}\small\item\em Call this at the beginning of {\bf put()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a36})}, to give the size of the existing partial file, if there is one. \item\end{CompactList}\item 
void {\bf can\-Resume} ()\label{classKIO_1_1SlaveBase_a16}

\item 
void {\bf total\-Size} (KIO::filesize\_\-t \_\-bytes)
\begin{CompactList}\small\item\em Call this in {\bf get}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} and {\bf copy}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a44})}, to give the total size of the file Call in {\bf list\-Dir}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a39})} too, when you know the total number of items. \item\end{CompactList}\item 
void {\bf processed\-Size} (KIO::filesize\_\-t \_\-bytes)
\begin{CompactList}\small\item\em Call this during {\bf get}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} and {\bf copy}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a44})}, once in a while, to give some info about the current state. \item\end{CompactList}\item 
void {\bf processed\-Percent} (float percent)
\begin{CompactList}\small\item\em Only use this if you can't know in advance the size of the copied data. \item\end{CompactList}\item 
void {\bf speed} (unsigned long \_\-bytes\_\-per\_\-second)
\begin{CompactList}\small\item\em Call this in {\bf get}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} and {\bf copy}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a44})}, to give the current transfer speed, but only if it can't be calculated out of the size you passed to processed\-Size (in most cases you don't want to call it). \item\end{CompactList}\item 
void {\bf redirection} (const  {\bf KURL} \&\_\-url)
\begin{CompactList}\small\item\em Call this to signal a redirection The job will take care of going to that url. \item\end{CompactList}\item 
void {\bf error\-Page} ()
\begin{CompactList}\small\item\em Tell that we will only get an error page here. \item\end{CompactList}\item 
void {\bf mime\-Type} (const  {\bf QString} \&\_\-type)
\begin{CompactList}\small\item\em Call this in {\bf mimetype}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a38})}, when you know the mimetype. \item\end{CompactList}\item 
void {\bf warning} (const  {\bf QString} \&msg)
\begin{CompactList}\small\item\em Call to signal a warning, to be displayed in a dialog box. \item\end{CompactList}\item 
void {\bf info\-Message} (const  {\bf QString} \&msg)
\begin{CompactList}\small\item\em Call to signal a message, to be displayed if the application wants to, for instance in a status bar. \item\end{CompactList}\item 
int {\bf message\-Box} (Message\-Box\-Type type, const  {\bf QString} \&text, const  {\bf QString} \&caption=QString::null, const  {\bf QString} \&button\-Yes=QString::null, const  {\bf QString} \&button\-No=QString::null)
\begin{CompactList}\small\item\em Call this to show a message box from the slave (it will in fact be handled by kio\_\-uiserver, so that the progress info dialog for the slave is hidden while this message box is shown). \item\end{CompactList}\item 
void {\bf set\-Meta\-Data} (const  {\bf QString} \&key, const  {\bf QString} \&value)
\begin{CompactList}\small\item\em Sets meta-data to be send to the application before the first {\bf data()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a6})} or {\bf finished()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a10})} signal. \item\end{CompactList}\item 
bool {\bf has\-Meta\-Data} (const  {\bf QString} \&key)
\begin{CompactList}\small\item\em Queries for the existance of a certain config/meta-data entry send by the application to the slave. \item\end{CompactList}\item 
{\bf QString} {\bf meta\-Data} (const  {\bf QString} \&key)
\begin{CompactList}\small\item\em Queries for config/meta-data send by the application to the slave. \item\end{CompactList}\item 
{\bf KConfig\-Base} $\ast$ {\bf config} ()
\begin{CompactList}\small\item\em Returns a configuration object to query config/meta-data information from. \item\end{CompactList}\item 
virtual void {\bf set\-Host} (const  {\bf QString} \&host, int port, const  {\bf QString} \&user, const  {\bf QString} \&pass)
\begin{CompactList}\small\item\em Set the host. \item\end{CompactList}\item 
virtual void {\bf set\-Sub\-URL} (const  {\bf KURL} \&url)
\begin{CompactList}\small\item\em Prepare slave for streaming operation. \item\end{CompactList}\item 
virtual void {\bf open\-Connection} ()
\begin{CompactList}\small\item\em Opens the connection (forced) When this function gets called the slave is operating in connection-oriented mode. \item\end{CompactList}\item 
virtual void {\bf close\-Connection} ()
\begin{CompactList}\small\item\em Closes the connection (forced) Called when the application disconnects the slave to close any open network connections. \item\end{CompactList}\item 
virtual void {\bf get} (const  {\bf KURL} \&url)
\begin{CompactList}\small\item\em get, aka read. \item\end{CompactList}\item 
virtual void {\bf put} (const  {\bf KURL} \&url, int permissions, bool overwrite, bool resume)
\begin{CompactList}\small\item\em put, aka write. \item\end{CompactList}\item 
virtual void {\bf stat} (const  {\bf KURL} \&url)
\begin{CompactList}\small\item\em Finds all details for one file or directory. \item\end{CompactList}\item 
virtual void {\bf mimetype} (const  {\bf KURL} \&url)
\begin{CompactList}\small\item\em Finds mimetype for one file or directory. \item\end{CompactList}\item 
virtual void {\bf list\-Dir} (const  {\bf KURL} \&url)
\begin{CompactList}\small\item\em Lists the contents of {\tt path}. \item\end{CompactList}\item 
virtual void {\bf mkdir} (const  {\bf KURL} \&url, int permissions)
\begin{CompactList}\small\item\em Create a directory. \item\end{CompactList}\item 
virtual void {\bf rename} (const  {\bf KURL} \&src, const  {\bf KURL} \&dest, bool overwrite)
\begin{CompactList}\small\item\em Rename {\tt oldname} into {\tt newname}. \item\end{CompactList}\item 
virtual void {\bf symlink} (const  {\bf QString} \&target, const  {\bf KURL} \&dest, bool overwrite)
\begin{CompactList}\small\item\em Creates a symbolic link named {\tt dest}, pointing to {\tt target}, which may be a relative or an absolute path. \item\end{CompactList}\item 
virtual void {\bf chmod} (const  {\bf KURL} \&url, int permissions)
\begin{CompactList}\small\item\em Change permissions on {\tt path} The slave emits ERR\_\-DOES\_\-NOT\_\-EXIST or ERR\_\-CANNOT\_\-CHMOD. \item\end{CompactList}\item 
virtual void {\bf copy} (const  {\bf KURL} \&src, const  {\bf KURL} \&dest, int permissions, bool overwrite)
\begin{CompactList}\small\item\em Copy {\tt src} into {\tt dest}. \item\end{CompactList}\item 
virtual void {\bf del} (const  {\bf KURL} \&url, bool isfile)
\begin{CompactList}\small\item\em Delete a file or directory. \item\end{CompactList}\item 
virtual void {\bf special} (const  {\bf QByte\-Array} \&)
\begin{CompactList}\small\item\em Used for any command that is specific to this slave (protocol) Examples are : HTTP POST, mount and unmount (kio\_\-file). \item\end{CompactList}\item 
virtual void {\bf multi\-Get} (const  {\bf QByte\-Array} \&)
\begin{CompactList}\small\item\em Used for multiple get. \item\end{CompactList}\item 
virtual void {\bf slave\_\-status} ()
\begin{CompactList}\small\item\em Called to get the status of the slave. \item\end{CompactList}\item 
virtual void {\bf reparse\-Configuration} ()
\begin{CompactList}\small\item\em Called by the scheduler to tell the slave that the configuration changed (i.e. \item\end{CompactList}\item 
int {\bf connect\-Timeout} ()
\item 
int {\bf proxy\-Connect\-Timeout} ()
\item 
int {\bf response\-Timeout} ()
\item 
int {\bf read\-Timeout} ()
\item 
void {\bf set\-Timeout\-Special\-Command} (int timeout, const  {\bf QByte\-Array} \&data={\bf QByte\-Array}())
\begin{CompactList}\small\item\em This function sets a timeout of {\tt timeout} seconds and calls special(data) when the timeout occurs as if it was called by the application. \item\end{CompactList}\item 
virtual bool {\bf dispatch} ()\label{classKIO_1_1SlaveBase_a55}

\item 
virtual void {\bf dispatch} (int command, const  {\bf QByte\-Array} \&data)\label{classKIO_1_1SlaveBase_a56}

\item 
int {\bf read\-Data} ({\bf QByte\-Array} \&buffer)
\begin{CompactList}\small\item\em Read data send by the job, after a {\bf data\-Req}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a7})}. \item\end{CompactList}\item 
void {\bf list\-Entry} (const  {\bf UDSEntry} \&\_\-entry, bool ready)
\begin{CompactList}\small\item\em internal function to be called by the slave. \item\end{CompactList}\item 
void {\bf connect\-Slave} (const  {\bf QString} \&path)
\begin{CompactList}\small\item\em internal function to connect a slave to/ disconnect from either the slave pool or the application \item\end{CompactList}\item 
void {\bf disconnect\-Slave} ()\label{classKIO_1_1SlaveBase_a60}

\item 
bool {\bf ping\-Cache\-Daemon} () const 
\begin{CompactList}\small\item\em Checks whether the password daemon kdesud is running or if it can be started if it is not. \item\end{CompactList}\item 
bool {\bf open\-Pass\-Dlg} ({\bf KIO::Auth\-Info} \&info, const  {\bf QString} \&error\-Msg)
\begin{CompactList}\small\item\em Prompt the user for Authorization info (login \& password). \item\end{CompactList}\item 
bool {\bf open\-Pass\-Dlg} ({\bf KIO::Auth\-Info} \&info)\label{classKIO_1_1SlaveBase_a63}

\item 
bool {\bf check\-Cached\-Authentication} ({\bf Auth\-Info} \&info)
\begin{CompactList}\small\item\em Checks for cached authentication based on parameters given by {\tt info}. \item\end{CompactList}\item 
bool {\bf cache\-Authentication} (const  {\bf Auth\-Info} \&info)
\begin{CompactList}\small\item\em Explicitly store authentication information. \item\end{CompactList}\item 
{\bf QString} {\bf create\-Auth\-Cache\-Key} (const  {\bf KURL} \&url)
\begin{CompactList}\small\item\em Creates a basic key to be used to cache the password. \item\end{CompactList}\item 
void {\bf send\-Authentication\-Key} (const  {\bf QCString} \&g\-Key, const  {\bf QCString} \&key, bool keep)
\item 
void {\bf del\-Cached\-Authentication} (const  {\bf QString} \&key)
\item 
void {\bf set\-Multiple\-Auth\-Caching} (bool enable)
\begin{CompactList}\small\item\em Setup support for multiple auth-info caching to a single server. \item\end{CompactList}\item 
bool {\bf multiple\-Auth\-Caching} () const 
\item 
bool {\bf request\-Network} (const  {\bf QString} \&host=QString::null)
\begin{CompactList}\small\item\em Used by the slave to check if it can connect to a given host. \item\end{CompactList}\item 
void {\bf drop\-Network} (const  {\bf QString} \&host=QString::null)
\begin{CompactList}\small\item\em Used by the slave to withdraw a connection requested by {\bf request\-Network}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a71})}. \item\end{CompactList}\item 
{\bf DCOPClient} $\ast$ {\bf dcop\-Client} ()
\begin{CompactList}\small\item\em Return the dcop client used by this slave. \item\end{CompactList}\item 
int {\bf wait\-For\-Answer} (int expected1, int expected2, {\bf QByte\-Array} \&data, int $\ast$p\-Cmd=0)
\begin{CompactList}\small\item\em Wait for an answer to our request, until we get {\tt expected1} or {\tt expected2}. \item\end{CompactList}\item 
void {\bf send\-Meta\-Data} ()
\begin{CompactList}\small\item\em Internal function to transmit meta data to the application. \item\end{CompactList}\item 
bool {\bf was\-Killed} () const 
\begin{CompactList}\small\item\em If your ioslave was killed by a signal, {\bf was\-Killed()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a76})} returns true. \item\end{CompactList}\item 
void {\bf set\-Kill\-Flag} ()
\begin{CompactList}\small\item\em Internally used. \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
void {\bf sigsegv\_\-handler} (int)\label{classKIO_1_1SlaveBase_e0}

\item 
void {\bf sigpipe\_\-handler} (int)\label{classKIO_1_1SlaveBase_e1}

\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
{\bf QCString} {\bf m\-Protocol}
\begin{CompactList}\small\item\em Name of the protocol supported by this slave. \item\end{CompactList}\item 
{\bf Connection} $\ast$ {\bf m\_\-p\-Connection}\label{classKIO_1_1SlaveBase_o1}

\item 
Meta\-Data {\bf m\-Outgoing\-Meta\-Data}\label{classKIO_1_1SlaveBase_o2}

\item 
Meta\-Data {\bf m\-Incoming\-Meta\-Data}\label{classKIO_1_1SlaveBase_o3}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKIO_1_1SlaveBase_b0}

\end{CompactItemize}


\subsection{Detailed Description}
There are two classes that specifies the protocol between application (job) and kioslave. 

{\bf Slave\-Interface}{\rm (p.\,\pageref{classKIO_1_1SlaveInterface})} is the class to use on the application end, {\bf Slave\-Base}{\rm (p.\,\pageref{classKIO_1_1SlaveBase})} is the one to use on the slave end.

Slave implementations should simply inherit {\bf Slave\-Base}{\rm (p.\,\pageref{classKIO_1_1SlaveBase})}

A call to foo() results in a call to slot\-Foo() on the other end. 



Definition at line 44 of file slavebase.h.

\subsection{Member Function Documentation}
\index{KIO::SlaveBase@{KIO::Slave\-Base}!data@{data}}
\index{data@{data}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::data (const {\bf QByte\-Array} \& {\em data})}\label{classKIO_1_1SlaveBase_a6}


Sends data in the slave to the job (i.e. 

in get).

To signal end of data, simply send an empty QByte\-Array().

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em data}]the data read by the slave \end{description}
\end{Desc}


Definition at line 354 of file slavebase.cpp.

References KIO::Connection::send(), and send\-Meta\-Data().

Referenced by can\-Resume(), del\-Cached\-Authentication(), drop\-Network(), error(), info\-Message(), list\-Entries(), message\-Box(), mime\-Type(), processed\-Size(), redirection(), request\-Network(), send\-Authentication\-Key(), send\-Meta\-Data(), slave\-Status(), speed(), stat\-Entry(), total\-Size(), and warning().\index{KIO::SlaveBase@{KIO::Slave\-Base}!dataReq@{dataReq}}
\index{dataReq@{dataReq}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::data\-Req ()}\label{classKIO_1_1SlaveBase_a7}


Asks for data from the job. 

\begin{Desc}
\item[See also:]{\bf read\-Data}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a57})} \end{Desc}


Definition at line 363 of file slavebase.cpp.

References can\-Resume(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!error@{error}}
\index{error@{error}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::error (int {\em \_\-errid}, const {\bf QString} \& {\em \_\-text})}\label{classKIO_1_1SlaveBase_a8}


Call to signal an error. 

This also finishes the job, no need to call finished.

If the Error code is KIO::ERR\_\-SLAVE\_\-DEFINED then the \_\-text should contain the complete translated text of of the error message. This message will be displayed in an {\bf KText\-Browser} which allows rich text complete with hyper links. Email links will call the default mailer, \char`\"{}exec:/command arg1 arg2\char`\"{} will be forked and all other links will call the default browser.

\begin{Desc}
\item[See also:]{\bf KIO::Error}{\rm (p.\,\pageref{namespaceKIO_a240})} 

{\bf KText\-Browser} \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-errid}]the error code from {\bf KIO::Error}{\rm (p.\,\pageref{namespaceKIO_a240})} \item[{\em \_\-text}]the rich text error message \end{description}
\end{Desc}


Definition at line 374 of file slavebase.cpp.

References data(), and KIO::Connection::send().

Referenced by chmod(), copy(), del(), get(), list\-Dir(), mkdir(), multi\-Get(), open\-Connection(), put(), rename(), set\-Sub\-URL(), special(), stat(), and symlink().\index{KIO::SlaveBase@{KIO::Slave\-Base}!connected@{connected}}
\index{connected@{connected}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::connected ()}\label{classKIO_1_1SlaveBase_a9}


Call in open\-Connection, if you reimplement it, when you're done. 



Definition at line 387 of file slavebase.cpp.

References KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!finished@{finished}}
\index{finished@{finished}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::finished ()}\label{classKIO_1_1SlaveBase_a10}


Call to signal successful completion of any command (besides open\-Connection and close\-Connection). 



Definition at line 394 of file slavebase.cpp.

References KIO::Connection::send(), and send\-Meta\-Data().\index{KIO::SlaveBase@{KIO::Slave\-Base}!needSubURLData@{needSubURLData}}
\index{needSubURLData@{needSubURLData}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::need\-Sub\-URLData ()}\label{classKIO_1_1SlaveBase_a11}


Call to signal that data from the sub-URL is needed. 



Definition at line 407 of file slavebase.cpp.

References KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!slaveStatus@{slaveStatus}}
\index{slaveStatus@{slaveStatus}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::slave\-Status (const {\bf QString} \& {\em host}, bool {\em connected})}\label{classKIO_1_1SlaveBase_a12}


Used to report the status of the slave. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em host}]the slave is currently connected to. (Should be empty if not connected) \item[{\em connected}]Whether an actual network connection exists. \end{description}
\end{Desc}


Definition at line 412 of file slavebase.cpp.

References data(), m\-Protocol, and KIO::Connection::send().

Referenced by slave\_\-status().\index{KIO::SlaveBase@{KIO::Slave\-Base}!statEntry@{statEntry}}
\index{statEntry@{statEntry}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::stat\-Entry (const {\bf UDSEntry} \& {\em \_\-entry})}\label{classKIO_1_1SlaveBase_a13}


Call this from {\bf stat()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a37})} to express details about an object, the UDSEntry customarily contains the atoms describing file name, size, mimetype, etc. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-entry}]The UDSEntry containing all of the object attributes. \end{description}
\end{Desc}


Definition at line 583 of file slavebase.cpp.

References data(), KIO::Connection::send(), and KIO::UDSEntry.\index{KIO::SlaveBase@{KIO::Slave\-Base}!listEntries@{listEntries}}
\index{listEntries@{listEntries}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::list\-Entries (const {\bf UDSEntry\-List} \& {\em \_\-entry})}\label{classKIO_1_1SlaveBase_a14}


Call this in list\-Dir, each time you have a bunch of entries to report. 



Definition at line 633 of file slavebase.cpp.

References QValue\-List::begin(), QValue\-List::count(), data(), QValue\-List::end(), KStd\-Accel::end(), and KIO::Connection::send().

Referenced by list\-Entry().\index{KIO::SlaveBase@{KIO::Slave\-Base}!canResume@{canResume}}
\index{canResume@{canResume}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::can\-Resume (KIO::filesize\_\-t {\em offset})}\label{classKIO_1_1SlaveBase_a15}


Call this at the beginning of {\bf put()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a36})}, to give the size of the existing partial file, if there is one. 

The {\tt offset} argument notifies the other job (the one that gets the data) about the offset to use. In this case, the boolean returns whether we can indeed resume or not (we can't if the protocol doing the {\bf get()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} doesn't support setting an offset) 

Definition at line 815 of file slavebase.cpp.

References data(), KIO::number(), KIO::Connection::send(), and wait\-For\-Answer().

Referenced by data\-Req().\index{KIO::SlaveBase@{KIO::Slave\-Base}!totalSize@{totalSize}}
\index{totalSize@{totalSize}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::total\-Size (KIO::filesize\_\-t {\em \_\-bytes})}\label{classKIO_1_1SlaveBase_a17}


Call this in {\bf get}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} and {\bf copy}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a44})}, to give the total size of the file Call in {\bf list\-Dir}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a39})} too, when you know the total number of items. 



Definition at line 427 of file slavebase.cpp.

References data(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!processedSize@{processedSize}}
\index{processedSize@{processedSize}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::processed\-Size (KIO::filesize\_\-t {\em \_\-bytes})}\label{classKIO_1_1SlaveBase_a18}


Call this during {\bf get}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} and {\bf copy}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a44})}, once in a while, to give some info about the current state. 

Don't emit it in {\bf list\-Dir}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a39})}, {\bf list\-Entries}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a14})} speaks for itself. 

Definition at line 443 of file slavebase.cpp.

References data(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!processedPercent@{processedPercent}}
\index{processedPercent@{processedPercent}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::processed\-Percent (float {\em percent})}\label{classKIO_1_1SlaveBase_a19}


Only use this if you can't know in advance the size of the copied data. 

For example, if you're doing variable bitrate compression of the source.

STUB ! Currently unimplemented. Here now for binary compatibility.

Call this during {\bf get}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} and {\bf copy}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a44})}, once in a while, to give some info about the current state. Don't emit it in {\bf list\-Dir}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a39})}, {\bf list\-Entries}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a14})} speaks for itself. 

Definition at line 470 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!speed@{speed}}
\index{speed@{speed}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::speed (unsigned long {\em \_\-bytes\_\-per\_\-second})}\label{classKIO_1_1SlaveBase_a20}


Call this in {\bf get}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} and {\bf copy}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a44})}, to give the current transfer speed, but only if it can't be calculated out of the size you passed to processed\-Size (in most cases you don't want to call it). 



Definition at line 476 of file slavebase.cpp.

References data(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!redirection@{redirection}}
\index{redirection@{redirection}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::redirection (const {\bf KURL} \& {\em \_\-url})}\label{classKIO_1_1SlaveBase_a21}


Call this to signal a redirection The job will take care of going to that url. 



Definition at line 484 of file slavebase.cpp.

References data(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!errorPage@{errorPage}}
\index{errorPage@{errorPage}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::error\-Page ()}\label{classKIO_1_1SlaveBase_a22}


Tell that we will only get an error page here. 

This means: the data you'll get isn't the data you requested, but an error page (usually HTML) that describes an error. 

Definition at line 490 of file slavebase.cpp.

References KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!mimeType@{mimeType}}
\index{mimeType@{mimeType}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::mime\-Type (const {\bf QString} \& {\em \_\-type})}\label{classKIO_1_1SlaveBase_a23}


Call this in {\bf mimetype}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a38})}, when you know the mimetype. 

See {\bf mimetype}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a38})} about other ways to implement it. 

Definition at line 507 of file slavebase.cpp.

References data(), KIO::Connection::read(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!warning@{warning}}
\index{warning@{warning}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::warning (const {\bf QString} \& {\em msg})}\label{classKIO_1_1SlaveBase_a24}


Call to signal a warning, to be displayed in a dialog box. 



Definition at line 550 of file slavebase.cpp.

References data(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!infoMessage@{infoMessage}}
\index{infoMessage@{infoMessage}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::info\-Message (const {\bf QString} \& {\em msg})}\label{classKIO_1_1SlaveBase_a25}


Call to signal a message, to be displayed if the application wants to, for instance in a status bar. 

Usual examples are \char`\"{}connecting to host xyz\char`\"{}, etc. 

Definition at line 556 of file slavebase.cpp.

References data(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!messageBox@{messageBox}}
\index{messageBox@{messageBox}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Slave\-Base::message\-Box (Message\-Box\-Type {\em type}, const {\bf QString} \& {\em text}, const {\bf QString} \& {\em caption} = QString::null, const {\bf QString} \& {\em button\-Yes} = QString::null, const {\bf QString} \& {\em button\-No} = QString::null)}\label{classKIO_1_1SlaveBase_a26}


Call this to show a message box from the slave (it will in fact be handled by kio\_\-uiserver, so that the progress info dialog for the slave is hidden while this message box is shown). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em type}]type of message box: Question\-Yes\-No, Warning\-Yes\-No, Warning\-Continue\-Cancel... \item[{\em text}]Message string. May contain newlines. \item[{\em caption}]Message box title. \item[{\em button\-Yes}]The text for the first button. The default is i18n(\char`\"{}\&Yes\char`\"{}). \item[{\em button\-No}]The text for the second button. The default is i18n(\char`\"{}\&No\char`\"{}). Note: for Continue\-Cancel, button\-Yes is the continue button and button\-No is unused. and for Information, none is used. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]a button code, as defined in {\bf KMessage\-Box}, or 0 on communication error. \end{Desc}


Definition at line 798 of file slavebase.cpp.

References data(), KIO::Connection::send(), and wait\-For\-Answer().\index{KIO::SlaveBase@{KIO::Slave\-Base}!setMetaData@{setMetaData}}
\index{setMetaData@{setMetaData}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::set\-Meta\-Data (const {\bf QString} \& {\em key}, const {\bf QString} \& {\em value})}\label{classKIO_1_1SlaveBase_a27}


Sets meta-data to be send to the application before the first {\bf data()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a6})} or {\bf finished()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a10})} signal. 



Definition at line 315 of file slavebase.cpp.

References KStd\-Accel::key().\index{KIO::SlaveBase@{KIO::Slave\-Base}!hasMetaData@{hasMetaData}}
\index{hasMetaData@{hasMetaData}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::has\-Meta\-Data (const {\bf QString} \& {\em key})}\label{classKIO_1_1SlaveBase_a28}


Queries for the existance of a certain config/meta-data entry send by the application to the slave. 



Definition at line 329 of file slavebase.cpp.

References KStd\-Accel::key().\index{KIO::SlaveBase@{KIO::Slave\-Base}!metaData@{metaData}}
\index{metaData@{metaData}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Slave\-Base::meta\-Data (const {\bf QString} \& {\em key})}\label{classKIO_1_1SlaveBase_a29}


Queries for config/meta-data send by the application to the slave. 



Definition at line 320 of file slavebase.cpp.

References KStd\-Accel::key().

Referenced by cache\-Authentication(), check\-Cached\-Authentication(), connect\-Timeout(), open\-Pass\-Dlg(), proxy\-Connect\-Timeout(), read\-Timeout(), and response\-Timeout().\index{KIO::SlaveBase@{KIO::Slave\-Base}!config@{config}}
\index{config@{config}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KConfig\-Base} $\ast$ Slave\-Base::config ()}\label{classKIO_1_1SlaveBase_a30}


Returns a configuration object to query config/meta-data information from. 

The application provides the slave with all configuration information relevant for the current protocol and host. 

Definition at line 338 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!setHost@{setHost}}
\index{setHost@{setHost}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::set\-Host (const {\bf QString} \& {\em host}, int {\em port}, const {\bf QString} \& {\em user}, const {\bf QString} \& {\em pass})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a31}


Set the host. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em host}]\item[{\em port}]\item[{\em user}]\item[{\em pass}]Called directly by create\-Slave, this is why there is no equivalent in {\bf Slave\-Interface}{\rm (p.\,\pageref{classKIO_1_1SlaveInterface})}, unlike the other methods.\end{description}
\end{Desc}
This method is called whenever a change in host, port or user occurs. 

Definition at line 687 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!setSubURL@{setSubURL}}
\index{setSubURL@{setSubURL}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::set\-Sub\-URL (const {\bf KURL} \& {\em url})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a32}


Prepare slave for streaming operation. 



Definition at line 719 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!openConnection@{openConnection}}
\index{openConnection@{openConnection}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::open\-Connection ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a33}


Opens the connection (forced) When this function gets called the slave is operating in connection-oriented mode. 

When a connection gets lost while the slave operates in connection oriented mode, the slave should report ERR\_\-CONNECTION\_\-BROKEN instead of reconnecting. 

Definition at line 691 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!closeConnection@{closeConnection}}
\index{closeConnection@{closeConnection}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::close\-Connection ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a34}


Closes the connection (forced) Called when the application disconnects the slave to close any open network connections. 

When the slave was operating in connection-oriented mode, it should reset itself to connectionless (default) mode. 

Definition at line 693 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!get@{get}}
\index{get@{get}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::get (const {\bf KURL} \& {\em url})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a35}


get, aka read. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em url}]the full url for this request. Host, port and user of the URL can be assumed to be the same as in the last {\bf set\-Host()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a31})} call. The slave emits the data through {\bf data}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a6})} \end{description}
\end{Desc}


Definition at line 703 of file slavebase.cpp.

References error(), and m\-Protocol.

Referenced by mimetype().\index{KIO::SlaveBase@{KIO::Slave\-Base}!put@{put}}
\index{put@{put}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::put (const {\bf KURL} \& {\em url}, int {\em permissions}, bool {\em overwrite}, bool {\em resume})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a36}


put, aka write. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em path}]where to write the file (decoded) \item[{\em permissions}]may be -1. In this case no special permission mode is set. \item[{\em overwrite}]if true, any existing file will be overwritten. If the file indeed already exists, the slave should NOT apply the permissions change to it. \item[{\em resume}]\end{description}
\end{Desc}


Definition at line 697 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!stat@{stat}}
\index{stat@{stat}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::stat (const {\bf KURL} \& {\em url})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a37}


Finds all details for one file or directory. 

The information returned is the same as what {\bf list\-Dir}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a39})} returns, but only for one file or directory. 

Definition at line 695 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!mimetype@{mimetype}}
\index{mimetype@{mimetype}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::mimetype (const {\bf KURL} \& {\em url})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a38}


Finds mimetype for one file or directory. 

This method should either emit 'mime\-Type' or it should send a block of data big enough to be able to determine the mimetype.

If the slave doesn't reimplement it, a {\bf get}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})} will be issued, i.e. the whole file will be downloaded before determining the mimetype on it - this is obviously not a good thing in most cases. 

Definition at line 705 of file slavebase.cpp.

References get().\index{KIO::SlaveBase@{KIO::Slave\-Base}!listDir@{listDir}}
\index{listDir@{listDir}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::list\-Dir (const {\bf KURL} \& {\em url})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a39}


Lists the contents of {\tt path}. 

The slave should emit ERR\_\-CANNOT\_\-ENTER\_\-DIRECTORY if it doesn't exist, if we don't have enough permissions, or if it is a file It should also emit total\-Files as soon as it knows how many files it will list. 

Definition at line 701 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!mkdir@{mkdir}}
\index{mkdir@{mkdir}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::mkdir (const {\bf KURL} \& {\em url}, int {\em permissions})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a40}


Create a directory. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em path}]path to the directory to create \item[{\em permissions}]the permissions to set after creating the directory (-1 if no permissions to be set) The slave emits ERR\_\-COULD\_\-NOT\_\-MKDIR if failure. \end{description}
\end{Desc}


Definition at line 715 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!rename@{rename}}
\index{rename@{rename}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::rename (const {\bf KURL} \& {\em src}, const {\bf KURL} \& {\em dest}, bool {\em overwrite})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a41}


Rename {\tt oldname} into {\tt newname}. 

If the slave returns an error ERR\_\-UNSUPPORTED\_\-ACTION, the job will ask for copy + del instead. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em src}]where to move the file from \item[{\em dest}]where to move the file to \item[{\em overwrite}]if true, any existing file will be overwritten \end{description}
\end{Desc}


Definition at line 707 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!symlink@{symlink}}
\index{symlink@{symlink}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::symlink (const {\bf QString} \& {\em target}, const {\bf KURL} \& {\em dest}, bool {\em overwrite})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a42}


Creates a symbolic link named {\tt dest}, pointing to {\tt target}, which may be a relative or an absolute path. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em target}]The string that will become the \char`\"{}target\char`\"{} of the link (can be relative) \item[{\em dest}]The symlink to create. \item[{\em overwrite}]whether to automatically overwrite if the dest exists \end{description}
\end{Desc}


Definition at line 709 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!chmod@{chmod}}
\index{chmod@{chmod}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::chmod (const {\bf KURL} \& {\em url}, int {\em permissions})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a43}


Change permissions on {\tt path} The slave emits ERR\_\-DOES\_\-NOT\_\-EXIST or ERR\_\-CANNOT\_\-CHMOD. 



Definition at line 717 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!copy@{copy}}
\index{copy@{copy}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::copy (const {\bf KURL} \& {\em src}, const {\bf KURL} \& {\em dest}, int {\em permissions}, bool {\em overwrite})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a44}


Copy {\tt src} into {\tt dest}. 

If the slave returns an error ERR\_\-UNSUPPORTED\_\-ACTION, the job will ask for get + put instead. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em src}]where to copy the file from (decoded) \item[{\em dest}]where to copy the file to (decoded) \item[{\em permissions}]may be -1. In this case no special permission mode is set. \item[{\em overwrite}]if true, any existing file will be overwritten \end{description}
\end{Desc}


Definition at line 711 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!del@{del}}
\index{del@{del}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::del (const {\bf KURL} \& {\em url}, bool {\em isfile})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a45}


Delete a file or directory. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em path}]file/directory to delete \item[{\em isfile}]if true, a file should be deleted. if false, a directory should be deleted. \end{description}
\end{Desc}


Definition at line 713 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!special@{special}}
\index{special@{special}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::special (const {\bf QByte\-Array} \&)\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a46}


Used for any command that is specific to this slave (protocol) Examples are : HTTP POST, mount and unmount (kio\_\-file). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em data}]packed data; the meaning is completely dependent on the slave, but usually starts with an int for the command number. Document your slave's commands, at least in its header file. \end{description}
\end{Desc}


Definition at line 699 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!multiGet@{multiGet}}
\index{multiGet@{multiGet}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::multi\-Get (const {\bf QByte\-Array} \&)\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a47}


Used for multiple get. 

Currently only used foir HTTP pielining support.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em data}]packed data; Contains number of URLs to fetch, and for each URL the URL itself and its associated Meta\-Data. \end{description}
\end{Desc}


Definition at line 721 of file slavebase.cpp.

References error(), and m\-Protocol.\index{KIO::SlaveBase@{KIO::Slave\-Base}!slave_status@{slave\_\-status}}
\index{slave_status@{slave\_\-status}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::slave\_\-status ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a48}


Called to get the status of the slave. 

Slave should respond by calling slave\-Status(...) 

Definition at line 725 of file slavebase.cpp.

References slave\-Status().\index{KIO::SlaveBase@{KIO::Slave\-Base}!reparseConfiguration@{reparseConfiguration}}
\index{reparseConfiguration@{reparseConfiguration}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::reparse\-Configuration ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a49}


Called by the scheduler to tell the slave that the configuration changed (i.e. 

proxy settings) . 

Definition at line 728 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!connectTimeout@{connectTimeout}}
\index{connectTimeout@{connectTimeout}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Slave\-Base::connect\-Timeout ()}\label{classKIO_1_1SlaveBase_a50}


\begin{Desc}
\item[Returns:]timeout value for connecting to remote host. \end{Desc}


Definition at line 1146 of file slavebase.cpp.

References meta\-Data(), and QString::to\-Int().\index{KIO::SlaveBase@{KIO::Slave\-Base}!proxyConnectTimeout@{proxyConnectTimeout}}
\index{proxyConnectTimeout@{proxyConnectTimeout}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Slave\-Base::proxy\-Connect\-Timeout ()}\label{classKIO_1_1SlaveBase_a51}


\begin{Desc}
\item[Returns:]timeout value for connecting to proxy in secs. \end{Desc}


Definition at line 1156 of file slavebase.cpp.

References meta\-Data(), and QString::to\-Int().\index{KIO::SlaveBase@{KIO::Slave\-Base}!responseTimeout@{responseTimeout}}
\index{responseTimeout@{responseTimeout}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Slave\-Base::response\-Timeout ()}\label{classKIO_1_1SlaveBase_a52}


\begin{Desc}
\item[Returns:]timeout value for read from first data from remote host in seconds. \end{Desc}


Definition at line 1167 of file slavebase.cpp.

References meta\-Data(), and QString::to\-Int().\index{KIO::SlaveBase@{KIO::Slave\-Base}!readTimeout@{readTimeout}}
\index{readTimeout@{readTimeout}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Slave\-Base::read\-Timeout ()}\label{classKIO_1_1SlaveBase_a53}


\begin{Desc}
\item[Returns:]timeout value for read from subsequent data from remote host in secs. \end{Desc}


Definition at line 1178 of file slavebase.cpp.

References meta\-Data(), and QString::to\-Int().\index{KIO::SlaveBase@{KIO::Slave\-Base}!setTimeoutSpecialCommand@{setTimeoutSpecialCommand}}
\index{setTimeoutSpecialCommand@{setTimeoutSpecialCommand}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::set\-Timeout\-Special\-Command (int {\em timeout}, const {\bf QByte\-Array} \& {\em data} = {\bf QByte\-Array}())}\label{classKIO_1_1SlaveBase_a54}


This function sets a timeout of {\tt timeout} seconds and calls special(data) when the timeout occurs as if it was called by the application. 

A timeout can only occur when the slave is waiting for a command from the application.

Specifying a negative timeout cancels a pending timeout.

Only one timeout at a time is supported, setting a timeout cancels any pending timeout. \begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 872 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!readData@{readData}}
\index{readData@{readData}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Slave\-Base::read\-Data ({\bf QByte\-Array} \& {\em buffer})}\label{classKIO_1_1SlaveBase_a57}


Read data send by the job, after a {\bf data\-Req}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a7})}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buffer}]buffer where data is stored \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]0 on end of data, $>$ 0 bytes read $<$ 0 error \end{Desc}


Definition at line 865 of file slavebase.cpp.

References wait\-For\-Answer().\index{KIO::SlaveBase@{KIO::Slave\-Base}!listEntry@{listEntry}}
\index{listEntry@{listEntry}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::list\-Entry (const {\bf UDSEntry} \& {\em \_\-entry}, bool {\em ready})}\label{classKIO_1_1SlaveBase_a58}


internal function to be called by the slave. 

It collects entries and emits them via list\-Entries when enough of them are there or a certain time frame exceeded (to make sure the app gets some items in time but not too many items one by one as this will cause a drastic performance penalty) \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ready}]set to true after emitting all items. \_\-entry is not used in this case \end{description}
\end{Desc}


Definition at line 591 of file slavebase.cpp.

References QValue\-List::append(), QValue\-List::clear(), QValue\-List::count(), list\-Entries(), and KIO::UDSEntry.\index{KIO::SlaveBase@{KIO::Slave\-Base}!connectSlave@{connectSlave}}
\index{connectSlave@{connectSlave}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::connect\-Slave (const {\bf QString} \& {\em path})}\label{classKIO_1_1SlaveBase_a59}


internal function to connect a slave to/ disconnect from either the slave pool or the application 



Definition at line 298 of file slavebase.cpp.

References QFile::encode\-Name(), KIO::Connection::init(), and KIO::Connection::inited().\index{KIO::SlaveBase@{KIO::Slave\-Base}!pingCacheDaemon@{pingCacheDaemon}}
\index{pingCacheDaemon@{pingCacheDaemon}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::ping\-Cache\-Daemon () const}\label{classKIO_1_1SlaveBase_a61}


Checks whether the password daemon kdesud is running or if it can be started if it is not. 

\begin{Desc}
\item[Returns:]true if password daemon is/can be started successfully. \end{Desc}


Definition at line 1054 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!openPassDlg@{openPassDlg}}
\index{openPassDlg@{openPassDlg}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::open\-Pass\-Dlg ({\bf KIO::Auth\-Info} \& {\em info}, const {\bf QString} \& {\em error\-Msg})}\label{classKIO_1_1SlaveBase_a62}


Prompt the user for Authorization info (login \& password). 

Use this function to request authorization info from the the end user. You can also pass an error\-Msg which explains why a previous authorisation attempt failed. For example to open an empty password dialog using default values:

\small\begin{alltt}
 {\bf KIO::AuthInfo}{\rm (p.\,\pageref{classKIO_1_1AuthInfo})} authInfo;
 if ( openPassDlg( authInfo ) )
 \{
    printf( "Username: %s", authInfo.username.latin1() );
    printf( "Password: %s", authInfo.password.latin1() );
 \}
 \end{alltt}\normalsize 


You can also pre-set some values like the username before hand if it is known as well as the comment and caption to be displayed:

\small\begin{alltt}
 {\bf KIO::AuthInfo}{\rm (p.\,\pageref{classKIO_1_1AuthInfo})} authInfo;
 authInfo.caption= "Acme Password Dialog";
 authInfo.username= "Wile E. Coyote";
 {\bf QString} errorMsg = "You entered an incorrect password.";
 if ( openPassDlg( authInfo, errorMsg ) )
 \{
    printf( "Username: %s", authInfo.username.latin1() );
    printf( "Password: %s", authInfo.password.latin1() );
 \}
 \end{alltt}\normalsize 


NOTE: A call to this function can also fail and result in a return value of {\tt false}, if the {\bf UIServer}{\rm (p.\,\pageref{classUIServer})} could not be started for whatever reason.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em info}]See {\bf Auth\-Info}{\rm (p.\,\pageref{classKIO_1_1AuthInfo})}. \item[{\em error\-Msg}]Error message to show \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]{\tt TRUE} if user clicks on \char`\"{}OK\char`\"{}, {\tt FALSE} otherwsie. \end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 753 of file slavebase.cpp.

References dcop\-Client(), KIO::Auth\-Info::is\-Modified(), QString::lower(), meta\-Data(), QString::to\-Long(), and KIO::Auth\-Info::username.\index{KIO::SlaveBase@{KIO::Slave\-Base}!checkCachedAuthentication@{checkCachedAuthentication}}
\index{checkCachedAuthentication@{checkCachedAuthentication}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::check\-Cached\-Authentication ({\bf Auth\-Info} \& {\em info})}\label{classKIO_1_1SlaveBase_a64}


Checks for cached authentication based on parameters given by {\tt info}. 

Use this function to check if any cached password exists for the URL given by {\tt info}. If {\tt {\bf Auth\-Info::realm\-Value}{\rm (p.\,\pageref{classKIO_1_1AuthInfo_o7})}} is present and/or the {\tt {\bf Auth\-Info::verify\-Path}{\rm (p.\,\pageref{classKIO_1_1AuthInfo_o9})}} flag is set, then they will also be factored in determining the presence of a cached password. Note that {\tt Auth::url} is a required parameter when attempting to check for cached authorization info. Here is a simple example:

\small\begin{alltt}
 {\bf AuthInfo}{\rm (p.\,\pageref{classKIO_1_1AuthInfo})} info;
 info.url = {\bf KURL}("http://www.foobar.org/foo/bar");
 info.username = "somename";
 info.verifyPath = true;
 if ( !checkCachedAuthentication( info ) )
 \{
    if ( !openPassDlg(info) )
     ....
 \}
 \end{alltt}\normalsize 


If the protocol allows multiple resources within the same location to be protected by different passwords, then to determine the correct password and send pre-emtively, i.e. before the other end requires it, you can use one or both of the following methods: set the unique identifier using {\tt {\bf Auth\-Info::realm\-Value}{\rm (p.\,\pageref{classKIO_1_1AuthInfo_o7})}} or require that a path match be performed using {\tt {\bf Auth\-Info::verify\-Path}{\rm (p.\,\pageref{classKIO_1_1AuthInfo_o9})}}.

\small\begin{alltt}
 info.url = {\bf KURL}("http://www.foobar.org/foo/bar");
 info.verifyPath = true;
 info.realmValue = "unique\_identifier";
 \end{alltt}\normalsize 


NOTE: A call to this function will fail and return false, whenever the \char`\"{}kdesud\char`\"{} could not be started for whatever reason or an invalid URL is supplied.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em See}]{\bf Auth\-Info}{\rm (p.\,\pageref{classKIO_1_1AuthInfo})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]{\tt TRUE} if cached Authorization is found, false otherwise. \end{Desc}


Definition at line 1072 of file slavebase.cpp.

References dcop\-Client(), KIO::Auth\-Info::is\-Modified(), meta\-Data(), QString::to\-Long(), KURL::url(), and KIO::Auth\-Info::url.\index{KIO::SlaveBase@{KIO::Slave\-Base}!cacheAuthentication@{cacheAuthentication}}
\index{cacheAuthentication@{cacheAuthentication}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::cache\-Authentication (const {\bf Auth\-Info} \& {\em info})}\label{classKIO_1_1SlaveBase_a65}


Explicitly store authentication information. 

open\-Pass\-Dlg already stores password information automatically, you only need to call this function if you want to store authentication information that is different from the information returned by open\-Pass\-Dlg. 

Definition at line 1121 of file slavebase.cpp.

References dcop\-Client(), meta\-Data(), and QString::to\-Long().\index{KIO::SlaveBase@{KIO::Slave\-Base}!createAuthCacheKey@{createAuthCacheKey}}
\index{createAuthCacheKey@{createAuthCacheKey}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Slave\-Base::create\-Auth\-Cache\-Key (const {\bf KURL} \& {\em url})}\label{classKIO_1_1SlaveBase_a66}


Creates a basic key to be used to cache the password. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em url}]the url from which the key is supposed to be generated \end{description}
\end{Desc}


Definition at line 1035 of file slavebase.cpp.

References KURL::host(), KURL::is\-Malformed(), KStd\-Accel::key(), QString::number(), KURL::port(), and KURL::protocol().\index{KIO::SlaveBase@{KIO::Slave\-Base}!sendAuthenticationKey@{sendAuthenticationKey}}
\index{sendAuthenticationKey@{sendAuthenticationKey}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::send\-Authentication\-Key (const {\bf QCString} \& {\em g\-Key}, const {\bf QCString} \& {\em key}, bool {\em keep})}\label{classKIO_1_1SlaveBase_a67}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
Cache authentication information is now stored automatically by open\-Pass\-Dlg. 

Definition at line 646 of file slavebase.cpp.

References data(), KStd\-Accel::key(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!delCachedAuthentication@{delCachedAuthentication}}
\index{delCachedAuthentication@{delCachedAuthentication}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::del\-Cached\-Authentication (const {\bf QString} \& {\em key})}\label{classKIO_1_1SlaveBase_a68}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
Cache authentication information is now stored automatically by open\-Pass\-Dlg. 

Definition at line 654 of file slavebase.cpp.

References data(), KStd\-Accel::key(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!setMultipleAuthCaching@{setMultipleAuthCaching}}
\index{setMultipleAuthCaching@{setMultipleAuthCaching}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::set\-Multiple\-Auth\-Caching (bool {\em enable})}\label{classKIO_1_1SlaveBase_a69}


Setup support for multiple auth-info caching to a single server. 

Calling this function with the argument set to {\tt true} will allow a user to work on multiple resources located under different accounts but on the same server without being re-prompted for authorization each time. Simply put if you have a \char`\"{}foo\char`\"{} and a \char`\"{}bar\char`\"{} account on a given machine at \char`\"{}foobar.com\char`\"{} and you log into this machine using both of the accounts, then the authorization information you supplied for both accounts will be cached. This is also true if you have N number of accounts and you logged into all of them. Otherwise, the default behavior is for the latest login will simply overwrite the previous one.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em enable}]if true allow multiple auth-info caching. \end{description}
\end{Desc}


Definition at line 1136 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!multipleAuthCaching@{multipleAuthCaching}}
\index{multipleAuthCaching@{multipleAuthCaching}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::multiple\-Auth\-Caching () const}\label{classKIO_1_1SlaveBase_a70}


\begin{Desc}
\item[Returns:]true if multiple auth-info caching is enabled. \end{Desc}


Definition at line 1141 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!requestNetwork@{requestNetwork}}
\index{requestNetwork@{requestNetwork}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::request\-Network (const {\bf QString} \& {\em host} = QString::null)}\label{classKIO_1_1SlaveBase_a71}


Used by the slave to check if it can connect to a given host. 

This should be called where the slave is ready to do a ::connect() on a socket. For each call to {\bf request\-Network}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a71})} must exist a matching call to {\bf drop\-Network}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a72})}, or the system will stay online until KNet\-Mgr gets closed (or the {\bf Slave\-Base}{\rm (p.\,\pageref{classKIO_1_1SlaveBase})} gets destructed)!

If KNet\-Mgr is not running, then this is a no-op and returns true

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em host}]tells the netmgr the host the slave wants to connect to. As this could also be a proxy, we can't just take the host currenctly connected to (but that's the default value)\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]true in theorie, the host is reachable false the system is offline and the host is in a remote network. \end{Desc}


Definition at line 562 of file slavebase.cpp.

References data(), KIO::Connection::send(), and wait\-For\-Answer().\index{KIO::SlaveBase@{KIO::Slave\-Base}!dropNetwork@{dropNetwork}}
\index{dropNetwork@{dropNetwork}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::drop\-Network (const {\bf QString} \& {\em host} = QString::null)}\label{classKIO_1_1SlaveBase_a72}


Used by the slave to withdraw a connection requested by {\bf request\-Network}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a71})}. 

This function cancels the last call to {\bf request\-Network}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a71})}. If a client uses more than one internet connection, it must use drop\-Network(host) to stop each request.

If KNet\-Mgr is not running, then this is a no-op.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em host}]the host passed to request\-Network\end{description}
\end{Desc}
A slave should call this function every time it disconnect from a host. 

Definition at line 577 of file slavebase.cpp.

References data(), and KIO::Connection::send().\index{KIO::SlaveBase@{KIO::Slave\-Base}!dcopClient@{dcopClient}}
\index{dcopClient@{dcopClient}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DCOPClient} $\ast$ Slave\-Base::dcop\-Client ()}\label{classKIO_1_1SlaveBase_a73}


Return the dcop client used by this slave. 

\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 226 of file slavebase.cpp.

Referenced by cache\-Authentication(), check\-Cached\-Authentication(), and open\-Pass\-Dlg().\index{KIO::SlaveBase@{KIO::Slave\-Base}!waitForAnswer@{waitForAnswer}}
\index{waitForAnswer@{waitForAnswer}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Slave\-Base::wait\-For\-Answer (int {\em expected1}, int {\em expected2}, {\bf QByte\-Array} \& {\em data}, int $\ast$ {\em p\-Cmd} = 0)}\label{classKIO_1_1SlaveBase_a74}


Wait for an answer to our request, until we get {\tt expected1} or {\tt expected2}. 

\begin{Desc}
\item[Returns:]the result from read\-Data, as well as the cmd in $\ast$p\-Cmd if set, and the data in {\tt data} \end{Desc}


Definition at line 837 of file slavebase.cpp.

References KIO::Connection::read().

Referenced by can\-Resume(), message\-Box(), read\-Data(), and request\-Network().\index{KIO::SlaveBase@{KIO::Slave\-Base}!sendMetaData@{sendMetaData}}
\index{sendMetaData@{sendMetaData}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::send\-Meta\-Data ()}\label{classKIO_1_1SlaveBase_a75}


Internal function to transmit meta data to the application. 



Definition at line 343 of file slavebase.cpp.

References data(), and KIO::Connection::send().

Referenced by data(), and finished().\index{KIO::SlaveBase@{KIO::Slave\-Base}!wasKilled@{wasKilled}}
\index{wasKilled@{wasKilled}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Slave\-Base::was\-Killed () const}\label{classKIO_1_1SlaveBase_a76}


If your ioslave was killed by a signal, {\bf was\-Killed()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a76})} returns true. 

Check it regularly in lengthy functions (e.g. in {\bf get()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a35})};) and return as fast as possible from this function if {\bf was\-Killed()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a76})} returns true. This will ensure that your slave destructor will be called correctly. \begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 1188 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!setKillFlag@{setKillFlag}}
\index{setKillFlag@{setKillFlag}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Slave\-Base::set\-Kill\-Flag ()}\label{classKIO_1_1SlaveBase_a77}


Internally used. 



Definition at line 1193 of file slavebase.cpp.

\subsection{Member Data Documentation}
\index{KIO::SlaveBase@{KIO::Slave\-Base}!mProtocol@{mProtocol}}
\index{mProtocol@{mProtocol}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QCString} {\bf KIO::Slave\-Base::m\-Protocol}}\label{classKIO_1_1SlaveBase_o0}


Name of the protocol supported by this slave. 



Definition at line 757 of file slavebase.h.

Referenced by chmod(), copy(), del(), get(), list\-Dir(), mkdir(), multi\-Get(), open\-Connection(), put(), rename(), set\-Sub\-URL(), slave\-Status(), special(), stat(), and symlink().

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
slavebase.h\item 
slavebase.cpp\end{CompactItemize}
