\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=148pt]{classKIO_1_1SlaveBase__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KIO::Slave\-Base:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=284pt]{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)
\item 
void {\bf data\-Req} ()
\item 
void {\bf error} (int \_\-errid, const {\bf QString} \&\_\-text)
\item 
void {\bf connected} ()
\item 
void {\bf finished} ()
\item 
void {\bf need\-Sub\-URLData} ()
\item 
void {\bf slave\-Status} (const {\bf QString} \&host, bool connected)
\item 
void {\bf stat\-Entry} (const {\bf UDSEntry} \&\_\-entry)
\item 
void {\bf list\-Entries} (const {\bf UDSEntry\-List} \&\_\-entry)
\item 
bool {\bf can\-Resume} ({\bf KIO::filesize\_\-t} offset)
\item 
void {\bf can\-Resume} ()\label{classKIO_1_1SlaveBase_a16}

\item 
void {\bf total\-Size} ({\bf KIO::filesize\_\-t} \_\-bytes)
\item 
void {\bf processed\-Size} ({\bf KIO::filesize\_\-t} \_\-bytes)
\item 
void {\bf processed\-Percent} (float percent)
\item 
void {\bf speed} (unsigned long \_\-bytes\_\-per\_\-second)
\item 
void {\bf redirection} (const {\bf KURL} \&\_\-url)
\item 
void {\bf error\-Page} ()
\item 
void {\bf mime\-Type} (const {\bf QString} \&\_\-type)
\item 
void {\bf warning} (const {\bf QString} \&msg)
\item 
void {\bf info\-Message} (const {\bf QString} \&msg)
\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)
\item 
int {\bf message\-Box} (const {\bf QString} \&text, Message\-Box\-Type type, const {\bf QString} \&caption=QString::null, const {\bf QString} \&button\-Yes=QString::null, const {\bf QString} \&button\-No=QString::null, const {\bf QString} \&dont\-Ask\-Again\-Name=QString::null)
\item 
void {\bf set\-Meta\-Data} (const {\bf QString} \&key, const {\bf QString} \&value)
\item 
bool {\bf has\-Meta\-Data} (const {\bf QString} \&key) const 
\item 
{\bf QString} {\bf meta\-Data} (const {\bf QString} \&key) const 
\item 
bool {\bf has\-Meta\-Data} (const {\bf QString} \&key)
\item 
{\bf QString} {\bf meta\-Data} (const {\bf QString} \&key)
\item 
{\bf KConfig\-Base} $\ast$ {\bf config} ()
\item 
{\bf KRemote\-Encoding} $\ast$ {\bf remote\-Encoding} ()
\item 
virtual void {\bf set\-Host} (const {\bf QString} \&host, int port, const {\bf QString} \&user, const {\bf QString} \&pass)
\item 
virtual void {\bf set\-Sub\-URL} (const {\bf KURL} \&url)
\item 
virtual void {\bf open\-Connection} ()
\item 
virtual void {\bf close\-Connection} ()
\item 
virtual void {\bf get} (const {\bf KURL} \&url)
\item 
virtual void {\bf put} (const {\bf KURL} \&url, int permissions, bool overwrite, bool resume)
\item 
virtual void {\bf stat} (const {\bf KURL} \&url)
\item 
virtual void {\bf mimetype} (const {\bf KURL} \&url)
\item 
virtual void {\bf list\-Dir} (const {\bf KURL} \&url)
\item 
virtual void {\bf mkdir} (const {\bf KURL} \&url, int permissions)
\item 
virtual void {\bf rename} (const {\bf KURL} \&src, const {\bf KURL} \&dest, bool overwrite)
\item 
virtual void {\bf symlink} (const {\bf QString} \&target, const {\bf KURL} \&dest, bool overwrite)
\item 
virtual void {\bf chmod} (const {\bf KURL} \&url, int permissions)
\item 
virtual void {\bf copy} (const {\bf KURL} \&src, const {\bf KURL} \&dest, int permissions, bool overwrite)
\item 
virtual void {\bf del} (const {\bf KURL} \&url, bool isfile)
\item 
virtual void {\bf special} (const {\bf QByte\-Array} \&data)
\item 
virtual void {\bf multi\-Get} (const {\bf QByte\-Array} \&data)
\item 
virtual void {\bf slave\_\-status} ()
\item 
virtual void {\bf reparse\-Configuration} ()
\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}())
\item 
virtual bool {\bf dispatch} ()\label{classKIO_1_1SlaveBase_a59}

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

\item 
int {\bf read\-Data} ({\bf QByte\-Array} \&buffer)
\item 
void {\bf list\-Entry} (const {\bf UDSEntry} \&\_\-entry, bool ready)
\item 
void {\bf connect\-Slave} (const {\bf QString} \&path)
\item 
void {\bf disconnect\-Slave} ()\label{classKIO_1_1SlaveBase_a64}

\item 
bool {\bf open\-Pass\-Dlg} ({\bf KIO::Auth\-Info} \&info, const {\bf QString} \&error\-Msg)
\item 
bool {\bf open\-Pass\-Dlg} ({\bf KIO::Auth\-Info} \&info)
\item 
bool {\bf check\-Cached\-Authentication} ({\bf Auth\-Info} \&info)
\item 
bool {\bf cache\-Authentication} (const {\bf Auth\-Info} \&info)
\item 
bool {\bf ping\-Cache\-Daemon} () const 
\item 
{\bf QString} {\bf create\-Auth\-Cache\-Key} (const {\bf KURL} \&url)
\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)
\item 
bool {\bf multiple\-Auth\-Caching} () const 
\item 
bool {\bf request\-Network} (const {\bf QString} \&host=QString::null)
\item 
void {\bf drop\-Network} (const {\bf QString} \&host=QString::null)
\item 
{\bf DCOPClient} $\ast$ {\bf dcop\-Client} ()
\item 
int {\bf wait\-For\-Answer} (int expected1, int expected2, {\bf QByte\-Array} \&data, int $\ast$p\-Cmd=0)
\item 
void {\bf send\-Meta\-Data} ()
\item 
bool {\bf was\-Killed} () const 
\item 
void {\bf set\-Kill\-Flag} ()
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static void {\bf sigsegv\_\-handler} (int)\label{classKIO_1_1SlaveBase_e0}

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

\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
{\bf QCString} {\bf m\-Protocol}
\item 
{\bf Connection} $\ast$ {\bf m\_\-p\-Connection}\label{classKIO_1_1SlaveBase_o1}

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

\item 
{\bf 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*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf UDSEntry\-List} {\bf pending\-List\-Entries}\label{classKIO_1_1SlaveBase_p0}

\item 
uint {\bf list\-Entry\-Current\-Size}\label{classKIO_1_1SlaveBase_p1}

\item 
long {\bf list\-Entry\_\-sec}\label{classKIO_1_1SlaveBase_p2}

\item 
long {\bf list\-Entry\_\-usec}\label{classKIO_1_1SlaveBase_p3}

\item 
{\bf Connection} $\ast$ {\bf appconn}\label{classKIO_1_1SlaveBase_p4}

\item 
{\bf QString} {\bf m\-Pool\-Socket}\label{classKIO_1_1SlaveBase_p5}

\item 
{\bf QString} {\bf m\-App\-Socket}\label{classKIO_1_1SlaveBase_p6}

\item 
bool {\bf m\-Connected\-To\-App}\label{classKIO_1_1SlaveBase_p7}

\end{CompactItemize}
\subsection*{Static Protected Attributes}
\begin{CompactItemize}
\item 
static long {\bf s\_\-seq\-Nr}\label{classKIO_1_1SlaveBase_t0}

\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 45 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 398 of file slavebase.cpp.

References data(), QMap::is\-Empty(), and send\-Meta\-Data().

Referenced by can\-Resume(), data(), 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(), set\-Timeout\-Special\-Command(), slave\-Status(), speed(), stat\-Entry(), total\-Size(), wait\-For\-Answer(), 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_a61})} \end{Desc}


Definition at line 407 of file slavebase.cpp.

References can\-Resume().\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_a259})} 

{\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_a259})} \item[{\em \_\-text}]the rich text error message \end{description}
\end{Desc}


Definition at line 418 of file slavebase.cpp.

References QMap::clear(), and data().

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 431 of file slavebase.cpp.\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 438 of file slavebase.cpp.

References QMap::clear(), QMap::is\-Empty(), 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 451 of file slavebase.cpp.\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 456 of file slavebase.cpp.

References data(), and m\-Protocol.

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_a41})} 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 636 of file slavebase.cpp.

References data().\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 686 of file slavebase.cpp.

References QValue\-List::begin(), QValue\-List::count(), and data().

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 ({\bf KIO::filesize\_\-t} {\em offset})}\label{classKIO_1_1SlaveBase_a15}


Call this at the beginning of {\bf put()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a40})}, 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_a39})} doesn't support setting an offset) 

Definition at line 888 of file slavebase.cpp.

References data(), endl(), kd\-Debug(), KIO::number(), 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 ({\bf KIO::filesize\_\-t} {\em \_\-bytes})}\label{classKIO_1_1SlaveBase_a17}


Call this in get and copy, to give the total size of the file Call in list\-Dir too, when you know the total number of items. 



Definition at line 471 of file slavebase.cpp.

References data().\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 ({\bf KIO::filesize\_\-t} {\em \_\-bytes})}\label{classKIO_1_1SlaveBase_a18}


Call this during get and copy, once in a while, to give some info about the current state. 

Don't emit it in list\-Dir, list\-Entries speaks for itself. 

Definition at line 487 of file slavebase.cpp.

References data().\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 get and copy, once in a while, to give some info about the current state. Don't emit it in list\-Dir, list\-Entries speaks for itself. 

Definition at line 523 of file slavebase.cpp.

References endl(), and kd\-Debug().\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 get and copy, 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 529 of file slavebase.cpp.

References data().\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 537 of file slavebase.cpp.

References data().\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 543 of file slavebase.cpp.\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_a42})} and in {\bf get()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a39})}, when you know the mimetype. 

See mimetype about other ways to implement it. 

Definition at line 560 of file slavebase.cpp.

References QMap::clear(), data(), endl(), QMap::is\-Empty(), and kd\-Debug().\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 603 of file slavebase.cpp.

References data().\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 609 of file slavebase.cpp.

References data().\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} = {\tt QString::null}, const {\bf QString} \& {\em button\-Yes} = {\tt QString::null}, const {\bf QString} \& {\em button\-No} = {\tt QString::null})}\label{classKIO_1_1SlaveBase_a26}


Call this to show a message box from the slave. 

\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 865 of file slavebase.cpp.\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 (const {\bf QString} \& {\em text}, Message\-Box\-Type {\em type}, const {\bf QString} \& {\em caption} = {\tt QString::null}, const {\bf QString} \& {\em button\-Yes} = {\tt QString::null}, const {\bf QString} \& {\em button\-No} = {\tt QString::null}, const {\bf QString} \& {\em dont\-Ask\-Again\-Name} = {\tt QString::null})}\label{classKIO_1_1SlaveBase_a27}


Call this to show a message box from the slave. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]Message string. May contain newlines. \item[{\em type}]type of message box: Question\-Yes\-No, Warning\-Yes\-No, Warning\-Continue\-Cancel... \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. \item[{\em dont\-Ask\-Again\-Name}]A checkbox is added with which further confirmation can be turned off. The string is used to lookup and store the setting in kioslaverc. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]a button code, as defined in {\bf KMessage\-Box}, or 0 on communication error. \end{Desc}
\begin{Desc}
\item[Since:]3.3 \end{Desc}


Definition at line 871 of file slavebase.cpp.

References data(), endl(), kd\-Debug(), 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_a28}


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 344 of file slavebase.cpp.

References QMap::replace().\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}) const}\label{classKIO_1_1SlaveBase_a29}


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

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


Definition at line 358 of file slavebase.cpp.

References QMap::contains().\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}) const}\label{classKIO_1_1SlaveBase_a30}


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

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


Definition at line 349 of file slavebase.cpp.

References QMap::contains().

Referenced by cache\-Authentication(), check\-Cached\-Authentication(), connect\-Timeout(), open\-Pass\-Dlg(), proxy\-Connect\-Timeout(), read\-Timeout(), remote\-Encoding(), and response\-Timeout().\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_a31}


\begin{Desc}
\item[{\bf Deprecated}]kept for binary compatibility Queries for the existence of a certain config/meta-data entry send by the application to the slave. \end{Desc}


Definition at line 371 of file slavebase.cpp.\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_a32}


\begin{Desc}
\item[{\bf Deprecated}]kept for binary compatibility Queries for config/meta-data send by the application to the slave. \end{Desc}


Definition at line 368 of file slavebase.cpp.\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_a33}


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 375 of file slavebase.cpp.\index{KIO::SlaveBase@{KIO::Slave\-Base}!remoteEncoding@{remoteEncoding}}
\index{remoteEncoding@{remoteEncoding}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KRemote\-Encoding} $\ast$ Slave\-Base::remote\-Encoding ()}\label{classKIO_1_1SlaveBase_a34}


Returns an object that can translate remote filenames into proper Unicode forms. 

This encoding can be set by the user.

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


Definition at line 390 of file slavebase.cpp.

References meta\-Data().\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_a35}


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 750 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_a36}


Prepare slave for streaming operation. 



Definition at line 782 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a37}


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. The user is expected to disconnect the slave in the error handler. 

Definition at line 754 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a38}


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 756 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_a39}


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_a35})} call. The slave emits the data through data \end{description}
\end{Desc}


Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a2})}.

Definition at line 766 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().

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_a40}


put, aka write. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em url}]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}


Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a3})}.

Definition at line 760 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a41}


Finds all details for one file or directory. 

The information returned is the same as what list\-Dir returns, but only for one file or directory. 

Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a4})}.

Definition at line 758 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a42}


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 get 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. 

Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a5})}.

Definition at line 768 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_a43}


Lists the contents of {\tt url}. 

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. 

Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a6})}.

Definition at line 764 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a44}


Create a directory. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em url}]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}


Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a7})}.

Definition at line 778 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a45}


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}


Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a8})}.

Definition at line 770 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a46}


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}


Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a9})}.

Definition at line 772 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a47}


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



Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a10})}.

Definition at line 780 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a48}


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}


Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a11})}.

Definition at line 774 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a49}


Delete a file or directory. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em url}]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}


Reimplemented in {\bf KIO::Forwarding\-Slave\-Base} {\rm (p.\,\pageref{classKIO_1_1ForwardingSlaveBase_a12})}.

Definition at line 776 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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} \& {\em data})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a50}


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 762 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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} \& {\em data})\hspace{0.3cm}{\tt  [virtual]}}\label{classKIO_1_1SlaveBase_a51}


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 {\bf Meta\-Data}{\rm (p.\,\pageref{classKIO_1_1MetaData})}. \end{description}
\end{Desc}


Definition at line 784 of file slavebase.cpp.

References error(), m\-Protocol, and KIO::unsupported\-Action\-Error\-String().\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_a52}


Called to get the status of the slave. 

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

Definition at line 788 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_a53}


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

proxy settings) . 

Definition at line 791 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_a54}


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


Definition at line 1210 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_a55}


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


Definition at line 1220 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_a56}


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


Definition at line 1231 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_a57}


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


Definition at line 1242 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} = {\tt {\bf QByte\-Array}()})}\label{classKIO_1_1SlaveBase_a58}


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 945 of file slavebase.cpp.

References data().\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_a61}


Read data send by the job, after a data\-Req. 

\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 938 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_a62}


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 644 of file slavebase.cpp.

References QValue\-List::append(), QValue\-List::clear(), QValue\-List::count(), and list\-Entries().\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_a63}


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



Definition at line 325 of file slavebase.cpp.

References endl(), KIO::Connection::init(), KIO::Connection::inited(), and kd\-Debug().\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_a65}


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

Use this function to request authorization information from the end user. You can also pass an error message which explains why a previous authorization attempt failed. Here is a very simple example:



\footnotesize\begin{verbatim} KIO::AuthInfo authInfo;
 if ( openPassDlg( authInfo ) )
 {
    kdDebug() << QString::fromLatin1("User: ")
              << authInfo.username << endl;
    kdDebug() << QString::fromLatin1("Password: ")
              << QString::fromLatin1("Not displayed here!") << endl;
 }
\end{verbatim}
\normalsize


You can also preset some values like the username, caption or comment as follows:



\footnotesize\begin{verbatim} KIO::AuthInfo authInfo;
 authInfo.caption= "Acme Password Dialog";
 authInfo.username= "Wile E. Coyote";
 QString errorMsg = "You entered an incorrect password.";
 if ( openPassDlg( authInfo, errorMsg ) )
 {
    kdDebug() << QString::fromLatin1("User: ")
              << authInfo.username << endl;
    kdDebug() << QString::fromLatin1("Password: ")
              << QString::fromLatin1("Not displayed here!") << endl;
 }
\end{verbatim}
\normalsize


\begin{Desc}
\item[Note:]You should consider using {\bf check\-Cached\-Authentication()}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a67})} to see if the password is available in kpasswdserver before calling this function.

A call to this function can fail and return {\tt false}, if the {\bf UIServer}{\rm (p.\,\pageref{classUIServer})} could not be started for whatever reason.\end{Desc}
\begin{Desc}
\item[See also:]{\bf check\-Cached\-Authentication}{\rm (p.\,\pageref{classKIO_1_1SlaveBase_a67})} \end{Desc}
\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 816 of file slavebase.cpp.

References dcop\-Client(), endl(), KIO::Auth\-Info::is\-Modified(), kd\-Debug(), kd\-Error(), kd\-Warning(), meta\-Data(), and QString::to\-Long().

Referenced by open\-Pass\-Dlg().\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})}\label{classKIO_1_1SlaveBase_a66}


Same as above function except it does not need error message. 

BIC: Combine this function with the above for KDE4. 

Definition at line 811 of file slavebase.cpp.

References open\-Pass\-Dlg().\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_a67}


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})}} and/or {\tt {\bf Auth\-Info::verify\-Path}{\rm (p.\,\pageref{classKIO_1_1AuthInfo_o9})}} flag is specified, 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:



\footnotesize\begin{verbatim} AuthInfo info;
 info.url = KURL("http://www.foobar.org/foo/bar");
 info.username = "somename";
 info.verifyPath = true;
 if ( !checkCachedAuthentication( info ) )
 {
    if ( !openPassDlg(info) )
     ....
 }
\end{verbatim}
\normalsize


\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em info}]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 1153 of file slavebase.cpp.

References dcop\-Client(), endl(), KIO::Auth\-Info::is\-Modified(), kd\-Debug(), kd\-Error(), kd\-Warning(), meta\-Data(), and QString::to\-Long().\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_a68}


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 1195 of file slavebase.cpp.

References dcop\-Client(), meta\-Data(), and QString::to\-Long().\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_a69}


\begin{Desc}
\item[{\bf Deprecated}]as of 3.1. TODO: Remove before {\bf KDE} 4.0 \end{Desc}


Definition at line 1131 of file slavebase.cpp.

References endl(), and kd\-Debug().\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_a70}


\begin{Desc}
\item[{\bf Deprecated}]as of 3.1. Use open\-Pass\-Dlg instead. TODO: Remove before {\bf KDE} 4.0 Creates a basic key to be used to cache the password.\end{Desc}
\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 1112 of file slavebase.cpp.

References QString::number().\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_a71}


\begin{Desc}
\item[{\bf Deprecated}]as of 3.1. Use open\-Pass\-Dlg instead. TODO: Remove before {\bf KDE} 4.0 \end{Desc}
Cache authentication information is now stored automatically by open\-Pass\-Dlg. 

Definition at line 699 of file slavebase.cpp.

References data().\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_a72}


\begin{Desc}
\item[{\bf Deprecated}]as of 3.1. Use open\-Pass\-Dlg instead. TODO: Remove before {\bf KDE} 4.0 \end{Desc}
Cached authentication information is now session based and removed automatically when a given session ends, i.e. the application is closed. 

Definition at line 707 of file slavebase.cpp.

References data().\index{KIO::SlaveBase@{KIO::Slave\-Base}!setMultipleAuthCaching@{setMultipleAuthCaching}}
\index{setMultipleAuthCaching@{setMultipleAuthCaching}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIO::Slave\-Base::set\-Multiple\-Auth\-Caching (bool)\hspace{0.3cm}{\tt  [inline]}}\label{classKIO_1_1SlaveBase_a73}


\begin{Desc}
\item[{\bf Deprecated}]as of 3.1. Use open\-Pass\-Dlg instead. TODO: Remove before {\bf KDE} 4.0 \end{Desc}


Definition at line 725 of file slavebase.h.\index{KIO::SlaveBase@{KIO::Slave\-Base}!multipleAuthCaching@{multipleAuthCaching}}
\index{multipleAuthCaching@{multipleAuthCaching}!KIO::SlaveBase@{KIO::Slave\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KIO::Slave\-Base::multiple\-Auth\-Caching () const\hspace{0.3cm}{\tt  [inline]}}\label{classKIO_1_1SlaveBase_a74}


\begin{Desc}
\item[{\bf Deprecated}]as of 3.1. Use open\-Pass\-Dlg instead. TODO: Remove before {\bf KDE} 4.0 \end{Desc}


Definition at line 731 of file slavebase.h.\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} = {\tt QString::null})}\label{classKIO_1_1SlaveBase_a75}


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 request\-Network must exist a matching call to drop\-Network, 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 615 of file slavebase.cpp.

References data(), 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} = {\tt QString::null})}\label{classKIO_1_1SlaveBase_a76}


Used by the slave to withdraw a connection requested by request\-Network. 

This function cancels the last call to request\-Network. 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 630 of file slavebase.cpp.

References data().\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_a77}


Return the dcop client used by this slave. 

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


Definition at line 242 of file slavebase.cpp.

References DCOPClient::attach(), and KApplication::dcop\-Client().

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} = {\tt 0})}\label{classKIO_1_1SlaveBase_a78}


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 910 of file slavebase.cpp.

References data(), endl(), kd\-Debug(), and kd\-Warning().

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_a79}


Internal function to transmit meta data to the application. 



Definition at line 380 of file slavebase.cpp.

References QMap::clear(), and data().

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_a80}


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

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


Definition at line 1252 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_a81}


Internally used. 



Definition at line 1257 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 788 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}
